Auth_Yadis_PHPSession.html 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203
  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_Yadis_PHPSession</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_Yadis_PHPSession</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">The base session class used by the Auth_Yadis_Manager. This class wraps the default PHP session machinery and should be subclassed if your application doesn't use PHP sessioning.</p>
  23. <p class="notes">
  24. Located in <a class="field" href="_Auth---Yadis---Manager.php.html">/Auth/Yadis/Manager.php</a> (line <span class="field">17</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">void</span>
  40. <a href="#contents" title="details" class="method-name">contents</a>
  41. ()
  42. </div>
  43. <div class="method-definition">
  44. <span class="method-result">void</span>
  45. <a href="#del" title="details" class="method-name">del</a>
  46. (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
  47. </div>
  48. <div class="method-definition">
  49. <span class="method-result">string</span>
  50. <a href="#get" title="details" class="method-name">get</a>
  51. (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$default</span> = <span class="var-default">null</span>])
  52. </div>
  53. <div class="method-definition">
  54. <span class="method-result">void</span>
  55. <a href="#set" title="details" class="method-name">set</a>
  56. (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
  57. </div>
  58. </div>
  59. </div>
  60. </div>
  61. <a name="sec-methods"></a>
  62. <div class="info-box">
  63. <div class="info-box-title">Methods</div>
  64. <div class="nav-bar">
  65. <a href="#sec-description">Description</a> |
  66. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  67. </div>
  68. <div class="info-box-body">
  69. <A NAME='method_detail'></A>
  70. <a name="methodcontents" id="contents"><!-- --></a>
  71. <div class="evenrow">
  72. <div class="method-header">
  73. <span class="method-title">contents</span> (line <span class="line-number">60</span>)
  74. </div>
  75. <!-- ========== Info from phpDoc block ========= -->
  76. <p class="short-description">Return the contents of the session in array form.</p>
  77. <div class="method-signature">
  78. <span class="method-result">void</span>
  79. <span class="method-name">
  80. contents
  81. </span>
  82. ()
  83. </div>
  84. </div>
  85. <a name="methoddel" id="del"><!-- --></a>
  86. <div class="oddrow">
  87. <div class="method-header">
  88. <span class="method-title">del</span> (line <span class="line-number">52</span>)
  89. </div>
  90. <!-- ========== Info from phpDoc block ========= -->
  91. <p class="short-description">Remove a key/value pair from the session.</p>
  92. <div class="method-signature">
  93. <span class="method-result">void</span>
  94. <span class="method-name">
  95. del
  96. </span>
  97. (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
  98. </div>
  99. <ul class="parameters">
  100. <li>
  101. <span class="var-type">string</span>
  102. <span class="var-name">$name</span><span class="var-description">: The name of the key to remove.</span> </li>
  103. </ul>
  104. </div>
  105. <a name="methodget" id="get"><!-- --></a>
  106. <div class="evenrow">
  107. <div class="method-header">
  108. <span class="method-title">get</span> (line <span class="line-number">38</span>)
  109. </div>
  110. <!-- ========== Info from phpDoc block ========= -->
  111. <p class="short-description">Get a key's value from the session.</p>
  112. <ul class="tags">
  113. <li><span class="field">return:</span> The key's value in the session or $default if it isn't found.</li>
  114. </ul>
  115. <div class="method-signature">
  116. <span class="method-result">string</span>
  117. <span class="method-name">
  118. get
  119. </span>
  120. (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$default</span> = <span class="var-default">null</span>])
  121. </div>
  122. <ul class="parameters">
  123. <li>
  124. <span class="var-type">string</span>
  125. <span class="var-name">$name</span><span class="var-description">: The name of the key to retrieve.</span> </li>
  126. <li>
  127. <span class="var-type">string</span>
  128. <span class="var-name">$default</span><span class="var-description">: The optional value to return if the key is not found in the session.</span> </li>
  129. </ul>
  130. </div>
  131. <a name="methodset" id="set"><!-- --></a>
  132. <div class="oddrow">
  133. <div class="method-header">
  134. <span class="method-title">set</span> (line <span class="line-number">24</span>)
  135. </div>
  136. <!-- ========== Info from phpDoc block ========= -->
  137. <p class="short-description">Set a session key/value pair.</p>
  138. <div class="method-signature">
  139. <span class="method-result">void</span>
  140. <span class="method-name">
  141. set
  142. </span>
  143. (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
  144. </div>
  145. <ul class="parameters">
  146. <li>
  147. <span class="var-type">string</span>
  148. <span class="var-name">$name</span><span class="var-description">: The name of the session key to add.</span> </li>
  149. <li>
  150. <span class="var-type">string</span>
  151. <span class="var-name">$value</span><span class="var-description">: The value to add to the session.</span> </li>
  152. </ul>
  153. </div>
  154. </div>
  155. </div>
  156. <p class="notes" id="credit">
  157. Documentation generated on Tue, 21 Apr 2009 11:31:31 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
  158. </p>
  159. </div></body>
  160. </html>