Просмотр файла news/libraries/api/classSession.html

Конкурс дизайнеров на 15000 рублей
ADS LINK Рекламный сервис
Размер файла: 13.42Kb 
  1. <!-- HTML header for doxygen 1.8.5-->
  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. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  6. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  7. <meta name="generator" content="Doxygen 1.8.6"/>
  8. <title>Fat-Free Framework: Session Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  13. </head>
  14. <body>
  15. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16. <div id="titlearea">
  17. <table cellspacing="0" cellpadding="0">
  18.  <tbody>
  19.  <tr style="height: 56px;">
  20.   <td style="padding-left: 0.5em;">
  21.    <div id="projectname">Fat-Free Framework
  22.    &#160;<span id="projectnumber">3.2.2</span>
  23.    &#160;<span class="menu"><a href="index.html">Overview</a> <a href="annotated.html">Class List</a> <a href="hierarchy.html">Hierarchy</a></span>
  24.    </div>
  25.   </td>
  26.  </tr>
  27.  </tbody>
  28. </table>
  29. </div>
  30. <!-- end header part -->
  31. <!-- Generated by Doxygen 1.8.6 -->
  32. </div><!-- top -->
  33. <div class="header">
  34.   <div class="summary">
  35. <a href="#pub-methods">Public Member Functions</a> &#124;
  36. <a href="#pro-attribs">Protected Attributes</a> &#124;
  37. <a href="classSession-members.html">List of all members</a>  </div>
  38.   <div class="headertitle">
  39. <div class="title">Session Class Reference</div>  </div>
  40. </div><!--header-->
  41. <div class="contents">
  42.  
  43. <p>Cache-based session handler.  
  44.  <a href="classSession.html#details">More...</a></p>
  45. <table class="memberdecls">
  46. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  47. Public Member Functions</h2></td></tr>
  48. <tr class="memitem:ad2d5e0e045bc7a840a3fe81d74720e71"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSession.html#ad2d5e0e045bc7a840a3fe81d74720e71">open</a> ($path, $name)</td></tr>
  49. <tr class="separator:ad2d5e0e045bc7a840a3fe81d74720e71"><td class="memSeparator" colspan="2">&#160;</td></tr>
  50. <tr class="memitem:a36e9b941b6944020000d5e28d7f390f8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSession.html#a36e9b941b6944020000d5e28d7f390f8">close</a> ()</td></tr>
  51. <tr class="separator:a36e9b941b6944020000d5e28d7f390f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  52. <tr class="memitem:a3a45d45b017b282e438f91c113905442"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSession.html#a3a45d45b017b282e438f91c113905442">read</a> ($id)</td></tr>
  53. <tr class="separator:a3a45d45b017b282e438f91c113905442"><td class="memSeparator" colspan="2">&#160;</td></tr>
  54. <tr class="memitem:a5ee8f519be2a3018d95f031514ffd4bb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSession.html#a5ee8f519be2a3018d95f031514ffd4bb">write</a> ($id, $data)</td></tr>
  55. <tr class="separator:a5ee8f519be2a3018d95f031514ffd4bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  56. <tr class="memitem:a330c28fa28c94f5a64b912b2cab5d1c8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSession.html#a330c28fa28c94f5a64b912b2cab5d1c8">destroy</a> ($id)</td></tr>
  57. <tr class="separator:a330c28fa28c94f5a64b912b2cab5d1c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  58. <tr class="memitem:ad837635002a0bc1bef56208c940154a7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSession.html#ad837635002a0bc1bef56208c940154a7">cleanup</a> ($max)</td></tr>
  59. <tr class="separator:ad837635002a0bc1bef56208c940154a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  60. <tr class="memitem:a618050c97f93c7e4a77c6c731cd0bf23"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSession.html#a618050c97f93c7e4a77c6c731cd0bf23">csrf</a> ()</td></tr>
  61. <tr class="separator:a618050c97f93c7e4a77c6c731cd0bf23"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62. <tr class="memitem:a5a446bd12a9bdda3237930bcaa109fb2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSession.html#a5a446bd12a9bdda3237930bcaa109fb2">ip</a> ()</td></tr>
  63. <tr class="separator:a5a446bd12a9bdda3237930bcaa109fb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64. <tr class="memitem:a7f3be5dc562f7924df61113b30f07f17"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSession.html#a7f3be5dc562f7924df61113b30f07f17">stamp</a> ()</td></tr>
  65. <tr class="separator:a7f3be5dc562f7924df61113b30f07f17"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. <tr class="memitem:ac6807a612c0fc952cb52fbb80eb488f0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSession.html#ac6807a612c0fc952cb52fbb80eb488f0">agent</a> ()</td></tr>
  67. <tr class="separator:ac6807a612c0fc952cb52fbb80eb488f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:a36373ba15d6c8f932aeea02d7320d7c8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSession.html#a36373ba15d6c8f932aeea02d7320d7c8">__construct</a> ()</td></tr>
  69. <tr class="separator:a36373ba15d6c8f932aeea02d7320d7c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. </table><table class="memberdecls">
  71. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
  72. Protected Attributes</h2></td></tr>
  73. <tr class="memitem:a5f527ade4d348c3c809712715018ae1a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5f527ade4d348c3c809712715018ae1a"></a>
  74. &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSession.html#a5f527ade4d348c3c809712715018ae1a">$sid</a></td></tr>
  75. <tr class="memdesc:a5f527ade4d348c3c809712715018ae1a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Session ID. <br/></td></tr>
  76. <tr class="separator:a5f527ade4d348c3c809712715018ae1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. </table>
  78. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  79. <div class="textblock"><p>Cache-based session handler. </p>
  80. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  81. <a class="anchor" id="a36373ba15d6c8f932aeea02d7320d7c8"></a>
  82. <div class="memitem">
  83. <div class="memproto">
  84.       <table class="memname">
  85.         <tr>
  86.           <td class="memname">Session::__construct </td>
  87.           <td>(</td>
  88.           <td class="paramname"></td><td>)</td>
  89.           <td></td>
  90.         </tr>
  91.       </table>
  92. </div><div class="memdoc">
  93. <p>Instantiate class </p>
  94. <dl class="section return"><dt>Returns</dt><dd>object </dd></dl>
  95.  
  96. </div>
  97. </div>
  98. <h2 class="groupheader">Member Function Documentation</h2>
  99. <a class="anchor" id="ac6807a612c0fc952cb52fbb80eb488f0"></a>
  100. <div class="memitem">
  101. <div class="memproto">
  102.       <table class="memname">
  103.         <tr>
  104.           <td class="memname">Session::agent </td>
  105.           <td>(</td>
  106.           <td class="paramname"></td><td>)</td>
  107.           <td></td>
  108.         </tr>
  109.       </table>
  110. </div><div class="memdoc">
  111. <p>Return HTTP user agent </p>
  112. <dl class="section return"><dt>Returns</dt><dd>string|FALSE </dd></dl>
  113.  
  114. </div>
  115. </div>
  116. <a class="anchor" id="ad837635002a0bc1bef56208c940154a7"></a>
  117. <div class="memitem">
  118. <div class="memproto">
  119.       <table class="memname">
  120.         <tr>
  121.           <td class="memname">Session::cleanup </td>
  122.           <td>(</td>
  123.           <td class="paramtype">&#160;</td>
  124.           <td class="paramname"><em>$max</em></td><td>)</td>
  125.           <td></td>
  126.         </tr>
  127.       </table>
  128. </div><div class="memdoc">
  129. <p>Garbage collector </p>
  130. <dl class="section return"><dt>Returns</dt><dd>TRUE </dd></dl>
  131. <dl class="params"><dt>Parameters</dt><dd>
  132.   <table class="params">
  133.     <tr><td class="paramname">$max</td><td>int </td></tr>
  134.   </table>
  135.   </dd>
  136. </dl>
  137.  
  138. </div>
  139. </div>
  140. <a class="anchor" id="a36e9b941b6944020000d5e28d7f390f8"></a>
  141. <div class="memitem">
  142. <div class="memproto">
  143.       <table class="memname">
  144.         <tr>
  145.           <td class="memname">Session::close </td>
  146.           <td>(</td>
  147.           <td class="paramname"></td><td>)</td>
  148.           <td></td>
  149.         </tr>
  150.       </table>
  151. </div><div class="memdoc">
  152. <p>Close session </p>
  153. <dl class="section return"><dt>Returns</dt><dd>TRUE </dd></dl>
  154.  
  155. </div>
  156. </div>
  157. <a class="anchor" id="a618050c97f93c7e4a77c6c731cd0bf23"></a>
  158. <div class="memitem">
  159. <div class="memproto">
  160.       <table class="memname">
  161.         <tr>
  162.           <td class="memname">Session::csrf </td>
  163.           <td>(</td>
  164.           <td class="paramname"></td><td>)</td>
  165.           <td></td>
  166.         </tr>
  167.       </table>
  168. </div><div class="memdoc">
  169. <p>Return anti-CSRF token </p>
  170. <dl class="section return"><dt>Returns</dt><dd>string|FALSE </dd></dl>
  171.  
  172. </div>
  173. </div>
  174. <a class="anchor" id="a330c28fa28c94f5a64b912b2cab5d1c8"></a>
  175. <div class="memitem">
  176. <div class="memproto">
  177.       <table class="memname">
  178.         <tr>
  179.           <td class="memname">Session::destroy </td>
  180.           <td>(</td>
  181.           <td class="paramtype">&#160;</td>
  182.           <td class="paramname"><em>$id</em></td><td>)</td>
  183.           <td></td>
  184.         </tr>
  185.       </table>
  186. </div><div class="memdoc">
  187. <p>Destroy session </p>
  188. <dl class="section return"><dt>Returns</dt><dd>TRUE </dd></dl>
  189. <dl class="params"><dt>Parameters</dt><dd>
  190.   <table class="params">
  191.     <tr><td class="paramname">$id</td><td>string </td></tr>
  192.   </table>
  193.   </dd>
  194. </dl>
  195.  
  196. </div>
  197. </div>
  198. <a class="anchor" id="a5a446bd12a9bdda3237930bcaa109fb2"></a>
  199. <div class="memitem">
  200. <div class="memproto">
  201.       <table class="memname">
  202.         <tr>
  203.           <td class="memname">Session::ip </td>
  204.           <td>(</td>
  205.           <td class="paramname"></td><td>)</td>
  206.           <td></td>
  207.         </tr>
  208.       </table>
  209. </div><div class="memdoc">
  210. <p>Return IP address </p>
  211. <dl class="section return"><dt>Returns</dt><dd>string|FALSE </dd></dl>
  212.  
  213. </div>
  214. </div>
  215. <a class="anchor" id="ad2d5e0e045bc7a840a3fe81d74720e71"></a>
  216. <div class="memitem">
  217. <div class="memproto">
  218.       <table class="memname">
  219.         <tr>
  220.           <td class="memname">Session::open </td>
  221.           <td>(</td>
  222.           <td class="paramtype">&#160;</td>
  223.           <td class="paramname"><em>$path</em>, </td>
  224.         </tr>
  225.         <tr>
  226.           <td class="paramkey"></td>
  227.           <td></td>
  228.           <td class="paramtype">&#160;</td>
  229.           <td class="paramname"><em>$name</em>&#160;</td>
  230.         </tr>
  231.         <tr>
  232.           <td></td>
  233.           <td>)</td>
  234.           <td></td><td></td>
  235.         </tr>
  236.       </table>
  237. </div><div class="memdoc">
  238. <p>Open session </p>
  239. <dl class="section return"><dt>Returns</dt><dd>TRUE </dd></dl>
  240. <dl class="params"><dt>Parameters</dt><dd>
  241.   <table class="params">
  242.     <tr><td class="paramname">$path</td><td>string </td></tr>
  243.     <tr><td class="paramname">$name</td><td>string </td></tr>
  244.   </table>
  245.   </dd>
  246. </dl>
  247.  
  248. </div>
  249. </div>
  250. <a class="anchor" id="a3a45d45b017b282e438f91c113905442"></a>
  251. <div class="memitem">
  252. <div class="memproto">
  253.       <table class="memname">
  254.         <tr>
  255.           <td class="memname">Session::read </td>
  256.           <td>(</td>
  257.           <td class="paramtype">&#160;</td>
  258.           <td class="paramname"><em>$id</em></td><td>)</td>
  259.           <td></td>
  260.         </tr>
  261.       </table>
  262. </div><div class="memdoc">
  263. <p>Return session data in serialized format </p>
  264. <dl class="section return"><dt>Returns</dt><dd>string|FALSE </dd></dl>
  265. <dl class="params"><dt>Parameters</dt><dd>
  266.   <table class="params">
  267.     <tr><td class="paramname">$id</td><td>string </td></tr>
  268.   </table>
  269.   </dd>
  270. </dl>
  271.  
  272. </div>
  273. </div>
  274. <a class="anchor" id="a7f3be5dc562f7924df61113b30f07f17"></a>
  275. <div class="memitem">
  276. <div class="memproto">
  277.       <table class="memname">
  278.         <tr>
  279.           <td class="memname">Session::stamp </td>
  280.           <td>(</td>
  281.           <td class="paramname"></td><td>)</td>
  282.           <td></td>
  283.         </tr>
  284.       </table>
  285. </div><div class="memdoc">
  286. <p>Return Unix timestamp </p>
  287. <dl class="section return"><dt>Returns</dt><dd>string|FALSE </dd></dl>
  288.  
  289. </div>
  290. </div>
  291. <a class="anchor" id="a5ee8f519be2a3018d95f031514ffd4bb"></a>
  292. <div class="memitem">
  293. <div class="memproto">
  294.       <table class="memname">
  295.         <tr>
  296.           <td class="memname">Session::write </td>
  297.           <td>(</td>
  298.           <td class="paramtype">&#160;</td>
  299.           <td class="paramname"><em>$id</em>, </td>
  300.         </tr>
  301.         <tr>
  302.           <td class="paramkey"></td>
  303.           <td></td>
  304.           <td class="paramtype">&#160;</td>
  305.           <td class="paramname"><em>$data</em>&#160;</td>
  306.         </tr>
  307.         <tr>
  308.           <td></td>
  309.           <td>)</td>
  310.           <td></td><td></td>
  311.         </tr>
  312.       </table>
  313. </div><div class="memdoc">
  314. <p>Write session data </p>
  315. <dl class="section return"><dt>Returns</dt><dd>TRUE </dd></dl>
  316. <dl class="params"><dt>Parameters</dt><dd>
  317.   <table class="params">
  318.     <tr><td class="paramname">$id</td><td>string </td></tr>
  319.     <tr><td class="paramname">$data</td><td>string </td></tr>
  320.   </table>
  321.   </dd>
  322. </dl>
  323.  
  324. </div>
  325. </div>
  326. <hr/>The documentation for this class was generated from the following file:<ul>
  327. <li>session.php</li>
  328. </ul>
  329. </div><!-- contents -->