Auth_OpenID_AuthRequest.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397
  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_AuthRequest</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_AuthRequest</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-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  19. </div>
  20. <div class="info-box-body">
  21. <!-- ========== Info from phpDoc block ========= -->
  22. <p class="short-description">This class represents an authentication request from a consumer to an OpenID server.</p>
  23. <p class="notes">
  24. Located in <a class="field" href="_Auth---OpenID---Consumer.php.html">/Auth/OpenID/Consumer.php</a> (line <span class="field">1741</span>)
  25. </p>
  26. <pre></pre>
  27. </div>
  28. </div>
  29. <a name="sec-method-summary"></a>
  30. <div class="info-box">
  31. <div class="info-box-title">Method Summary</span></div>
  32. <div class="nav-bar">
  33. <a href="#sec-description">Description</a> |
  34. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  35. </div>
  36. <div class="info-box-body">
  37. <div class="method-summary">
  38. <div class="method-definition">
  39. <span class="method-result">Auth_OpenID_AuthRequest</span>
  40. <a href="#Auth_OpenID_AuthRequest" title="details" class="method-name">Auth_OpenID_AuthRequest</a>
  41. (<span class="var-type"></span>&nbsp;<span class="var-name">&$endpoint</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$assoc</span>)
  42. </div>
  43. <div class="method-definition">
  44. <span class="method-result">void</span>
  45. <a href="#addExtension" title="details" class="method-name">addExtension</a>
  46. (<span class="var-type"></span>&nbsp;<span class="var-name">&$extension_request</span>)
  47. </div>
  48. <div class="method-definition">
  49. <span class="method-result">void</span>
  50. <a href="#addExtensionArg" title="details" class="method-name">addExtensionArg</a>
  51. (<span class="var-type">string</span>&nbsp;<span class="var-name">$namespace</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
  52. </div>
  53. <div class="method-definition">
  54. <span class="method-result">void</span>
  55. <a href="#formMarkup" title="details" class="method-name">formMarkup</a>
  56. (<span class="var-type"></span>&nbsp;<span class="var-name">$realm</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$return_to</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">$form_tag_attrs</span> = <span class="var-default">null</span>])
  57. </div>
  58. <div class="method-definition">
  59. <span class="method-result">void</span>
  60. <a href="#getMessage" title="details" class="method-name">getMessage</a>
  61. (<span class="var-type">string</span>&nbsp;<span class="var-name">$realm</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$return_to</span> = <span class="var-default">null</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$immediate</span> = <span class="var-default">false</span>])
  62. </div>
  63. <div class="method-definition">
  64. <span class="method-result">void</span>
  65. <a href="#htmlMarkup" title="details" class="method-name">htmlMarkup</a>
  66. (<span class="var-type"></span>&nbsp;<span class="var-name">$realm</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$return_to</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">$form_tag_attrs</span> = <span class="var-default">null</span>])
  67. </div>
  68. <div class="method-definition">
  69. <span class="method-result">void</span>
  70. <a href="#redirectURL" title="details" class="method-name">redirectURL</a>
  71. (<span class="var-type"></span>&nbsp;<span class="var-name">$realm</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$return_to</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>])
  72. </div>
  73. <div class="method-definition">
  74. <span class="method-result">void</span>
  75. <a href="#setAnonymous" title="details" class="method-name">setAnonymous</a>
  76. (<span class="var-type"></span>&nbsp;<span class="var-name">$is_anonymous</span>)
  77. </div>
  78. <div class="method-definition">
  79. <span class="method-result">void</span>
  80. <a href="#shouldSendRedirect" title="details" class="method-name">shouldSendRedirect</a>
  81. ()
  82. </div>
  83. </div>
  84. </div>
  85. </div>
  86. <a name="sec-methods"></a>
  87. <div class="info-box">
  88. <div class="info-box-title">Methods</div>
  89. <div class="nav-bar">
  90. <a href="#sec-description">Description</a> |
  91. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  92. </div>
  93. <div class="info-box-body">
  94. <A NAME='method_detail'></A>
  95. <a name="methodAuth_OpenID_AuthRequest" id="Auth_OpenID_AuthRequest"><!-- --></a>
  96. <div class="evenrow">
  97. <div class="method-header">
  98. <span class="method-title">Constructor Auth_OpenID_AuthRequest</span> (line <span class="line-number">1751</span>)
  99. </div>
  100. <!-- ========== Info from phpDoc block ========= -->
  101. <p class="short-description">Initialize an authentication request with the specified token, association, and endpoint.</p>
  102. <p class="description"><p>Users of this library should not create instances of this class. Instances of this class are created by the library when needed.</p></p>
  103. <div class="method-signature">
  104. <span class="method-result">Auth_OpenID_AuthRequest</span>
  105. <span class="method-name">
  106. Auth_OpenID_AuthRequest
  107. </span>
  108. (<span class="var-type"></span>&nbsp;<span class="var-name">&$endpoint</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$assoc</span>)
  109. </div>
  110. <ul class="parameters">
  111. <li>
  112. <span class="var-type"></span>
  113. <span class="var-name">&$endpoint</span> </li>
  114. <li>
  115. <span class="var-type"></span>
  116. <span class="var-name">$assoc</span> </li>
  117. </ul>
  118. </div>
  119. <a name="methodaddExtension" id="addExtension"><!-- --></a>
  120. <div class="oddrow">
  121. <div class="method-header">
  122. <span class="method-title">addExtension</span> (line <span class="line-number">1767</span>)
  123. </div>
  124. <!-- ========== Info from phpDoc block ========= -->
  125. <p class="short-description">Add an extension to this checkid request.</p>
  126. <p class="description"><p>$extension_request: An object that implements the extension request interface for adding arguments to an OpenID message.</p></p>
  127. <div class="method-signature">
  128. <span class="method-result">void</span>
  129. <span class="method-name">
  130. addExtension
  131. </span>
  132. (<span class="var-type"></span>&nbsp;<span class="var-name">&$extension_request</span>)
  133. </div>
  134. <ul class="parameters">
  135. <li>
  136. <span class="var-type"></span>
  137. <span class="var-name">&$extension_request</span> </li>
  138. </ul>
  139. </div>
  140. <a name="methodaddExtensionArg" id="addExtensionArg"><!-- --></a>
  141. <div class="evenrow">
  142. <div class="method-header">
  143. <span class="method-title">addExtensionArg</span> (line <span class="line-number">1791</span>)
  144. </div>
  145. <!-- ========== Info from phpDoc block ========= -->
  146. <p class="short-description">Add an extension argument to this OpenID authentication request.</p>
  147. <p class="description"><p>Use caution when adding arguments, because they will be URL-escaped and appended to the redirect URL, which can easily get quite long.</p></p>
  148. <div class="method-signature">
  149. <span class="method-result">void</span>
  150. <span class="method-name">
  151. addExtensionArg
  152. </span>
  153. (<span class="var-type">string</span>&nbsp;<span class="var-name">$namespace</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
  154. </div>
  155. <ul class="parameters">
  156. <li>
  157. <span class="var-type">string</span>
  158. <span class="var-name">$namespace</span><span class="var-description">: The namespace for the extension. For example, the simple registration extension uses the namespace 'sreg'.</span> </li>
  159. <li>
  160. <span class="var-type">string</span>
  161. <span class="var-name">$key</span><span class="var-description">: The key within the extension namespace. For example, the nickname field in the simple registration extension's key is 'nickname'.</span> </li>
  162. <li>
  163. <span class="var-type">string</span>
  164. <span class="var-name">$value</span><span class="var-description">: The value to provide to the server for this argument.</span> </li>
  165. </ul>
  166. </div>
  167. <a name="methodformMarkup" id="formMarkup"><!-- --></a>
  168. <div class="oddrow">
  169. <div class="method-header">
  170. <span class="method-title">formMarkup</span> (line <span class="line-number">1928</span>)
  171. </div>
  172. <!-- ========== Info from phpDoc block ========= -->
  173. <p class="short-description">Get html for a form to submit this request to the IDP.</p>
  174. <p class="description"><p>form_tag_attrs: An array of attributes to be added to the form tag. 'accept-charset' and 'enctype' have defaults that can be overridden. If a value is supplied for 'action' or 'method', it will be replaced.</p></p>
  175. <div class="method-signature">
  176. <span class="method-result">void</span>
  177. <span class="method-name">
  178. formMarkup
  179. </span>
  180. (<span class="var-type"></span>&nbsp;<span class="var-name">$realm</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$return_to</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">$form_tag_attrs</span> = <span class="var-default">null</span>])
  181. </div>
  182. <ul class="parameters">
  183. <li>
  184. <span class="var-type"></span>
  185. <span class="var-name">$realm</span> </li>
  186. <li>
  187. <span class="var-type"></span>
  188. <span class="var-name">$return_to</span> </li>
  189. <li>
  190. <span class="var-type"></span>
  191. <span class="var-name">$immediate</span> </li>
  192. <li>
  193. <span class="var-type"></span>
  194. <span class="var-name">$form_tag_attrs</span> </li>
  195. </ul>
  196. </div>
  197. <a name="methodgetMessage" id="getMessage"><!-- --></a>
  198. <div class="evenrow">
  199. <div class="method-header">
  200. <span class="method-title">getMessage</span> (line <span class="line-number">1835</span>)
  201. </div>
  202. <!-- ========== Info from phpDoc block ========= -->
  203. <p class="short-description">Produce a <a href="../OpenID/Auth_OpenID_Message.html">Auth_OpenID_Message</a> representing this request.</p>
  204. <div class="method-signature">
  205. <span class="method-result">void</span>
  206. <span class="method-name">
  207. getMessage
  208. </span>
  209. (<span class="var-type">string</span>&nbsp;<span class="var-name">$realm</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$return_to</span> = <span class="var-default">null</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$immediate</span> = <span class="var-default">false</span>])
  210. </div>
  211. <ul class="parameters">
  212. <li>
  213. <span class="var-type">string</span>
  214. <span class="var-name">$realm</span><span class="var-description">: The URL (or URL pattern) that identifies your web site to the user when she is authorizing it.</span> </li>
  215. <li>
  216. <span class="var-type">string</span>
  217. <span class="var-name">$return_to</span><span class="var-description">: <p>The URL that the OpenID provider will send the user back to after attempting to verify her identity.</p><p>Not specifying a return_to URL means that the user will not be returned to the site issuing the request upon its completion.</p></span> </li>
  218. <li>
  219. <span class="var-type">bool</span>
  220. <span class="var-name">$immediate</span><span class="var-description">: If true, the OpenID provider is to send back a response immediately, useful for behind-the-scenes authentication attempts. Otherwise the OpenID provider may engage the user before providing a response. This is the default case, as the user may need to provide credentials or approve the request before a positive response can be sent.</span> </li>
  221. </ul>
  222. </div>
  223. <a name="methodhtmlMarkup" id="htmlMarkup"><!-- --></a>
  224. <div class="oddrow">
  225. <div class="method-header">
  226. <span class="method-title">htmlMarkup</span> (line <span class="line-number">1947</span>)
  227. </div>
  228. <!-- ========== Info from phpDoc block ========= -->
  229. <p class="short-description">Get a complete html document that will autosubmit the request to the IDP.</p>
  230. <p class="description"><p>Wraps formMarkup. See the documentation for that function.</p></p>
  231. <div class="method-signature">
  232. <span class="method-result">void</span>
  233. <span class="method-name">
  234. htmlMarkup
  235. </span>
  236. (<span class="var-type"></span>&nbsp;<span class="var-name">$realm</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$return_to</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">$form_tag_attrs</span> = <span class="var-default">null</span>])
  237. </div>
  238. <ul class="parameters">
  239. <li>
  240. <span class="var-type"></span>
  241. <span class="var-name">$realm</span> </li>
  242. <li>
  243. <span class="var-type"></span>
  244. <span class="var-name">$return_to</span> </li>
  245. <li>
  246. <span class="var-type"></span>
  247. <span class="var-name">$immediate</span> </li>
  248. <li>
  249. <span class="var-type"></span>
  250. <span class="var-name">$form_tag_attrs</span> </li>
  251. </ul>
  252. </div>
  253. <a name="methodredirectURL" id="redirectURL"><!-- --></a>
  254. <div class="evenrow">
  255. <div class="method-header">
  256. <span class="method-title">redirectURL</span> (line <span class="line-number">1908</span>)
  257. </div>
  258. <!-- ========== Info from phpDoc block ========= -->
  259. <div class="method-signature">
  260. <span class="method-result">void</span>
  261. <span class="method-name">
  262. redirectURL
  263. </span>
  264. (<span class="var-type"></span>&nbsp;<span class="var-name">$realm</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$return_to</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>])
  265. </div>
  266. <ul class="parameters">
  267. <li>
  268. <span class="var-type"></span>
  269. <span class="var-name">$realm</span> </li>
  270. <li>
  271. <span class="var-type"></span>
  272. <span class="var-name">$return_to</span> </li>
  273. <li>
  274. <span class="var-type"></span>
  275. <span class="var-name">$immediate</span> </li>
  276. </ul>
  277. </div>
  278. <a name="methodsetAnonymous" id="setAnonymous"><!-- --></a>
  279. <div class="oddrow">
  280. <div class="method-header">
  281. <span class="method-title">setAnonymous</span> (line <span class="line-number">1805</span>)
  282. </div>
  283. <!-- ========== Info from phpDoc block ========= -->
  284. <p class="short-description">Set whether this request should be made anonymously. If a request is anonymous, the identifier will not be sent in the request. This is only useful if you are making another kind of request with an extension in this request.</p>
  285. <p class="description"><p>Anonymous requests are not allowed when the request is made with OpenID 1.</p></p>
  286. <div class="method-signature">
  287. <span class="method-result">void</span>
  288. <span class="method-name">
  289. setAnonymous
  290. </span>
  291. (<span class="var-type"></span>&nbsp;<span class="var-name">$is_anonymous</span>)
  292. </div>
  293. <ul class="parameters">
  294. <li>
  295. <span class="var-type"></span>
  296. <span class="var-name">$is_anonymous</span> </li>
  297. </ul>
  298. </div>
  299. <a name="methodshouldSendRedirect" id="shouldSendRedirect"><!-- --></a>
  300. <div class="evenrow">
  301. <div class="method-header">
  302. <span class="method-title">shouldSendRedirect</span> (line <span class="line-number">1959</span>)
  303. </div>
  304. <!-- ========== Info from phpDoc block ========= -->
  305. <div class="method-signature">
  306. <span class="method-result">void</span>
  307. <span class="method-name">
  308. shouldSendRedirect
  309. </span>
  310. ()
  311. </div>
  312. </div>
  313. </div>
  314. </div>
  315. <p class="notes" id="credit">
  316. 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>
  317. </p>
  318. </div></body>
  319. </html>