_Auth---OpenID---AX.php.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313
  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 AX.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/AX.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-includes">Includes</a>
  20. | <a href="#sec-constants">Constants</a>
  21. | <a href="#sec-functions">Functions</a>
  22. </div>
  23. <div class="info-box-body">
  24. <!-- ========== Info from phpDoc block ========= -->
  25. <p class="short-description">Implements the OpenID attribute exchange specification, version 1.0 as of svn revision 370 from openid.net svn.</p>
  26. </div>
  27. </div>
  28. <a name="sec-classes"></a>
  29. <div class="info-box">
  30. <div class="info-box-title">Classes</div>
  31. <div class="nav-bar">
  32. <a href="#sec-description">Description</a> |
  33. <span class="disabled">Classes</span>
  34. | <a href="#sec-includes">Includes</a>
  35. | <a href="#sec-constants">Constants</a>
  36. | <a href="#sec-functions">Functions</a>
  37. </div>
  38. <div class="info-box-body">
  39. <table cellpadding="2" cellspacing="0" class="class-table">
  40. <tr>
  41. <th class="class-table-header">Class</th>
  42. <th class="class-table-header">Description</th>
  43. </tr>
  44. <tr>
  45. <td style="padding-right: 2em; vertical-align: top">
  46. <a href="../OpenID/Auth_OpenID_AX.html">Auth_OpenID_AX</a>
  47. </td>
  48. <td>
  49. AX utility class.
  50. </td>
  51. </tr>
  52. <tr>
  53. <td style="padding-right: 2em; vertical-align: top">
  54. <a href="../OpenID/Auth_OpenID_AX_Error.html">Auth_OpenID_AX_Error</a>
  55. </td>
  56. <td>
  57. Results from data that does not meet the attribute exchange 1.0 specification
  58. </td>
  59. </tr>
  60. <tr>
  61. <td style="padding-right: 2em; vertical-align: top">
  62. <a href="../OpenID/Auth_OpenID_AX_Message.html">Auth_OpenID_AX_Message</a>
  63. </td>
  64. <td>
  65. Abstract class containing common code for attribute exchange messages.
  66. </td>
  67. </tr>
  68. <tr>
  69. <td style="padding-right: 2em; vertical-align: top">
  70. <a href="../OpenID/Auth_OpenID_AX_AttrInfo.html">Auth_OpenID_AX_AttrInfo</a>
  71. </td>
  72. <td>
  73. Represents a single attribute in an attribute exchange request. This should be added to an AXRequest object in order to request the attribute.
  74. </td>
  75. </tr>
  76. <tr>
  77. <td style="padding-right: 2em; vertical-align: top">
  78. <a href="../OpenID/Auth_OpenID_AX_FetchRequest.html">Auth_OpenID_AX_FetchRequest</a>
  79. </td>
  80. <td>
  81. An attribute exchange 'fetch_request' message. This message is sent by a relying party when it wishes to obtain attributes about the subject of an OpenID authentication request.
  82. </td>
  83. </tr>
  84. <tr>
  85. <td style="padding-right: 2em; vertical-align: top">
  86. <a href="../OpenID/Auth_OpenID_AX_KeyValueMessage.html">Auth_OpenID_AX_KeyValueMessage</a>
  87. </td>
  88. <td>
  89. An abstract class that implements a message that has attribute keys and values. It contains the common code between fetch_response and store_request.
  90. </td>
  91. </tr>
  92. <tr>
  93. <td style="padding-right: 2em; vertical-align: top">
  94. <a href="../OpenID/Auth_OpenID_AX_FetchResponse.html">Auth_OpenID_AX_FetchResponse</a>
  95. </td>
  96. <td>
  97. A fetch_response attribute exchange message.
  98. </td>
  99. </tr>
  100. <tr>
  101. <td style="padding-right: 2em; vertical-align: top">
  102. <a href="../OpenID/Auth_OpenID_AX_StoreRequest.html">Auth_OpenID_AX_StoreRequest</a>
  103. </td>
  104. <td>
  105. A store request attribute exchange message representation.
  106. </td>
  107. </tr>
  108. <tr>
  109. <td style="padding-right: 2em; vertical-align: top">
  110. <a href="../OpenID/Auth_OpenID_AX_StoreResponse.html">Auth_OpenID_AX_StoreResponse</a>
  111. </td>
  112. <td>
  113. An indication that the store request was processed along with this OpenID transaction. Use make(), NOT the constructor, to create response objects.
  114. </td>
  115. </tr>
  116. </table>
  117. </div>
  118. </div>
  119. <a name="sec-includes"></a>
  120. <div class="info-box">
  121. <div class="info-box-title">Includes</div>
  122. <div class="nav-bar">
  123. <a href="#sec-description">Description</a> |
  124. <a href="#sec-classes">Classes</a>
  125. | <span class="disabled">Includes</span>
  126. | <a href="#sec-constants">Constants</a>
  127. | <a href="#sec-functions">Functions</a>
  128. </div>
  129. <div class="info-box-body">
  130. <a name="_Auth/OpenID/Message_php"><!-- --></a>
  131. <div class="evenrow">
  132. <div>
  133. <span class="include-title">
  134. <span class="include-type">require_once</span>
  135. (<span class="include-name"><a href="../OpenID/_Auth---OpenID---Message.php.html">"Auth/OpenID/Message.php"</a></span>)
  136. (line <span class="line-number">14</span>)
  137. </span>
  138. </div>
  139. <!-- ========== Info from phpDoc block ========= -->
  140. </div>
  141. <a name="_Auth/OpenID/Extension_php"><!-- --></a>
  142. <div class="oddrow">
  143. <div>
  144. <span class="include-title">
  145. <span class="include-type">require_once</span>
  146. (<span class="include-name"><a href="../OpenID/_Auth---OpenID---Extension.php.html">"Auth/OpenID/Extension.php"</a></span>)
  147. (line <span class="line-number">13</span>)
  148. </span>
  149. </div>
  150. <!-- ========== Info from phpDoc block ========= -->
  151. <p class="short-description">Require utility classes and functions for the consumer.</p>
  152. </div>
  153. <a name="_Auth/OpenID/TrustRoot_php"><!-- --></a>
  154. <div class="evenrow">
  155. <div>
  156. <span class="include-title">
  157. <span class="include-type">require_once</span>
  158. (<span class="include-name">"Auth/OpenID/TrustRoot.php"</span>)
  159. (line <span class="line-number">15</span>)
  160. </span>
  161. </div>
  162. <!-- ========== Info from phpDoc block ========= -->
  163. </div>
  164. </div>
  165. </div>
  166. <a name="sec-constants"></a>
  167. <div class="info-box">
  168. <div class="info-box-title">Constants</div>
  169. <div class="nav-bar">
  170. <a href="#sec-description">Description</a> |
  171. <a href="#sec-classes">Classes</a>
  172. | <a href="#sec-includes">Includes</a>
  173. | <span class="disabled">Constants</span>
  174. | <a href="#sec-functions">Functions</a>
  175. </div>
  176. <div class="info-box-body">
  177. <a name="defineAuth_OpenID_AX_MINIMUM_SUPPORTED_ALIAS_LENGTH"><!-- --></a>
  178. <div class="oddrow">
  179. <div>
  180. <span class="const-title">
  181. <span class="const-name">Auth_OpenID_AX_MINIMUM_SUPPORTED_ALIAS_LENGTH</span> = 32
  182. (line <span class="line-number">26</span>)
  183. </span>
  184. </div>
  185. <!-- ========== Info from phpDoc block ========= -->
  186. </div>
  187. <a name="defineAuth_OpenID_AX_NS_URI"><!-- --></a>
  188. <div class="evenrow">
  189. <div>
  190. <span class="const-title">
  191. <span class="const-name">Auth_OpenID_AX_NS_URI</span> = 'http://openid.net/srv/ax/1.0'
  192. (line <span class="line-number">17</span>)
  193. </span>
  194. </div>
  195. <!-- ========== Info from phpDoc block ========= -->
  196. </div>
  197. <a name="defineAuth_OpenID_AX_UNLIMITED_VALUES"><!-- --></a>
  198. <div class="oddrow">
  199. <div>
  200. <span class="const-title">
  201. <span class="const-name">Auth_OpenID_AX_UNLIMITED_VALUES</span> = 'unlimited'
  202. (line <span class="line-number">22</span>)
  203. </span>
  204. </div>
  205. <!-- ========== Info from phpDoc block ========= -->
  206. </div>
  207. </div>
  208. </div>
  209. <a name="sec-functions"></a>
  210. <div class="info-box">
  211. <div class="info-box-title">Functions</div>
  212. <div class="nav-bar">
  213. <a href="#sec-description">Description</a> |
  214. <a href="#sec-classes">Classes</a>
  215. | <a href="#sec-includes">Includes</a>
  216. | <a href="#sec-constants">Constants</a>
  217. | <span class="disabled">Functions</span>
  218. </div>
  219. <div class="info-box-body">
  220. <a name="functionAuth_OpenID_AX_checkAlias" id="functionAuth_OpenID_AX_checkAlias"><!-- --></a>
  221. <div class="evenrow">
  222. <div>
  223. <span class="method-title">Auth_OpenID_AX_checkAlias</span> (line <span class="line-number">51</span>)
  224. </div>
  225. <!-- ========== Info from phpDoc block ========= -->
  226. <p class="short-description">Check an alias for invalid characters; raise AXError if any are found. Return None if the alias is valid.</p>
  227. <div class="method-signature">
  228. <span class="method-result">void</span>
  229. <span class="method-name">
  230. Auth_OpenID_AX_checkAlias
  231. </span>
  232. (<span class="var-type"></span>&nbsp;<span class="var-name">$alias</span>)
  233. </div>
  234. <ul class="parameters">
  235. <li>
  236. <span class="var-type"></span>
  237. <span class="var-name">$alias</span> </li>
  238. </ul>
  239. </div>
  240. <a name="functionAuth_OpenID_AX_toTypeURIs" id="functionAuth_OpenID_AX_toTypeURIs"><!-- --></a>
  241. <div class="oddrow">
  242. <div>
  243. <span class="method-title">Auth_OpenID_AX_toTypeURIs</span> (line <span class="line-number">238</span>)
  244. </div>
  245. <!-- ========== Info from phpDoc block ========= -->
  246. <p class="short-description">Given a namespace mapping and a string containing a comma-separated list of namespace aliases, return a list of type URIs that correspond to those aliases.</p>
  247. <ul class="tags">
  248. <li><span class="field">return:</span> <p>The list of namespace URIs that corresponds to the supplied list of aliases. If the string was zero-length or None, an empty list will be returned.</p><p>return null If an alias is present in the list of aliases but is not present in the namespace map.</p></li>
  249. </ul>
  250. <div class="method-signature">
  251. <span class="method-result">$seq</span>
  252. <span class="method-name">
  253. Auth_OpenID_AX_toTypeURIs
  254. </span>
  255. (<span class="var-type">$namespace_map</span>&nbsp;<span class="var-name">&$namespace_map</span>, <span class="var-type">$alias_list_s</span>&nbsp;<span class="var-name">$alias_list_s</span>)
  256. </div>
  257. <ul class="parameters">
  258. <li>
  259. <span class="var-type">$namespace_map</span>
  260. <span class="var-name">&$namespace_map</span><span class="var-description">: The mapping from namespace URI to alias</span> </li>
  261. <li>
  262. <span class="var-type">$alias_list_s</span>
  263. <span class="var-name">$alias_list_s</span><span class="var-description">: The string containing the comma-separated list of aliases. May also be None for convenience.</span> </li>
  264. </ul>
  265. </div>
  266. </div>
  267. </div>
  268. <p class="notes" id="credit">
  269. Documentation generated on Tue, 21 Apr 2009 11:31:29 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
  270. </p>
  271. </div></body>
  272. </html>