Auth_OpenID_SuccessResponse.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343
  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_SuccessResponse</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_SuccessResponse</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">A response with a status of Auth_OpenID_SUCCESS. Indicates that</p>
  24. <p class="description"><p>this request is a successful acknowledgement from the OpenID server that the supplied URL is, indeed controlled by the requesting agent. This has three relevant attributes:</p><p>claimed_id - The identity URL that has been authenticated</p><p>signed_args - The arguments in the server's response that were signed and verified.</p><p>status - Auth_OpenID_SUCCESS.</p></p>
  25. <p class="notes">
  26. Located in <a class="field" href="_Auth---OpenID---Consumer.php.html">/Auth/OpenID/Consumer.php</a> (line <span class="field">2024</span>)
  27. </p>
  28. <pre><a href="../OpenID/Auth_OpenID_ConsumerResponse.html">Auth_OpenID_ConsumerResponse</a>
  29. |
  30. --Auth_OpenID_SuccessResponse</pre>
  31. </div>
  32. </div>
  33. <a name="sec-var-summary"></a>
  34. <div class="info-box">
  35. <div class="info-box-title">Variable Summary</span></div>
  36. <div class="nav-bar">
  37. <a href="#sec-description">Description</a> |
  38. <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
  39. |
  40. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  41. </div>
  42. <div class="info-box-body">
  43. <div class="var-summary">
  44. <div class="var-title">
  45. <span class="var-type">mixed</span>
  46. <a href="#$status" title="details" class="var-name">$status</a>
  47. </div>
  48. </div>
  49. </div>
  50. </div>
  51. <a name="sec-method-summary"></a>
  52. <div class="info-box">
  53. <div class="info-box-title">Method Summary</span></div>
  54. <div class="nav-bar">
  55. <a href="#sec-description">Description</a> |
  56. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  57. |
  58. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  59. </div>
  60. <div class="info-box-body">
  61. <div class="method-summary">
  62. <div class="method-definition">
  63. <span class="method-result">void</span>
  64. <a href="#extensionResponse" title="details" class="method-name">extensionResponse</a>
  65. (<span class="var-type"></span>&nbsp;<span class="var-name">$namespace_uri</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$require_signed</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$prefix</span>)
  66. </div>
  67. <div class="method-definition">
  68. <span class="method-result">string</span>
  69. <a href="#getReturnTo" title="details" class="method-name">getReturnTo</a>
  70. ()
  71. </div>
  72. <div class="method-definition">
  73. <span class="method-result">void</span>
  74. <a href="#getSigned" title="details" class="method-name">getSigned</a>
  75. (<span class="var-type"></span>&nbsp;<span class="var-name">$ns_uri</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$ns_key</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$default</span> = <span class="var-default">null</span>])
  76. </div>
  77. <div class="method-definition">
  78. <span class="method-result">void</span>
  79. <a href="#getSignedNS" title="details" class="method-name">getSignedNS</a>
  80. (<span class="var-type"></span>&nbsp;<span class="var-name">$ns_uri</span>)
  81. </div>
  82. <div class="method-definition">
  83. <span class="method-result">void</span>
  84. <a href="#isOpenID1" title="details" class="method-name">isOpenID1</a>
  85. ()
  86. </div>
  87. <div class="method-definition">
  88. <span class="method-result">void</span>
  89. <a href="#isSigned" title="details" class="method-name">isSigned</a>
  90. (<span class="var-type"></span>&nbsp;<span class="var-name">$ns_uri</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$ns_key</span>)
  91. </div>
  92. </div>
  93. </div>
  94. </div>
  95. <a name="sec-vars"></a>
  96. <div class="info-box">
  97. <div class="info-box-title">Variables</div>
  98. <div class="nav-bar">
  99. <a href="#sec-description">Description</a> |
  100. <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  101. |
  102. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  103. </div>
  104. <div class="info-box-body">
  105. <a name="var$status" id="$status"><!-- --></A>
  106. <div class="oddrow">
  107. <div class="var-header">
  108. <span class="var-title">
  109. <span class="var-type">mixed</span>
  110. <span class="var-name">$status</span>
  111. = <span class="var-default"> Auth_OpenID_SUCCESS</span> (line <span class="line-number">2025</span>)
  112. </span>
  113. </div>
  114. <!-- ========== Info from phpDoc block ========= -->
  115. <hr class="separator" />
  116. <div class="notes">Redefinition of:</div>
  117. <dl>
  118. <dt><a href="../OpenID/Auth_OpenID_ConsumerResponse.html#var$status">Auth_OpenID_ConsumerResponse::$status</a></dt>
  119. </dl>
  120. </div>
  121. </div>
  122. </div>
  123. <a name="sec-methods"></a>
  124. <div class="info-box">
  125. <div class="info-box-title">Methods</div>
  126. <div class="nav-bar">
  127. <a href="#sec-description">Description</a> |
  128. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  129. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  130. </div>
  131. <div class="info-box-body">
  132. <A NAME='method_detail'></A>
  133. <a name="methodextensionResponse" id="extensionResponse"><!-- --></a>
  134. <div class="evenrow">
  135. <div class="method-header">
  136. <span class="method-title">extensionResponse</span> (line <span class="line-number">2048</span>)
  137. </div>
  138. <!-- ========== Info from phpDoc block ========= -->
  139. <p class="short-description">Extract signed extension data from the server's response.</p>
  140. <div class="method-signature">
  141. <span class="method-result">void</span>
  142. <span class="method-name">
  143. extensionResponse
  144. </span>
  145. (<span class="var-type"></span>&nbsp;<span class="var-name">$namespace_uri</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$require_signed</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$prefix</span>)
  146. </div>
  147. <ul class="parameters">
  148. <li>
  149. <span class="var-type">string</span>
  150. <span class="var-name">$prefix</span><span class="var-description">: The extension namespace from which to extract the extension data.</span> </li>
  151. <li>
  152. <span class="var-type"></span>
  153. <span class="var-name">$namespace_uri</span> </li>
  154. <li>
  155. <span class="var-type"></span>
  156. <span class="var-name">$require_signed</span> </li>
  157. </ul>
  158. </div>
  159. <a name="methodgetReturnTo" id="getReturnTo"><!-- --></a>
  160. <div class="oddrow">
  161. <div class="method-header">
  162. <span class="method-title">getReturnTo</span> (line <span class="line-number">2109</span>)
  163. </div>
  164. <!-- ========== Info from phpDoc block ========= -->
  165. <p class="short-description">Get the openid.return_to argument from this response.</p>
  166. <p class="description"><p>This is useful for verifying that this request was initiated by this consumer.</p></p>
  167. <ul class="tags">
  168. <li><span class="field">return:</span> The return_to URL supplied to the server on the initial request, or null if the response did not contain an 'openid.return_to' argument.</li>
  169. </ul>
  170. <div class="method-signature">
  171. <span class="method-result">string</span>
  172. <span class="method-name">
  173. getReturnTo
  174. </span>
  175. ()
  176. </div>
  177. </div>
  178. <a name="methodgetSigned" id="getSigned"><!-- --></a>
  179. <div class="evenrow">
  180. <div class="method-header">
  181. <span class="method-title">getSigned</span> (line <span class="line-number">2070</span>)
  182. </div>
  183. <!-- ========== Info from phpDoc block ========= -->
  184. <div class="method-signature">
  185. <span class="method-result">void</span>
  186. <span class="method-name">
  187. getSigned
  188. </span>
  189. (<span class="var-type"></span>&nbsp;<span class="var-name">$ns_uri</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$ns_key</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$default</span> = <span class="var-default">null</span>])
  190. </div>
  191. <ul class="parameters">
  192. <li>
  193. <span class="var-type"></span>
  194. <span class="var-name">$ns_uri</span> </li>
  195. <li>
  196. <span class="var-type"></span>
  197. <span class="var-name">$ns_key</span> </li>
  198. <li>
  199. <span class="var-type"></span>
  200. <span class="var-name">$default</span> </li>
  201. </ul>
  202. </div>
  203. <a name="methodgetSignedNS" id="getSignedNS"><!-- --></a>
  204. <div class="oddrow">
  205. <div class="method-header">
  206. <span class="method-title">getSignedNS</span> (line <span class="line-number">2081</span>)
  207. </div>
  208. <!-- ========== Info from phpDoc block ========= -->
  209. <div class="method-signature">
  210. <span class="method-result">void</span>
  211. <span class="method-name">
  212. getSignedNS
  213. </span>
  214. (<span class="var-type"></span>&nbsp;<span class="var-name">$ns_uri</span>)
  215. </div>
  216. <ul class="parameters">
  217. <li>
  218. <span class="var-type"></span>
  219. <span class="var-name">$ns_uri</span> </li>
  220. </ul>
  221. </div>
  222. <a name="methodisOpenID1" id="isOpenID1"><!-- --></a>
  223. <div class="evenrow">
  224. <div class="method-header">
  225. <span class="method-title">isOpenID1</span> (line <span class="line-number">2057</span>)
  226. </div>
  227. <!-- ========== Info from phpDoc block ========= -->
  228. <div class="method-signature">
  229. <span class="method-result">void</span>
  230. <span class="method-name">
  231. isOpenID1
  232. </span>
  233. ()
  234. </div>
  235. </div>
  236. <a name="methodisSigned" id="isSigned"><!-- --></a>
  237. <div class="oddrow">
  238. <div class="method-header">
  239. <span class="method-title">isSigned</span> (line <span class="line-number">2062</span>)
  240. </div>
  241. <!-- ========== Info from phpDoc block ========= -->
  242. <div class="method-signature">
  243. <span class="method-result">void</span>
  244. <span class="method-name">
  245. isSigned
  246. </span>
  247. (<span class="var-type"></span>&nbsp;<span class="var-name">$ns_uri</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$ns_key</span>)
  248. </div>
  249. <ul class="parameters">
  250. <li>
  251. <span class="var-type"></span>
  252. <span class="var-name">$ns_uri</span> </li>
  253. <li>
  254. <span class="var-type"></span>
  255. <span class="var-name">$ns_key</span> </li>
  256. </ul>
  257. </div>
  258. <h4>Inherited Methods</h4>
  259. <a name='inherited_methods'><!-- --></a>
  260. <!-- =========== Summary =========== -->
  261. <p>Inherited From <span class="classname"><a href="../OpenID/Auth_OpenID_ConsumerResponse.html">Auth_OpenID_ConsumerResponse</a></span></p>
  262. <blockquote>
  263. <span class="method-name"><a href="../OpenID/Auth_OpenID_ConsumerResponse.html#methodgetDisplayIdentifier">Auth_OpenID_ConsumerResponse::getDisplayIdentifier()</a></span><br>
  264. <span class="method-name"><a href="../OpenID/Auth_OpenID_ConsumerResponse.html#methodsetEndpoint">Auth_OpenID_ConsumerResponse::setEndpoint()</a></span><br>
  265. </blockquote>
  266. </div>
  267. </div>
  268. <p class="notes" id="credit">
  269. 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>
  270. </p>
  271. </div></body>
  272. </html>