_Auth---OpenID---Association.php.html 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286
  1. <?xml version="1.0" encoding="iso-8859-1"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <!-- template designed by Marco Von Ballmoos -->
  6. <title>Docs for page Association.php</title>
  7. <link rel="stylesheet" href="../media/stylesheet.css" />
  8. <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
  9. </head>
  10. <body>
  11. <div class="page-body">
  12. <h2 class="file-name">/Auth/OpenID/Association.php</h2>
  13. <a name="sec-description"></a>
  14. <div class="info-box">
  15. <div class="info-box-title">Description</div>
  16. <div class="nav-bar">
  17. <span class="disabled">Description</span> |
  18. <a href="#sec-classes">Classes</a>
  19. | <a href="#sec-functions">Functions</a>
  20. </div>
  21. <div class="info-box-body">
  22. <!-- ========== Info from phpDoc block ========= -->
  23. <p class="short-description">This module contains code for dealing with associations between consumers and servers.</p>
  24. <p class="description"><p>PHP versions 4 and 5</p><p>LICENSE: See the COPYING file included in this distribution.</p></p>
  25. <ul class="tags">
  26. <li><span class="field">author:</span> JanRain, Inc. &lt;<a href="mailto:openid@janrain.com">openid@janrain.com</a>&gt;</li>
  27. <li><span class="field">copyright:</span> 2005-2008 Janrain, Inc.</li>
  28. <li><span class="field">license:</span> <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache</a></li>
  29. </ul>
  30. </div>
  31. </div>
  32. <a name="sec-classes"></a>
  33. <div class="info-box">
  34. <div class="info-box-title">Classes</div>
  35. <div class="nav-bar">
  36. <a href="#sec-description">Description</a> |
  37. <span class="disabled">Classes</span>
  38. | <a href="#sec-functions">Functions</a>
  39. </div>
  40. <div class="info-box-body">
  41. <table cellpadding="2" cellspacing="0" class="class-table">
  42. <tr>
  43. <th class="class-table-header">Class</th>
  44. <th class="class-table-header">Description</th>
  45. </tr>
  46. <tr>
  47. <td style="padding-right: 2em; vertical-align: top">
  48. <a href="../OpenID/Auth_OpenID_Association.html">Auth_OpenID_Association</a>
  49. </td>
  50. <td>
  51. This class represents an association between a server and a consumer. In general, users of this library will never see instances of this object. The only exception is if you implement a custom <a href="../OpenID/Auth_OpenID_OpenIDStore.html">Auth_OpenID_OpenIDStore</a>.
  52. </td>
  53. </tr>
  54. <tr>
  55. <td style="padding-right: 2em; vertical-align: top">
  56. <a href="../OpenID/Auth_OpenID_SessionNegotiator.html">Auth_OpenID_SessionNegotiator</a>
  57. </td>
  58. <td>
  59. A session negotiator controls the allowed and preferred association types and association session types. Both the <a href="../OpenID/Auth_OpenID_Consumer.html">Auth_OpenID_Consumer</a> and <a href="../OpenID/Auth_OpenID_Server.html">Auth_OpenID_Server</a> use negotiators when creating associations.
  60. </td>
  61. </tr>
  62. </table>
  63. </div>
  64. </div>
  65. <a name="sec-functions"></a>
  66. <div class="info-box">
  67. <div class="info-box-title">Functions</div>
  68. <div class="nav-bar">
  69. <a href="#sec-description">Description</a> |
  70. <a href="#sec-classes">Classes</a>
  71. | <span class="disabled">Functions</span>
  72. </div>
  73. <div class="info-box-body">
  74. <a name="functionAuth_OpenID_checkSessionType" id="functionAuth_OpenID_checkSessionType"><!-- --></a>
  75. <div class="oddrow">
  76. <div>
  77. <span class="method-title">Auth_OpenID_checkSessionType</span> (line <span class="line-number">421</span>)
  78. </div>
  79. <!-- ========== Info from phpDoc block ========= -->
  80. <div class="method-signature">
  81. <span class="method-result">void</span>
  82. <span class="method-name">
  83. Auth_OpenID_checkSessionType
  84. </span>
  85. (<span class="var-type"></span>&nbsp;<span class="var-name">$assoc_type</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$session_type</span>)
  86. </div>
  87. <ul class="parameters">
  88. <li>
  89. <span class="var-type"></span>
  90. <span class="var-name">$assoc_type</span> </li>
  91. <li>
  92. <span class="var-type"></span>
  93. <span class="var-name">$session_type</span> </li>
  94. </ul>
  95. </div>
  96. <a name="functionAuth_OpenID_getAllAssociationTypes" id="functionAuth_OpenID_getAllAssociationTypes"><!-- --></a>
  97. <div class="evenrow">
  98. <div>
  99. <span class="method-title">Auth_OpenID_getAllAssociationTypes</span> (line <span class="line-number">392</span>)
  100. </div>
  101. <!-- ========== Info from phpDoc block ========= -->
  102. <div class="method-signature">
  103. <span class="method-result">void</span>
  104. <span class="method-name">
  105. Auth_OpenID_getAllAssociationTypes
  106. </span>
  107. ()
  108. </div>
  109. </div>
  110. <a name="functionAuth_OpenID_getDefaultAssociationOrder" id="functionAuth_OpenID_getDefaultAssociationOrder"><!-- --></a>
  111. <div class="oddrow">
  112. <div>
  113. <span class="method-title">Auth_OpenID_getDefaultAssociationOrder</span> (line <span class="line-number">431</span>)
  114. </div>
  115. <!-- ========== Info from phpDoc block ========= -->
  116. <div class="method-signature">
  117. <span class="method-result">void</span>
  118. <span class="method-name">
  119. Auth_OpenID_getDefaultAssociationOrder
  120. </span>
  121. ()
  122. </div>
  123. </div>
  124. <a name="functionAuth_OpenID_getDefaultNegotiator" id="functionAuth_OpenID_getDefaultNegotiator"><!-- --></a>
  125. <div class="evenrow">
  126. <div>
  127. <span class="method-title">Auth_OpenID_getDefaultNegotiator</span> (line <span class="line-number">472</span>)
  128. </div>
  129. <!-- ========== Info from phpDoc block ========= -->
  130. <div class="method-signature">
  131. <span class="method-result">void</span>
  132. <span class="method-name">
  133. &amp;Auth_OpenID_getDefaultNegotiator
  134. </span>
  135. ()
  136. </div>
  137. </div>
  138. <a name="functionAuth_OpenID_getEncryptedNegotiator" id="functionAuth_OpenID_getEncryptedNegotiator"><!-- --></a>
  139. <div class="oddrow">
  140. <div>
  141. <span class="method-title">Auth_OpenID_getEncryptedNegotiator</span> (line <span class="line-number">479</span>)
  142. </div>
  143. <!-- ========== Info from phpDoc block ========= -->
  144. <div class="method-signature">
  145. <span class="method-result">void</span>
  146. <span class="method-name">
  147. &amp;Auth_OpenID_getEncryptedNegotiator
  148. </span>
  149. ()
  150. </div>
  151. </div>
  152. <a name="functionAuth_OpenID_getOnlyEncryptedOrder" id="functionAuth_OpenID_getOnlyEncryptedOrder"><!-- --></a>
  153. <div class="evenrow">
  154. <div>
  155. <span class="method-title">Auth_OpenID_getOnlyEncryptedOrder</span> (line <span class="line-number">452</span>)
  156. </div>
  157. <!-- ========== Info from phpDoc block ========= -->
  158. <div class="method-signature">
  159. <span class="method-result">void</span>
  160. <span class="method-name">
  161. Auth_OpenID_getOnlyEncryptedOrder
  162. </span>
  163. ()
  164. </div>
  165. </div>
  166. <a name="functionAuth_OpenID_getSecretSize" id="functionAuth_OpenID_getSecretSize"><!-- --></a>
  167. <div class="oddrow">
  168. <div>
  169. <span class="method-title">Auth_OpenID_getSecretSize</span> (line <span class="line-number">381</span>)
  170. </div>
  171. <!-- ========== Info from phpDoc block ========= -->
  172. <div class="method-signature">
  173. <span class="method-result">void</span>
  174. <span class="method-name">
  175. Auth_OpenID_getSecretSize
  176. </span>
  177. (<span class="var-type"></span>&nbsp;<span class="var-name">$assoc_type</span>)
  178. </div>
  179. <ul class="parameters">
  180. <li>
  181. <span class="var-type"></span>
  182. <span class="var-name">$assoc_type</span> </li>
  183. </ul>
  184. </div>
  185. <a name="functionAuth_OpenID_getSessionTypes" id="functionAuth_OpenID_getSessionTypes"><!-- --></a>
  186. <div class="evenrow">
  187. <div>
  188. <span class="method-title">Auth_OpenID_getSessionTypes</span> (line <span class="line-number">408</span>)
  189. </div>
  190. <!-- ========== Info from phpDoc block ========= -->
  191. <div class="method-signature">
  192. <span class="method-result">void</span>
  193. <span class="method-name">
  194. Auth_OpenID_getSessionTypes
  195. </span>
  196. (<span class="var-type"></span>&nbsp;<span class="var-name">$assoc_type</span>)
  197. </div>
  198. <ul class="parameters">
  199. <li>
  200. <span class="var-type"></span>
  201. <span class="var-name">$assoc_type</span> </li>
  202. </ul>
  203. </div>
  204. <a name="functionAuth_OpenID_getSupportedAssociationTypes" id="functionAuth_OpenID_getSupportedAssociationTypes"><!-- --></a>
  205. <div class="oddrow">
  206. <div>
  207. <span class="method-title">Auth_OpenID_getSupportedAssociationTypes</span> (line <span class="line-number">397</span>)
  208. </div>
  209. <!-- ========== Info from phpDoc block ========= -->
  210. <div class="method-signature">
  211. <span class="method-result">void</span>
  212. <span class="method-name">
  213. Auth_OpenID_getSupportedAssociationTypes
  214. </span>
  215. ()
  216. </div>
  217. </div>
  218. </div>
  219. </div>
  220. <p class="notes" id="credit">
  221. Documentation generated on Tue, 21 Apr 2009 11:31:28 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
  222. </p>
  223. </div></body>
  224. </html>