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

Конкурс дизайнеров на 15000 рублей
Автопокупка рекламы
Размер файла: 14.15Kb 
  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: Cache 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="#pub-attribs">Public Attributes</a> &#124;
  37. <a href="#pro-attribs">Protected Attributes</a> &#124;
  38. <a href="classCache-members.html">List of all members</a>  </div>
  39.   <div class="headertitle">
  40. <div class="title">Cache Class Reference</div>  </div>
  41. </div><!--header-->
  42. <div class="contents">
  43.  
  44. <p>Cache engine.  
  45.  <a href="classCache.html#details">More...</a></p>
  46. <div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  47.   <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for Cache:</div>
  48. <div id="dynsection-0-summary" class="dynsummary" style="display:block;">
  49. </div>
  50. <div id="dynsection-0-content" class="dyncontent" style="display:none;">
  51.  <div class="center">
  52.   <img src="classCache.png" usemap="#Cache_map" alt=""/>
  53.   <map id="Cache_map" name="Cache_map">
  54. <area href="classPrefab.html" title="Factory class for single-instance objects. " alt="Prefab" shape="rect" coords="0,0,50,24"/>
  55. </map>
  56.  </div></div>
  57. <table class="memberdecls">
  58. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  59. Public Member Functions</h2></td></tr>
  60. <tr class="memitem:ac8e1317d73d208d62bc15b4874b95e2a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCache.html#ac8e1317d73d208d62bc15b4874b95e2a">exists</a> ($key, &amp;$val=NULL)</td></tr>
  61. <tr class="separator:ac8e1317d73d208d62bc15b4874b95e2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62. <tr class="memitem:a2af7f347a97a8e8626408df44514dbee"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCache.html#a2af7f347a97a8e8626408df44514dbee">set</a> ($key, $val, $ttl=0)</td></tr>
  63. <tr class="separator:a2af7f347a97a8e8626408df44514dbee"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64. <tr class="memitem:ad25f006b5b60f18f23b3009ed18ce35b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCache.html#ad25f006b5b60f18f23b3009ed18ce35b">get</a> ($key)</td></tr>
  65. <tr class="separator:ad25f006b5b60f18f23b3009ed18ce35b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. <tr class="memitem:ad1e284b1bd8a1d927a9ad0c3591e25c4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCache.html#ad1e284b1bd8a1d927a9ad0c3591e25c4">clear</a> ($key)</td></tr>
  67. <tr class="separator:ad1e284b1bd8a1d927a9ad0c3591e25c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:a1075f1392063026ef20097e97bbbd621"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCache.html#a1075f1392063026ef20097e97bbbd621">reset</a> ($suffix=NULL, $lifetime=0)</td></tr>
  69. <tr class="separator:a1075f1392063026ef20097e97bbbd621"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:a8945c7c861557e851f252c24d92309a1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCache.html#a8945c7c861557e851f252c24d92309a1">load</a> ($dsn)</td></tr>
  71. <tr class="separator:a8945c7c861557e851f252c24d92309a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="memitem:a5dabe98b015fd4ff9ce2f1e24a2d458a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCache.html#a5dabe98b015fd4ff9ce2f1e24a2d458a">__construct</a> ($dsn=FALSE)</td></tr>
  73. <tr class="separator:a5dabe98b015fd4ff9ce2f1e24a2d458a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. </table><table class="memberdecls">
  75. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  76. Public Attributes</h2></td></tr>
  77. <tr class="memitem:a8d719294c5cd3df46da675a1cb3d0947"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8d719294c5cd3df46da675a1cb3d0947"></a>
  78. &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCache.html#a8d719294c5cd3df46da675a1cb3d0947">$prefix</a></td></tr>
  79. <tr class="memdesc:a8d719294c5cd3df46da675a1cb3d0947"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prefix for cache entries. <br/></td></tr>
  80. <tr class="separator:a8d719294c5cd3df46da675a1cb3d0947"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:aac8626c6d188a58f1220d74451fdb24f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aac8626c6d188a58f1220d74451fdb24f"></a>
  82. &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCache.html#aac8626c6d188a58f1220d74451fdb24f">$ref</a></td></tr>
  83. <tr class="memdesc:aac8626c6d188a58f1220d74451fdb24f"><td class="mdescLeft">&#160;</td><td class="mdescRight">MemCache or Redis object. <br/></td></tr>
  84. <tr class="separator:aac8626c6d188a58f1220d74451fdb24f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. </table><table class="memberdecls">
  86. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
  87. Protected Attributes</h2></td></tr>
  88. <tr class="memitem:ac021bf9bbe23e7c03af36c23bfc08010"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac021bf9bbe23e7c03af36c23bfc08010"></a>
  89. &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCache.html#ac021bf9bbe23e7c03af36c23bfc08010">$dsn</a></td></tr>
  90. <tr class="memdesc:ac021bf9bbe23e7c03af36c23bfc08010"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cache DSN. <br/></td></tr>
  91. <tr class="separator:ac021bf9bbe23e7c03af36c23bfc08010"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. </table><table class="memberdecls">
  93. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
  94. Additional Inherited Members</h2></td></tr>
  95. <tr class="inherit_header pub_static_methods_classPrefab"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classPrefab')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="classPrefab.html">Prefab</a></td></tr>
  96. <tr class="memitem:a459ac539bc012dbdb77abe0d0ebeba76 inherit pub_static_methods_classPrefab"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPrefab.html#a459ac539bc012dbdb77abe0d0ebeba76">instance</a> ()</td></tr>
  97. <tr class="separator:a459ac539bc012dbdb77abe0d0ebeba76 inherit pub_static_methods_classPrefab"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. </table>
  99. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  100. <div class="textblock"><p>Cache engine. </p>
  101. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  102. <a class="anchor" id="a5dabe98b015fd4ff9ce2f1e24a2d458a"></a>
  103. <div class="memitem">
  104. <div class="memproto">
  105.       <table class="memname">
  106.         <tr>
  107.           <td class="memname">Cache::__construct </td>
  108.           <td>(</td>
  109.           <td class="paramtype">&#160;</td>
  110.           <td class="paramname"><em>$dsn</em> = <code>FALSE</code></td><td>)</td>
  111.           <td></td>
  112.         </tr>
  113.       </table>
  114. </div><div class="memdoc">
  115. <p>Class constructor </p>
  116. <dl class="section return"><dt>Returns</dt><dd>object </dd></dl>
  117. <dl class="params"><dt>Parameters</dt><dd>
  118.   <table class="params">
  119.     <tr><td class="paramname">$dsn</td><td>bool|string </td></tr>
  120.   </table>
  121.   </dd>
  122. </dl>
  123.  
  124. </div>
  125. </div>
  126. <h2 class="groupheader">Member Function Documentation</h2>
  127. <a class="anchor" id="ad1e284b1bd8a1d927a9ad0c3591e25c4"></a>
  128. <div class="memitem">
  129. <div class="memproto">
  130.       <table class="memname">
  131.         <tr>
  132.           <td class="memname">Cache::clear </td>
  133.           <td>(</td>
  134.           <td class="paramtype">&#160;</td>
  135.           <td class="paramname"><em>$key</em></td><td>)</td>
  136.           <td></td>
  137.         </tr>
  138.       </table>
  139. </div><div class="memdoc">
  140. <p>Delete cache entry </p>
  141. <dl class="section return"><dt>Returns</dt><dd>bool </dd></dl>
  142. <dl class="params"><dt>Parameters</dt><dd>
  143.   <table class="params">
  144.     <tr><td class="paramname">$key</td><td>string </td></tr>
  145.   </table>
  146.   </dd>
  147. </dl>
  148.  
  149. </div>
  150. </div>
  151. <a class="anchor" id="ac8e1317d73d208d62bc15b4874b95e2a"></a>
  152. <div class="memitem">
  153. <div class="memproto">
  154.       <table class="memname">
  155.         <tr>
  156.           <td class="memname">Cache::exists </td>
  157.           <td>(</td>
  158.           <td class="paramtype">&#160;</td>
  159.           <td class="paramname"><em>$key</em>, </td>
  160.         </tr>
  161.         <tr>
  162.           <td class="paramkey"></td>
  163.           <td></td>
  164.           <td class="paramtype">&amp;&#160;</td>
  165.           <td class="paramname"><em>$val</em> = <code>NULL</code>&#160;</td>
  166.         </tr>
  167.         <tr>
  168.           <td></td>
  169.           <td>)</td>
  170.           <td></td><td></td>
  171.         </tr>
  172.       </table>
  173. </div><div class="memdoc">
  174. <p>Return timestamp and TTL of cache entry or FALSE if not found </p>
  175. <dl class="section return"><dt>Returns</dt><dd>array|FALSE </dd></dl>
  176. <dl class="params"><dt>Parameters</dt><dd>
  177.   <table class="params">
  178.     <tr><td class="paramname">$key</td><td>string </td></tr>
  179.     <tr><td class="paramname">$val</td><td>mixed </td></tr>
  180.   </table>
  181.   </dd>
  182. </dl>
  183.  
  184. </div>
  185. </div>
  186. <a class="anchor" id="ad25f006b5b60f18f23b3009ed18ce35b"></a>
  187. <div class="memitem">
  188. <div class="memproto">
  189.       <table class="memname">
  190.         <tr>
  191.           <td class="memname">Cache::get </td>
  192.           <td>(</td>
  193.           <td class="paramtype">&#160;</td>
  194.           <td class="paramname"><em>$key</em></td><td>)</td>
  195.           <td></td>
  196.         </tr>
  197.       </table>
  198. </div><div class="memdoc">
  199. <p>Retrieve value of cache entry </p>
  200. <dl class="section return"><dt>Returns</dt><dd>mixed|FALSE </dd></dl>
  201. <dl class="params"><dt>Parameters</dt><dd>
  202.   <table class="params">
  203.     <tr><td class="paramname">$key</td><td>string </td></tr>
  204.   </table>
  205.   </dd>
  206. </dl>
  207.  
  208. </div>
  209. </div>
  210. <a class="anchor" id="a8945c7c861557e851f252c24d92309a1"></a>
  211. <div class="memitem">
  212. <div class="memproto">
  213.       <table class="memname">
  214.         <tr>
  215.           <td class="memname">Cache::load </td>
  216.           <td>(</td>
  217.           <td class="paramtype">&#160;</td>
  218.           <td class="paramname"><em>$dsn</em></td><td>)</td>
  219.           <td></td>
  220.         </tr>
  221.       </table>
  222. </div><div class="memdoc">
  223. <p>Load/auto-detect cache backend </p>
  224. <dl class="section return"><dt>Returns</dt><dd>string </dd></dl>
  225. <dl class="params"><dt>Parameters</dt><dd>
  226.   <table class="params">
  227.     <tr><td class="paramname">$dsn</td><td>bool|string </td></tr>
  228.   </table>
  229.   </dd>
  230. </dl>
  231.  
  232. </div>
  233. </div>
  234. <a class="anchor" id="a1075f1392063026ef20097e97bbbd621"></a>
  235. <div class="memitem">
  236. <div class="memproto">
  237.       <table class="memname">
  238.         <tr>
  239.           <td class="memname">Cache::reset </td>
  240.           <td>(</td>
  241.           <td class="paramtype">&#160;</td>
  242.           <td class="paramname"><em>$suffix</em> = <code>NULL</code>, </td>
  243.         </tr>
  244.         <tr>
  245.           <td class="paramkey"></td>
  246.           <td></td>
  247.           <td class="paramtype">&#160;</td>
  248.           <td class="paramname"><em>$lifetime</em> = <code>0</code>&#160;</td>
  249.         </tr>
  250.         <tr>
  251.           <td></td>
  252.           <td>)</td>
  253.           <td></td><td></td>
  254.         </tr>
  255.       </table>
  256. </div><div class="memdoc">
  257. <p>Clear contents of cache backend </p>
  258. <dl class="section return"><dt>Returns</dt><dd>bool </dd></dl>
  259. <dl class="params"><dt>Parameters</dt><dd>
  260.   <table class="params">
  261.     <tr><td class="paramname">$suffix</td><td>string </td></tr>
  262.     <tr><td class="paramname">$lifetime</td><td>int </td></tr>
  263.   </table>
  264.   </dd>
  265. </dl>
  266.  
  267. </div>
  268. </div>
  269. <a class="anchor" id="a2af7f347a97a8e8626408df44514dbee"></a>
  270. <div class="memitem">
  271. <div class="memproto">
  272.       <table class="memname">
  273.         <tr>
  274.           <td class="memname">Cache::set </td>
  275.           <td>(</td>
  276.           <td class="paramtype">&#160;</td>
  277.           <td class="paramname"><em>$key</em>, </td>
  278.         </tr>
  279.         <tr>
  280.           <td class="paramkey"></td>
  281.           <td></td>
  282.           <td class="paramtype">&#160;</td>
  283.           <td class="paramname"><em>$val</em>, </td>
  284.         </tr>
  285.         <tr>
  286.           <td class="paramkey"></td>
  287.           <td></td>
  288.           <td class="paramtype">&#160;</td>
  289.           <td class="paramname"><em>$ttl</em> = <code>0</code>&#160;</td>
  290.         </tr>
  291.         <tr>
  292.           <td></td>
  293.           <td>)</td>
  294.           <td></td><td></td>
  295.         </tr>
  296.       </table>
  297. </div><div class="memdoc">
  298. <p>Store value in cache </p>
  299. <dl class="section return"><dt>Returns</dt><dd>mixed|FALSE </dd></dl>
  300. <dl class="params"><dt>Parameters</dt><dd>
  301.   <table class="params">
  302.     <tr><td class="paramname">$key</td><td>string </td></tr>
  303.     <tr><td class="paramname">$val</td><td>mixed </td></tr>
  304.     <tr><td class="paramname">$ttl</td><td>int </td></tr>
  305.   </table>
  306.   </dd>
  307. </dl>
  308.  
  309. </div>
  310. </div>
  311. <hr/>The documentation for this class was generated from the following file:<ul>
  312. <li>base.php</li>
  313. </ul>
  314. </div><!-- contents -->