Auth_OpenID_CheckIDRequest.html 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570
  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_CheckIDRequest</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_CheckIDRequest</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 request to confirm the identity of a user.</p>
  24. <p class="notes">
  25. Located in <a class="field" href="_Auth---OpenID---Server.php.html">/Auth/OpenID/Server.php</a> (line <span class="field">708</span>)
  26. </p>
  27. <pre><a href="../OpenID/Auth_OpenID_Request.html">Auth_OpenID_Request</a>
  28. |
  29. --Auth_OpenID_CheckIDRequest</pre>
  30. </div>
  31. </div>
  32. <a name="sec-var-summary"></a>
  33. <div class="info-box">
  34. <div class="info-box-title">Variable Summary</span></div>
  35. <div class="nav-bar">
  36. <a href="#sec-description">Description</a> |
  37. <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
  38. |
  39. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  40. </div>
  41. <div class="info-box-body">
  42. <div class="var-summary">
  43. <div class="var-title">
  44. <span class="var-type">mixed</span>
  45. <a href="#$immediate" title="details" class="var-name">$immediate</a>
  46. </div>
  47. <div class="var-title">
  48. <span class="var-type">mixed</span>
  49. <a href="#$mode" title="details" class="var-name">$mode</a>
  50. </div>
  51. <div class="var-title">
  52. <span class="var-type">mixed</span>
  53. <a href="#$namespace" title="details" class="var-name">$namespace</a>
  54. </div>
  55. <div class="var-title">
  56. <span class="var-type">mixed</span>
  57. <a href="#$trust_root" title="details" class="var-name">$trust_root</a>
  58. </div>
  59. <div class="var-title">
  60. <span class="var-type">mixed</span>
  61. <a href="#$verifyReturnTo" title="details" class="var-name">$verifyReturnTo</a>
  62. </div>
  63. </div>
  64. </div>
  65. </div>
  66. <a name="sec-method-summary"></a>
  67. <div class="info-box">
  68. <div class="info-box-title">Method Summary</span></div>
  69. <div class="nav-bar">
  70. <a href="#sec-description">Description</a> |
  71. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  72. |
  73. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  74. </div>
  75. <div class="info-box-body">
  76. <div class="method-summary">
  77. <div class="method-definition">
  78. <span class="method-result">Auth_OpenID_CheckIDRequest</span>
  79. <a href="#Auth_OpenID_CheckIDRequest" title="details" class="method-name">Auth_OpenID_CheckIDRequest</a>
  80. (<span class="var-type"></span>&nbsp;<span class="var-name">$identity</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$return_to</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$trust_root</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$immediate</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$assoc_handle</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$server</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$claimed_id</span> = <span class="var-default">null</span>])
  81. </div>
  82. <div class="method-definition">
  83. <span class="method-result">mixed</span>
  84. <a href="#answer" title="details" class="method-name">answer</a>
  85. (<span class="var-type">bool</span>&nbsp;<span class="var-name">$allow</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$server_url</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$identity</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$claimed_id</span> = <span class="var-default">null</span>])
  86. </div>
  87. <div class="method-definition">
  88. <span class="method-result">void</span>
  89. <a href="#encodeToURL" title="details" class="method-name">encodeToURL</a>
  90. (<span class="var-type"></span>&nbsp;<span class="var-name">$server_url</span>)
  91. </div>
  92. <div class="method-definition">
  93. <span class="method-result">void</span>
  94. <a href="#equals" title="details" class="method-name">equals</a>
  95. (<span class="var-type"></span>&nbsp;<span class="var-name">$other</span>)
  96. </div>
  97. <div class="method-definition">
  98. <span class="method-result">void</span>
  99. <a href="#fromMessage" title="details" class="method-name">fromMessage</a>
  100. (<span class="var-type"></span>&nbsp;<span class="var-name">&$message</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$server</span>)
  101. </div>
  102. <div class="method-definition">
  103. <span class="method-result">void</span>
  104. <a href="#getCancelURL" title="details" class="method-name">getCancelURL</a>
  105. ()
  106. </div>
  107. <div class="method-definition">
  108. <span class="method-result">void</span>
  109. <a href="#idSelect" title="details" class="method-name">idSelect</a>
  110. ()
  111. </div>
  112. <div class="method-definition">
  113. <span class="method-result">void</span>
  114. <a href="#make" title="details" class="method-name">make</a>
  115. (<span class="var-type"></span>&nbsp;<span class="var-name">&$message</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$identity</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$return_to</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$trust_root</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$immediate</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$assoc_handle</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$server</span> = <span class="var-default">null</span>])
  116. </div>
  117. <div class="method-definition">
  118. <span class="method-result">void</span>
  119. <a href="#returnToVerified" title="details" class="method-name">returnToVerified</a>
  120. ()
  121. </div>
  122. <div class="method-definition">
  123. <span class="method-result">void</span>
  124. <a href="#trustRootValid" title="details" class="method-name">trustRootValid</a>
  125. ()
  126. </div>
  127. </div>
  128. </div>
  129. </div>
  130. <a name="sec-vars"></a>
  131. <div class="info-box">
  132. <div class="info-box-title">Variables</div>
  133. <div class="nav-bar">
  134. <a href="#sec-description">Description</a> |
  135. <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  136. |
  137. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  138. </div>
  139. <div class="info-box-body">
  140. <a name="var$immediate" id="$immediate"><!-- --></A>
  141. <div class="oddrow">
  142. <div class="var-header">
  143. <span class="var-title">
  144. <span class="var-type">mixed</span>
  145. <span class="var-name">$immediate</span>
  146. = <span class="var-default"> false</span> (line <span class="line-number">723</span>)
  147. </span>
  148. </div>
  149. <!-- ========== Info from phpDoc block ========= -->
  150. <p class="short-description">Whether this request is for immediate mode.</p>
  151. </div>
  152. <a name="var$mode" id="$mode"><!-- --></A>
  153. <div class="evenrow">
  154. <div class="var-header">
  155. <span class="var-title">
  156. <span class="var-type">mixed</span>
  157. <span class="var-name">$mode</span>
  158. = <span class="var-default"> &quot;checkid_setup&quot;</span> (line <span class="line-number">718</span>)
  159. </span>
  160. </div>
  161. <!-- ========== Info from phpDoc block ========= -->
  162. <p class="short-description">The mode of this request.</p>
  163. <hr class="separator" />
  164. <div class="notes">Redefinition of:</div>
  165. <dl>
  166. <dt><a href="../OpenID/Auth_OpenID_Request.html#var$mode">Auth_OpenID_Request::$mode</a></dt>
  167. </dl>
  168. </div>
  169. <a name="var$namespace" id="$namespace"><!-- --></A>
  170. <div class="oddrow">
  171. <div class="var-header">
  172. <span class="var-title">
  173. <span class="var-type">mixed</span>
  174. <span class="var-name">$namespace</span>
  175. (line <span class="line-number">734</span>)
  176. </span>
  177. </div>
  178. <!-- ========== Info from phpDoc block ========= -->
  179. <p class="short-description">The OpenID namespace for this request.</p>
  180. <p class="description"><p>deprecated since version 2.0.2</p></p>
  181. </div>
  182. <a name="var$trust_root" id="$trust_root"><!-- --></A>
  183. <div class="evenrow">
  184. <div class="var-header">
  185. <span class="var-title">
  186. <span class="var-type">mixed</span>
  187. <span class="var-name">$trust_root</span>
  188. = <span class="var-default"> null</span> (line <span class="line-number">728</span>)
  189. </span>
  190. </div>
  191. <!-- ========== Info from phpDoc block ========= -->
  192. <p class="short-description">The trust_root value for this request.</p>
  193. </div>
  194. <a name="var$verifyReturnTo" id="$verifyReturnTo"><!-- --></A>
  195. <div class="oddrow">
  196. <div class="var-header">
  197. <span class="var-title">
  198. <span class="var-type">mixed</span>
  199. <span class="var-name">$verifyReturnTo</span>
  200. = <span class="var-default"> 'Auth_OpenID_verifyReturnTo'</span> (line <span class="line-number">713</span>)
  201. </span>
  202. </div>
  203. <!-- ========== Info from phpDoc block ========= -->
  204. <p class="short-description">Return-to verification callback. Default is Auth_OpenID_verifyReturnTo from TrustRoot.php.</p>
  205. </div>
  206. </div>
  207. </div>
  208. <a name="sec-methods"></a>
  209. <div class="info-box">
  210. <div class="info-box-title">Methods</div>
  211. <div class="nav-bar">
  212. <a href="#sec-description">Description</a> |
  213. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  214. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  215. </div>
  216. <div class="info-box-body">
  217. <A NAME='method_detail'></A>
  218. <a name="methodAuth_OpenID_CheckIDRequest" id="Auth_OpenID_CheckIDRequest"><!-- --></a>
  219. <div class="evenrow">
  220. <div class="method-header">
  221. <span class="method-title">Constructor Auth_OpenID_CheckIDRequest</span> (line <span class="line-number">765</span>)
  222. </div>
  223. <!-- ========== Info from phpDoc block ========= -->
  224. <div class="method-signature">
  225. <span class="method-result">Auth_OpenID_CheckIDRequest</span>
  226. <span class="method-name">
  227. Auth_OpenID_CheckIDRequest
  228. </span>
  229. (<span class="var-type"></span>&nbsp;<span class="var-name">$identity</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$return_to</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$trust_root</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$immediate</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$assoc_handle</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$server</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$claimed_id</span> = <span class="var-default">null</span>])
  230. </div>
  231. <ul class="parameters">
  232. <li>
  233. <span class="var-type"></span>
  234. <span class="var-name">$identity</span> </li>
  235. <li>
  236. <span class="var-type"></span>
  237. <span class="var-name">$return_to</span> </li>
  238. <li>
  239. <span class="var-type"></span>
  240. <span class="var-name">$trust_root</span> </li>
  241. <li>
  242. <span class="var-type"></span>
  243. <span class="var-name">$immediate</span> </li>
  244. <li>
  245. <span class="var-type"></span>
  246. <span class="var-name">$assoc_handle</span> </li>
  247. <li>
  248. <span class="var-type"></span>
  249. <span class="var-name">$server</span> </li>
  250. <li>
  251. <span class="var-type"></span>
  252. <span class="var-name">$claimed_id</span> </li>
  253. </ul>
  254. </div>
  255. <a name="methodanswer" id="answer"><!-- --></a>
  256. <div class="oddrow">
  257. <div class="method-header">
  258. <span class="method-title">answer</span> (line <span class="line-number">972</span>)
  259. </div>
  260. <!-- ========== Info from phpDoc block ========= -->
  261. <p class="short-description">Respond to this request. Return either an <a href="../OpenID/Auth_OpenID_ServerResponse.html">Auth_OpenID_ServerResponse</a> or <a href="../OpenID/Auth_OpenID_ServerError.html">Auth_OpenID_ServerError</a>.</p>
  262. <div class="method-signature">
  263. <span class="method-result">mixed</span>
  264. <span class="method-name">
  265. answer
  266. </span>
  267. (<span class="var-type">bool</span>&nbsp;<span class="var-name">$allow</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$server_url</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$identity</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$claimed_id</span> = <span class="var-default">null</span>])
  268. </div>
  269. <ul class="parameters">
  270. <li>
  271. <span class="var-type">bool</span>
  272. <span class="var-name">$allow</span><span class="var-description">: Allow this user to claim this identity, and allow the consumer to have this information?</span> </li>
  273. <li>
  274. <span class="var-type">string</span>
  275. <span class="var-name">$server_url</span><span class="var-description">: <p>DEPRECATED. Passing $op_endpoint to the <a href="../OpenID/Auth_OpenID_Server.html">Auth_OpenID_Server</a> constructor makes this optional.</p><p>When an OpenID 1.x immediate mode request does not succeed, it gets back a URL where the request may be carried out in a not-so-immediate fashion. Pass my URL in here (the fully qualified address of this server's endpoint, i.e. http://example.com/server), and I will use it as a base for the URL for a new request.</p><p>Optional for requests where <a href="../OpenID/Auth_OpenID_CheckIDRequest.html#var$immediate">$immediate</a> is false or $allow is true.</p></span> </li>
  276. <li>
  277. <span class="var-type">string</span>
  278. <span class="var-name">$identity</span><span class="var-description">: The OP-local identifier to answer with. Only for use when the relying party requested identifier selection.</span> </li>
  279. <li>
  280. <span class="var-type">string</span>
  281. <span class="var-name">$claimed_id</span><span class="var-description">: <p>The claimed identifier to answer with, for use with identifier selection in the case where the claimed identifier and the OP-local identifier differ, i.e. when the claimed_id uses delegation.</p><p>If $identity is provided but this is not, $claimed_id will default to the value of $identity. When answering requests that did not ask for identifier selection, the response $claimed_id will default to that of the request.</p><p>This parameter is new in OpenID 2.0.</p></span> </li>
  282. </ul>
  283. </div>
  284. <a name="methodencodeToURL" id="encodeToURL"><!-- --></a>
  285. <div class="evenrow">
  286. <div class="method-header">
  287. <span class="method-title">encodeToURL</span> (line <span class="line-number">1124</span>)
  288. </div>
  289. <!-- ========== Info from phpDoc block ========= -->
  290. <div class="method-signature">
  291. <span class="method-result">void</span>
  292. <span class="method-name">
  293. encodeToURL
  294. </span>
  295. (<span class="var-type"></span>&nbsp;<span class="var-name">$server_url</span>)
  296. </div>
  297. <ul class="parameters">
  298. <li>
  299. <span class="var-type"></span>
  300. <span class="var-name">$server_url</span> </li>
  301. </ul>
  302. </div>
  303. <a name="methodequals" id="equals"><!-- --></a>
  304. <div class="oddrow">
  305. <div class="method-header">
  306. <span class="method-title">equals</span> (line <span class="line-number">791</span>)
  307. </div>
  308. <!-- ========== Info from phpDoc block ========= -->
  309. <div class="method-signature">
  310. <span class="method-result">void</span>
  311. <span class="method-name">
  312. equals
  313. </span>
  314. (<span class="var-type"></span>&nbsp;<span class="var-name">$other</span>)
  315. </div>
  316. <ul class="parameters">
  317. <li>
  318. <span class="var-type"></span>
  319. <span class="var-name">$other</span> </li>
  320. </ul>
  321. </div>
  322. <a name="methodfromMessage" id="fromMessage"><!-- --></a>
  323. <div class="evenrow">
  324. <div class="method-header">
  325. <span class="method-title">fromMessage</span> (line <span class="line-number">823</span>)
  326. </div>
  327. <!-- ========== Info from phpDoc block ========= -->
  328. <div class="method-signature">
  329. <span class="method-result">void</span>
  330. <span class="method-name">
  331. fromMessage
  332. </span>
  333. (<span class="var-type"></span>&nbsp;<span class="var-name">&$message</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$server</span>)
  334. </div>
  335. <ul class="parameters">
  336. <li>
  337. <span class="var-type"></span>
  338. <span class="var-name">&$message</span> </li>
  339. <li>
  340. <span class="var-type"></span>
  341. <span class="var-name">$server</span> </li>
  342. </ul>
  343. </div>
  344. <a name="methodgetCancelURL" id="getCancelURL"><!-- --></a>
  345. <div class="oddrow">
  346. <div class="method-header">
  347. <span class="method-title">getCancelURL</span> (line <span class="line-number">1158</span>)
  348. </div>
  349. <!-- ========== Info from phpDoc block ========= -->
  350. <div class="method-signature">
  351. <span class="method-result">void</span>
  352. <span class="method-name">
  353. getCancelURL
  354. </span>
  355. ()
  356. </div>
  357. </div>
  358. <a name="methodidSelect" id="idSelect"><!-- --></a>
  359. <div class="evenrow">
  360. <div class="method-header">
  361. <span class="method-title">idSelect</span> (line <span class="line-number">906</span>)
  362. </div>
  363. <!-- ========== Info from phpDoc block ========= -->
  364. <div class="method-signature">
  365. <span class="method-result">void</span>
  366. <span class="method-name">
  367. idSelect
  368. </span>
  369. ()
  370. </div>
  371. </div>
  372. <a name="methodmake" id="make"><!-- --></a>
  373. <div class="oddrow">
  374. <div class="method-header">
  375. <span class="method-title">make</span> (line <span class="line-number">736</span>)
  376. </div>
  377. <!-- ========== Info from phpDoc block ========= -->
  378. <div class="method-signature">
  379. <span class="method-result">void</span>
  380. <span class="method-name">
  381. make
  382. </span>
  383. (<span class="var-type"></span>&nbsp;<span class="var-name">&$message</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$identity</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$return_to</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$trust_root</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$immediate</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$assoc_handle</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$server</span> = <span class="var-default">null</span>])
  384. </div>
  385. <ul class="parameters">
  386. <li>
  387. <span class="var-type"></span>
  388. <span class="var-name">&$message</span> </li>
  389. <li>
  390. <span class="var-type"></span>
  391. <span class="var-name">$identity</span> </li>
  392. <li>
  393. <span class="var-type"></span>
  394. <span class="var-name">$return_to</span> </li>
  395. <li>
  396. <span class="var-type"></span>
  397. <span class="var-name">$trust_root</span> </li>
  398. <li>
  399. <span class="var-type"></span>
  400. <span class="var-name">$immediate</span> </li>
  401. <li>
  402. <span class="var-type"></span>
  403. <span class="var-name">$assoc_handle</span> </li>
  404. <li>
  405. <span class="var-type"></span>
  406. <span class="var-name">$server</span> </li>
  407. </ul>
  408. </div>
  409. <a name="methodreturnToVerified" id="returnToVerified"><!-- --></a>
  410. <div class="evenrow">
  411. <div class="method-header">
  412. <span class="method-title">returnToVerified</span> (line <span class="line-number">817</span>)
  413. </div>
  414. <!-- ========== Info from phpDoc block ========= -->
  415. <div class="method-signature">
  416. <span class="method-result">void</span>
  417. <span class="method-name">
  418. returnToVerified
  419. </span>
  420. ()
  421. </div>
  422. </div>
  423. <a name="methodtrustRootValid" id="trustRootValid"><!-- --></a>
  424. <div class="oddrow">
  425. <div class="method-header">
  426. <span class="method-title">trustRootValid</span> (line <span class="line-number">913</span>)
  427. </div>
  428. <!-- ========== Info from phpDoc block ========= -->
  429. <div class="method-signature">
  430. <span class="method-result">void</span>
  431. <span class="method-name">
  432. trustRootValid
  433. </span>
  434. ()
  435. </div>
  436. </div>
  437. </div>
  438. </div>
  439. <p class="notes" id="credit">
  440. Documentation generated on Tue, 21 Apr 2009 11:31:32 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
  441. </p>
  442. </div></body>
  443. </html>