Auth_OpenID_AX_Message.html 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237
  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 Class Auth_OpenID_AX_Message</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="class-name">Class Auth_OpenID_AX_Message</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-descendents">Descendents</a>
  19. | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  20. | <a href="#sec-methods">Methods</a>
  21. </div>
  22. <div class="info-box-body">
  23. <!-- ========== Info from phpDoc block ========= -->
  24. <p class="short-description">Abstract class containing common code for attribute exchange messages.</p>
  25. <p class="notes">
  26. Located in <a class="field" href="_Auth---OpenID---AX.php.html">/Auth/OpenID/AX.php</a> (line <span class="field">84</span>)
  27. </p>
  28. <pre><a href="../OpenID/Auth_OpenID_Extension.html">Auth_OpenID_Extension</a>
  29. |
  30. --Auth_OpenID_AX_Message</pre>
  31. </div>
  32. </div>
  33. <a name="sec-descendents"></a>
  34. <div class="info-box">
  35. <div class="info-box-title">Direct descendents</div>
  36. <div class="nav-bar">
  37. <a href="#sec-description">Description</a> |
  38. <span class="disabled">Descendents</span>
  39. | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  40. | <a href="#sec-methods">Methods</a>
  41. </div>
  42. <div class="info-box-body">
  43. <table cellpadding="2" cellspacing="0" class="class-table">
  44. <tr>
  45. <th class="class-table-header">Class</th>
  46. <th class="class-table-header">Description</th>
  47. </tr>
  48. <tr>
  49. <td style="padding-right: 2em"><a href="../OpenID/Auth_OpenID_AX_FetchRequest.html">Auth_OpenID_AX_FetchRequest</a></td>
  50. <td>
  51. 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.
  52. </td>
  53. </tr>
  54. <tr>
  55. <td style="padding-right: 2em"><a href="../OpenID/Auth_OpenID_AX_KeyValueMessage.html">Auth_OpenID_AX_KeyValueMessage</a></td>
  56. <td>
  57. An abstract class that implements a message that has attribute keys and values. It contains the common code between fetch_response and store_request.
  58. </td>
  59. </tr>
  60. <tr>
  61. <td style="padding-right: 2em"><a href="../OpenID/Auth_OpenID_AX_StoreResponse.html">Auth_OpenID_AX_StoreResponse</a></td>
  62. <td>
  63. An indication that the store request was processed along with this OpenID transaction. Use make(), NOT the constructor, to create response objects.
  64. </td>
  65. </tr>
  66. </table>
  67. </div>
  68. </div>
  69. <a name="sec-var-summary"></a>
  70. <div class="info-box">
  71. <div class="info-box-title">Variable Summary</span></div>
  72. <div class="nav-bar">
  73. <a href="#sec-description">Description</a> |
  74. <a href="#sec-descendents">Descendents</a> |
  75. <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
  76. |
  77. <a href="#sec-methods">Methods</a>
  78. </div>
  79. <div class="info-box-body">
  80. <div class="var-summary">
  81. <div class="var-title">
  82. <span class="var-type">mixed</span>
  83. <a href="#$mode" title="details" class="var-name">$mode</a>
  84. </div>
  85. <div class="var-title">
  86. <span class="var-type">mixed</span>
  87. <a href="#$ns_alias" title="details" class="var-name">$ns_alias</a>
  88. </div>
  89. <div class="var-title">
  90. <span class="var-type">mixed</span>
  91. <a href="#$ns_uri" title="details" class="var-name">$ns_uri</a>
  92. </div>
  93. </div>
  94. </div>
  95. </div>
  96. <a name="sec-vars"></a>
  97. <div class="info-box">
  98. <div class="info-box-title">Variables</div>
  99. <div class="nav-bar">
  100. <a href="#sec-description">Description</a> |
  101. <a href="#sec-descendents">Descendents</a> |
  102. <span class="disabled">Vars</span>
  103. |
  104. <a href="#sec-methods">Methods</a>
  105. </div>
  106. <div class="info-box-body">
  107. <a name="var$mode" id="$mode"><!-- --></A>
  108. <div class="oddrow">
  109. <div class="var-header">
  110. <span class="var-title">
  111. <span class="var-type">mixed</span>
  112. <span class="var-name">$mode</span>
  113. = <span class="var-default"> null</span> (line <span class="line-number">95</span>)
  114. </span>
  115. </div>
  116. <!-- ========== Info from phpDoc block ========= -->
  117. <p class="short-description">mode: The type of this attribute exchange message. This must be overridden in subclasses.</p>
  118. <hr class="separator" />
  119. <div class="notes">Redefined in descendants as:</div>
  120. <ul class="redefinitions">
  121. <li>
  122. <a href="../OpenID/Auth_OpenID_AX_FetchRequest.html#var$mode">Auth_OpenID_AX_FetchRequest::$mode</a>
  123. </li>
  124. <li>
  125. <a href="../OpenID/Auth_OpenID_AX_FetchResponse.html#var$mode">Auth_OpenID_AX_FetchResponse::$mode</a>
  126. </li>
  127. <li>
  128. <a href="../OpenID/Auth_OpenID_AX_StoreRequest.html#var$mode">Auth_OpenID_AX_StoreRequest::$mode</a>
  129. </li>
  130. </ul>
  131. </div>
  132. <a name="var$ns_alias" id="$ns_alias"><!-- --></A>
  133. <div class="evenrow">
  134. <div class="var-header">
  135. <span class="var-title">
  136. <span class="var-type">mixed</span>
  137. <span class="var-name">$ns_alias</span>
  138. = <span class="var-default"> 'ax'</span> (line <span class="line-number">89</span>)
  139. </span>
  140. </div>
  141. <!-- ========== Info from phpDoc block ========= -->
  142. <p class="short-description">ns_alias: The preferred namespace alias for attribute exchange</p>
  143. <p class="description"><p>messages</p></p>
  144. <hr class="separator" />
  145. <div class="notes">Redefinition of:</div>
  146. <dl>
  147. <dt><a href="../OpenID/Auth_OpenID_Extension.html#var$ns_alias">Auth_OpenID_Extension::$ns_alias</a></dt>
  148. </dl>
  149. </div>
  150. <a name="var$ns_uri" id="$ns_uri"><!-- --></A>
  151. <div class="oddrow">
  152. <div class="var-header">
  153. <span class="var-title">
  154. <span class="var-type">mixed</span>
  155. <span class="var-name">$ns_uri</span>
  156. = <span class="var-default"> Auth_OpenID_AX_NS_URI</span> (line <span class="line-number">97</span>)
  157. </span>
  158. </div>
  159. <!-- ========== Info from phpDoc block ========= -->
  160. <hr class="separator" />
  161. <div class="notes">Redefinition of:</div>
  162. <dl>
  163. <dt><a href="../OpenID/Auth_OpenID_Extension.html#var$ns_uri">Auth_OpenID_Extension::$ns_uri</a></dt>
  164. <dd>ns_uri: The namespace to which to add the arguments for this</dd>
  165. </dl>
  166. </div>
  167. </div>
  168. </div>
  169. <a name="sec-methods"></a>
  170. <div class="info-box">
  171. <div class="info-box-title">Methods</div>
  172. <div class="nav-bar">
  173. <a href="#sec-description">Description</a> |
  174. <a href="#sec-descendents">Descendents</a> |
  175. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  176. <span class="disabled">Methods</span>
  177. </div>
  178. <div class="info-box-body">
  179. <A NAME='method_detail'></A>
  180. <h4>Inherited Methods</h4>
  181. <a name='inherited_methods'><!-- --></a>
  182. <!-- =========== Summary =========== -->
  183. <p>Inherited From <span class="classname"><a href="../OpenID/Auth_OpenID_Extension.html">Auth_OpenID_Extension</a></span></p>
  184. <blockquote>
  185. <span class="method-name"><a href="../OpenID/Auth_OpenID_Extension.html#methodgetExtensionArgs">Auth_OpenID_Extension::getExtensionArgs()</a></span><br>
  186. <span class="method-name"><a href="../OpenID/Auth_OpenID_Extension.html#methodtoMessage">Auth_OpenID_Extension::toMessage()</a></span><br>
  187. </blockquote>
  188. </div>
  189. </div>
  190. <p class="notes" id="credit">
  191. Documentation generated on Tue, 21 Apr 2009 11:31:30 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
  192. </p>
  193. </div></body>
  194. </html>