Auth_OpenID_GenericConsumer.html 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193
  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_GenericConsumer</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_GenericConsumer</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">This class is the interface to the OpenID consumer logic.</p>
  24. <p class="description"><p>Instances of it maintain no per-request state, so they can be reused (or even used by multiple threads concurrently) as needed.</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">568</span>)
  27. </p>
  28. <pre></pre>
  29. </div>
  30. </div>
  31. <a name="sec-var-summary"></a>
  32. <div class="info-box">
  33. <div class="info-box-title">Variable Summary</span></div>
  34. <div class="nav-bar">
  35. <a href="#sec-description">Description</a> |
  36. <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
  37. |
  38. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  39. </div>
  40. <div class="info-box-body">
  41. <div class="var-summary">
  42. <div class="var-title">
  43. <span class="var-type">mixed</span>
  44. <a href="#$openid1_return_to_identifier_name" title="details" class="var-name">$openid1_return_to_identifier_name</a>
  45. </div>
  46. <div class="var-title">
  47. <span class="var-type">mixed</span>
  48. <a href="#$store" title="details" class="var-name">$store</a>
  49. </div>
  50. </div>
  51. </div>
  52. </div>
  53. <a name="sec-method-summary"></a>
  54. <div class="info-box">
  55. <div class="info-box-title">Method Summary</span></div>
  56. <div class="nav-bar">
  57. <a href="#sec-description">Description</a> |
  58. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  59. |
  60. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  61. </div>
  62. <div class="info-box-body">
  63. <div class="method-summary">
  64. <div class="method-definition">
  65. <span class="method-result">Auth_OpenID_GenericConsumer</span>
  66. <a href="#Auth_OpenID_GenericConsumer" title="details" class="method-name">Auth_OpenID_GenericConsumer</a>
  67. (<span class="var-type"></span>&nbsp;<span class="var-name">&$store</span>, <span class="var-type"><a href="../OpenID/Auth_OpenID_OpenIDStore.html">Auth_OpenID_OpenIDStore</a></span>&nbsp;<span class="var-name">$store</span>, <span class="var-type">bool</span>&nbsp;<span class="var-name">$immediate</span>)
  68. </div>
  69. </div>
  70. </div>
  71. </div>
  72. <a name="sec-vars"></a>
  73. <div class="info-box">
  74. <div class="info-box-title">Variables</div>
  75. <div class="nav-bar">
  76. <a href="#sec-description">Description</a> |
  77. <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  78. |
  79. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  80. </div>
  81. <div class="info-box-body">
  82. <a name="var$openid1_return_to_identifier_name" id="$openid1_return_to_identifier_name"><!-- --></A>
  83. <div class="oddrow">
  84. <div class="var-header">
  85. <span class="var-title">
  86. <span class="var-type">mixed</span>
  87. <span class="var-name">$openid1_return_to_identifier_name</span>
  88. = <span class="var-default"> 'openid1_claimed_id'</span> (line <span class="line-number">594</span>)
  89. </span>
  90. </div>
  91. <!-- ========== Info from phpDoc block ========= -->
  92. <p class="short-description">Another query parameter that gets added to the return_to for OpenID 1; if the user's session state is lost, use this claimed identifier to do discovery when verifying the response.</p>
  93. </div>
  94. <a name="var$store" id="$store"><!-- --></A>
  95. <div class="evenrow">
  96. <div class="var-header">
  97. <span class="var-title">
  98. <span class="var-type">mixed</span>
  99. <span class="var-name">$store</span>
  100. (line <span class="line-number">577</span>)
  101. </span>
  102. </div>
  103. <!-- ========== Info from phpDoc block ========= -->
  104. <p class="short-description">This consumer's store object.</p>
  105. </div>
  106. </div>
  107. </div>
  108. <a name="sec-methods"></a>
  109. <div class="info-box">
  110. <div class="info-box-title">Methods</div>
  111. <div class="nav-bar">
  112. <a href="#sec-description">Description</a> |
  113. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  114. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  115. </div>
  116. <div class="info-box-body">
  117. <A NAME='method_detail'></A>
  118. <a name="methodAuth_OpenID_GenericConsumer" id="Auth_OpenID_GenericConsumer"><!-- --></a>
  119. <div class="oddrow">
  120. <div class="method-header">
  121. <span class="method-title">Constructor Auth_OpenID_GenericConsumer</span> (line <span class="line-number">614</span>)
  122. </div>
  123. <!-- ========== Info from phpDoc block ========= -->
  124. <p class="short-description">This method initializes a new <a href="../OpenID/Auth_OpenID_Consumer.html">Auth_OpenID_Consumer</a> instance to access the library.</p>
  125. <div class="method-signature">
  126. <span class="method-result">Auth_OpenID_GenericConsumer</span>
  127. <span class="method-name">
  128. Auth_OpenID_GenericConsumer
  129. </span>
  130. (<span class="var-type"></span>&nbsp;<span class="var-name">&$store</span>, <span class="var-type"><a href="../OpenID/Auth_OpenID_OpenIDStore.html">Auth_OpenID_OpenIDStore</a></span>&nbsp;<span class="var-name">$store</span>, <span class="var-type">bool</span>&nbsp;<span class="var-name">$immediate</span>)
  131. </div>
  132. <ul class="parameters">
  133. <li>
  134. <span class="var-type"><a href="../OpenID/Auth_OpenID_OpenIDStore.html">Auth_OpenID_OpenIDStore</a></span>
  135. <span class="var-name">$store</span><span class="var-description">: This must be an object that implements the interface in <a href="../OpenID/Auth_OpenID_OpenIDStore.html">Auth_OpenID_OpenIDStore</a>. Several concrete implementations are provided, to cover most common use cases. For stores backed by MySQL, PostgreSQL, or SQLite, see the <a href="../OpenID/Auth_OpenID_SQLStore.html">Auth_OpenID_SQLStore</a> class and its sublcasses. For a filesystem-backed store, see the <a href="../OpenID/Auth_OpenID_FileStore.html">Auth_OpenID_FileStore</a> module. As a last resort, if it isn't possible for the server to store state at all, an instance of <a href="../OpenID/Auth_OpenID_DumbStore.html">Auth_OpenID_DumbStore</a> can be used.</span> </li>
  136. <li>
  137. <span class="var-type">bool</span>
  138. <span class="var-name">$immediate</span><span class="var-description">: This is an optional boolean value. It controls whether the library uses immediate mode, as explained in the module description. The default value is False, which disables immediate mode.</span> </li>
  139. <li>
  140. <span class="var-type"></span>
  141. <span class="var-name">&$store</span> </li>
  142. </ul>
  143. </div>
  144. </div>
  145. </div>
  146. <p class="notes" id="credit">
  147. 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>
  148. </p>
  149. </div></body>
  150. </html>