Auth_OpenID_AX_StoreResponse.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306
  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_StoreResponse</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_StoreResponse</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-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  19. | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  20. </div>
  21. <div class="info-box-body">
  22. <!-- ========== Info from phpDoc block ========= -->
  23. <p class="short-description">An indication that the store request was processed along with this OpenID transaction. Use make(), NOT the constructor, to create response objects.</p>
  24. <p class="notes">
  25. Located in <a class="field" href="_Auth---OpenID---AX.php.html">/Auth/OpenID/AX.php</a> (line <span class="field">975</span>)
  26. </p>
  27. <pre><a href="../OpenID/Auth_OpenID_Extension.html">Auth_OpenID_Extension</a>
  28. |
  29. --<a href="../OpenID/Auth_OpenID_AX_Message.html">Auth_OpenID_AX_Message</a>
  30. |
  31. --Auth_OpenID_AX_StoreResponse</pre>
  32. </div>
  33. </div>
  34. <a name="sec-var-summary"></a>
  35. <div class="info-box">
  36. <div class="info-box-title">Variable Summary</span></div>
  37. <div class="nav-bar">
  38. <a href="#sec-description">Description</a> |
  39. <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
  40. |
  41. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  42. </div>
  43. <div class="info-box-body">
  44. <div class="var-summary">
  45. <div class="var-title">
  46. <span class="var-type">mixed</span>
  47. <a href="#$FAILURE_MODE" title="details" class="var-name">$FAILURE_MODE</a>
  48. </div>
  49. <div class="var-title">
  50. <span class="var-type">mixed</span>
  51. <a href="#$SUCCESS_MODE" title="details" class="var-name">$SUCCESS_MODE</a>
  52. </div>
  53. </div>
  54. </div>
  55. </div>
  56. <a name="sec-method-summary"></a>
  57. <div class="info-box">
  58. <div class="info-box-title">Method Summary</span></div>
  59. <div class="nav-bar">
  60. <a href="#sec-description">Description</a> |
  61. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  62. |
  63. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  64. </div>
  65. <div class="info-box-body">
  66. <div class="method-summary">
  67. <div class="method-definition">
  68. <span class="method-result">Auth_OpenID_AX_StoreResponse</span>
  69. <a href="#Auth_OpenID_AX_StoreResponse" title="details" class="method-name">Auth_OpenID_AX_StoreResponse</a>
  70. ([<span class="var-type"></span>&nbsp;<span class="var-name">$succeeded</span> = <span class="var-default">true</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$error_message</span> = <span class="var-default">null</span>])
  71. </div>
  72. <div class="method-definition">
  73. <span class="method-result">void</span>
  74. <a href="#getExtensionArgs" title="details" class="method-name">getExtensionArgs</a>
  75. ()
  76. </div>
  77. <div class="method-definition">
  78. <span class="method-result">void</span>
  79. <a href="#make" title="details" class="method-name">&amp;make</a>
  80. ([<span class="var-type"></span>&nbsp;<span class="var-name">$succeeded</span> = <span class="var-default">true</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$error_message</span> = <span class="var-default">null</span>])
  81. </div>
  82. <div class="method-definition">
  83. <span class="method-result">void</span>
  84. <a href="#succeeded" title="details" class="method-name">succeeded</a>
  85. ()
  86. </div>
  87. </div>
  88. </div>
  89. </div>
  90. <a name="sec-vars"></a>
  91. <div class="info-box">
  92. <div class="info-box-title">Variables</div>
  93. <div class="nav-bar">
  94. <a href="#sec-description">Description</a> |
  95. <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  96. |
  97. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  98. </div>
  99. <div class="info-box-body">
  100. <a name="var$FAILURE_MODE" id="$FAILURE_MODE"><!-- --></A>
  101. <div class="evenrow">
  102. <div class="var-header">
  103. <span class="var-title">
  104. <span class="var-type">mixed</span>
  105. <span class="var-name">$FAILURE_MODE</span>
  106. = <span class="var-default"> 'store_response_failure'</span> (line <span class="line-number">977</span>)
  107. </span>
  108. </div>
  109. <!-- ========== Info from phpDoc block ========= -->
  110. </div>
  111. <a name="var$SUCCESS_MODE" id="$SUCCESS_MODE"><!-- --></A>
  112. <div class="oddrow">
  113. <div class="var-header">
  114. <span class="var-title">
  115. <span class="var-type">mixed</span>
  116. <span class="var-name">$SUCCESS_MODE</span>
  117. = <span class="var-default"> 'store_response_success'</span> (line <span class="line-number">976</span>)
  118. </span>
  119. </div>
  120. <!-- ========== Info from phpDoc block ========= -->
  121. </div>
  122. <h4>Inherited Variables</h4>
  123. <A NAME='inherited_vars'><!-- --></A>
  124. <p>Inherited from <span class="classname"><a href="../OpenID/Auth_OpenID_AX_Message.html">Auth_OpenID_AX_Message</a></span></p>
  125. <blockquote>
  126. <span class="var-title">
  127. <span class="var-name"><a href="../OpenID/Auth_OpenID_AX_Message.html#var$mode">Auth_OpenID_AX_Message::$mode</a></span><br>
  128. </span>
  129. <span class="var-title">
  130. <span class="var-name"><a href="../OpenID/Auth_OpenID_AX_Message.html#var$ns_alias">Auth_OpenID_AX_Message::$ns_alias</a></span><br>
  131. </span>
  132. <span class="var-title">
  133. <span class="var-name"><a href="../OpenID/Auth_OpenID_AX_Message.html#var$ns_uri">Auth_OpenID_AX_Message::$ns_uri</a></span><br>
  134. </span>
  135. </blockquote>
  136. </div>
  137. </div>
  138. <a name="sec-methods"></a>
  139. <div class="info-box">
  140. <div class="info-box-title">Methods</div>
  141. <div class="nav-bar">
  142. <a href="#sec-description">Description</a> |
  143. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  144. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  145. </div>
  146. <div class="info-box-body">
  147. <A NAME='method_detail'></A>
  148. <a name="methodAuth_OpenID_AX_StoreResponse" id="Auth_OpenID_AX_StoreResponse"><!-- --></a>
  149. <div class="evenrow">
  150. <div class="method-header">
  151. <span class="method-title">Constructor Auth_OpenID_AX_StoreResponse</span> (line <span class="line-number">993</span>)
  152. </div>
  153. <!-- ========== Info from phpDoc block ========= -->
  154. <div class="method-signature">
  155. <span class="method-result">Auth_OpenID_AX_StoreResponse</span>
  156. <span class="method-name">
  157. Auth_OpenID_AX_StoreResponse
  158. </span>
  159. ([<span class="var-type"></span>&nbsp;<span class="var-name">$succeeded</span> = <span class="var-default">true</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$error_message</span> = <span class="var-default">null</span>])
  160. </div>
  161. <ul class="parameters">
  162. <li>
  163. <span class="var-type"></span>
  164. <span class="var-name">$succeeded</span> </li>
  165. <li>
  166. <span class="var-type"></span>
  167. <span class="var-name">$error_message</span> </li>
  168. </ul>
  169. </div>
  170. <a name="methodgetExtensionArgs" id="getExtensionArgs"><!-- --></a>
  171. <div class="oddrow">
  172. <div class="method-header">
  173. <span class="method-title">getExtensionArgs</span> (line <span class="line-number">1012</span>)
  174. </div>
  175. <!-- ========== Info from phpDoc block ========= -->
  176. <div class="method-signature">
  177. <span class="method-result">void</span>
  178. <span class="method-name">
  179. getExtensionArgs
  180. </span>
  181. ()
  182. </div>
  183. <hr class="separator" />
  184. <div class="notes">Redefinition of:</div>
  185. <dl>
  186. <dt><a href="../OpenID/Auth_OpenID_Extension.html#methodgetExtensionArgs">Auth_OpenID_Extension::getExtensionArgs()</a></dt>
  187. <dd>Get the string arguments that should be added to an OpenID message for this extension.</dd>
  188. </dl>
  189. </div>
  190. <a name="methodmake" id="make"><!-- --></a>
  191. <div class="evenrow">
  192. <div class="method-header">
  193. <span class="method-title">make</span> (line <span class="line-number">983</span>)
  194. </div>
  195. <!-- ========== Info from phpDoc block ========= -->
  196. <p class="short-description">Returns Auth_OpenID_AX_Error on error or an Auth_OpenID_AX_StoreResponse object on success.</p>
  197. <div class="method-signature">
  198. <span class="method-result">void</span>
  199. <span class="method-name">
  200. &amp;make
  201. </span>
  202. ([<span class="var-type"></span>&nbsp;<span class="var-name">$succeeded</span> = <span class="var-default">true</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$error_message</span> = <span class="var-default">null</span>])
  203. </div>
  204. <ul class="parameters">
  205. <li>
  206. <span class="var-type"></span>
  207. <span class="var-name">$succeeded</span> </li>
  208. <li>
  209. <span class="var-type"></span>
  210. <span class="var-name">$error_message</span> </li>
  211. </ul>
  212. </div>
  213. <a name="methodsucceeded" id="succeeded"><!-- --></a>
  214. <div class="oddrow">
  215. <div class="method-header">
  216. <span class="method-title">succeeded</span> (line <span class="line-number">1007</span>)
  217. </div>
  218. <!-- ========== Info from phpDoc block ========= -->
  219. <p class="short-description">Was this response a success response?</p>
  220. <div class="method-signature">
  221. <span class="method-result">void</span>
  222. <span class="method-name">
  223. succeeded
  224. </span>
  225. ()
  226. </div>
  227. </div>
  228. <h4>Inherited Methods</h4>
  229. <a name='inherited_methods'><!-- --></a>
  230. <!-- =========== Summary =========== -->
  231. <p>Inherited From <span class="classname"><a href="../OpenID/Auth_OpenID_Extension.html">Auth_OpenID_Extension</a></span></p>
  232. <blockquote>
  233. <span class="method-name"><a href="../OpenID/Auth_OpenID_Extension.html#methodgetExtensionArgs">Auth_OpenID_Extension::getExtensionArgs()</a></span><br>
  234. <span class="method-name"><a href="../OpenID/Auth_OpenID_Extension.html#methodtoMessage">Auth_OpenID_Extension::toMessage()</a></span><br>
  235. </blockquote>
  236. </div>
  237. </div>
  238. <p class="notes" id="credit">
  239. 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>
  240. </p>
  241. </div></body>
  242. </html>