Auth_OpenID_Association.html 7.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
  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_Association</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_Association</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 association between a server and a consumer. In general, users of this library will never see instances of this object. The only exception is if you implement a custom <a href="../OpenID/Auth_OpenID_OpenIDStore.html">Auth_OpenID_OpenIDStore</a>.</p>
  23. <p class="description"><p>If you do implement such a store, it will need to store the values of the handle, secret, issued, lifetime, and assoc_type instance variables.</p></p>
  24. <p class="notes">
  25. Located in <a class="field" href="_Auth---OpenID---Association.php.html">/Auth/OpenID/Association.php</a> (line <span class="field">44</span>)
  26. </p>
  27. <pre></pre>
  28. </div>
  29. </div>
  30. <a name="sec-method-summary"></a>
  31. <div class="info-box">
  32. <div class="info-box-title">Method Summary</span></div>
  33. <div class="nav-bar">
  34. <a href="#sec-description">Description</a> |
  35. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  36. </div>
  37. <div class="info-box-body">
  38. <div class="method-summary">
  39. <div class="method-definition">
  40. <span class="method-result"><a href="../OpenID/Auth_OpenID_Association.html">Auth_OpenID_Association</a></span>
  41. <a href="#deserialize" title="details" class="method-name">deserialize</a>
  42. (<span class="var-type"></span>&nbsp;<span class="var-name">$class_name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$assoc_s</span>)
  43. </div>
  44. <div class="method-definition">
  45. <span class="method-result">bool</span>
  46. <a href="#equal" title="details" class="method-name">equal</a>
  47. (<span class="var-type"></span>&nbsp;<span class="var-name">$other</span>)
  48. </div>
  49. <div class="method-definition">
  50. <span class="method-result">integer</span>
  51. <a href="#getExpiresIn" title="details" class="method-name">getExpiresIn</a>
  52. ([<span class="var-type"></span>&nbsp;<span class="var-name">$now</span> = <span class="var-default">null</span>])
  53. </div>
  54. <div class="method-definition">
  55. <span class="method-result">string</span>
  56. <a href="#serialize" title="details" class="method-name">serialize</a>
  57. ()
  58. </div>
  59. </div>
  60. </div>
  61. </div>
  62. <a name="sec-methods"></a>
  63. <div class="info-box">
  64. <div class="info-box-title">Methods</div>
  65. <div class="nav-bar">
  66. <a href="#sec-description">Description</a> |
  67. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  68. </div>
  69. <div class="info-box-body">
  70. <A NAME='method_detail'></A>
  71. <a name="methoddeserialize" id="deserialize"><!-- --></a>
  72. <div class="evenrow">
  73. <div class="method-header">
  74. <span class="method-title">deserialize</span> (line <span class="line-number">209</span>)
  75. </div>
  76. <!-- ========== Info from phpDoc block ========= -->
  77. <p class="short-description">Parse an association as stored by serialize(). This is the inverse of serialize.</p>
  78. <ul class="tags">
  79. <li><span class="field">return:</span> instance of this class</li>
  80. </ul>
  81. <div class="method-signature">
  82. <span class="method-result"><a href="../OpenID/Auth_OpenID_Association.html">Auth_OpenID_Association</a></span>
  83. <span class="method-name">
  84. deserialize
  85. </span>
  86. (<span class="var-type"></span>&nbsp;<span class="var-name">$class_name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$assoc_s</span>)
  87. </div>
  88. <ul class="parameters">
  89. <li>
  90. <span class="var-type">string</span>
  91. <span class="var-name">$assoc_s</span><span class="var-description">: Association as serialized by serialize()</span> </li>
  92. <li>
  93. <span class="var-type"></span>
  94. <span class="var-name">$class_name</span> </li>
  95. </ul>
  96. </div>
  97. <a name="methodequal" id="equal"><!-- --></a>
  98. <div class="oddrow">
  99. <div class="method-header">
  100. <span class="method-title">equal</span> (line <span class="line-number">170</span>)
  101. </div>
  102. <!-- ========== Info from phpDoc block ========= -->
  103. <p class="short-description">This checks to see if two <a href="../OpenID/Auth_OpenID_Association.html">Auth_OpenID_Association</a> instances represent the same association.</p>
  104. <ul class="tags">
  105. <li><span class="field">return:</span> true if the two instances represent the same association, false otherwise.</li>
  106. </ul>
  107. <div class="method-signature">
  108. <span class="method-result">bool</span>
  109. <span class="method-name">
  110. equal
  111. </span>
  112. (<span class="var-type"></span>&nbsp;<span class="var-name">$other</span>)
  113. </div>
  114. <ul class="parameters">
  115. <li>
  116. <span class="var-type"></span>
  117. <span class="var-name">$other</span> </li>
  118. </ul>
  119. </div>
  120. <a name="methodgetExpiresIn" id="getExpiresIn"><!-- --></a>
  121. <div class="evenrow">
  122. <div class="method-header">
  123. <span class="method-title">getExpiresIn</span> (line <span class="line-number">154</span>)
  124. </div>
  125. <!-- ========== Info from phpDoc block ========= -->
  126. <p class="short-description">This returns the number of seconds this association is still valid for, or 0 if the association is no longer valid.</p>
  127. <ul class="tags">
  128. <li><span class="field">return:</span> The number of seconds this association is still valid for, or 0 if the association is no longer valid.</li>
  129. </ul>
  130. <div class="method-signature">
  131. <span class="method-result">integer</span>
  132. <span class="method-name">
  133. getExpiresIn
  134. </span>
  135. ([<span class="var-type"></span>&nbsp;<span class="var-name">$now</span> = <span class="var-default">null</span>])
  136. </div>
  137. <ul class="parameters">
  138. <li>
  139. <span class="var-type"></span>
  140. <span class="var-name">$now</span> </li>
  141. </ul>
  142. </div>
  143. <a name="methodserialize" id="serialize"><!-- --></a>
  144. <div class="oddrow">
  145. <div class="method-header">
  146. <span class="method-title">serialize</span> (line <span class="line-number">186</span>)
  147. </div>
  148. <!-- ========== Info from phpDoc block ========= -->
  149. <p class="short-description">Convert an association to KV form.</p>
  150. <ul class="tags">
  151. <li><span class="field">return:</span> String in KV form suitable for deserialization by deserialize.</li>
  152. </ul>
  153. <div class="method-signature">
  154. <span class="method-result">string</span>
  155. <span class="method-name">
  156. serialize
  157. </span>
  158. ()
  159. </div>
  160. </div>
  161. </div>
  162. </div>
  163. <p class="notes" id="credit">
  164. Documentation generated on Tue, 21 Apr 2009 11:31:28 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
  165. </p>
  166. </div></body>
  167. </html>