OSS_SNMP.Cache.APC.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196
  1. <!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  4. <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
  5. <meta charset="utf-8">
  6. <title>OSS_SNMP » \OSS_SNMP\Cache\APC</title>
  7. <meta name="author" content="Mike van Riel">
  8. <meta name="description" content="">
  9. <link href="../css/template.css" rel="stylesheet" media="all">
  10. <script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
  11. <link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
  12. <link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
  13. <link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
  14. </head>
  15. <body>
  16. <div class="navbar navbar-fixed-top">
  17. <div class="navbar-inner"><div class="container">
  18. <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">OSS_SNMP</a><div class="nav-collapse"><ul class="nav">
  19. <li class="dropdown">
  20. <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
  21. API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
  22. <li><a>Namespaces</a></li>
  23. <li><a href="../namespaces/OSS.html"><i class="icon-th"></i> OSS</a></li>
  24. <li><a href="../namespaces/OSS_SNMP.html"><i class="icon-th"></i> OSS_SNMP</a></li>
  25. </ul>
  26. </li>
  27. <li class="dropdown" id="charts-menu">
  28. <a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
  29. Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
  30. </li>
  31. <li class="dropdown" id="reports-menu">
  32. <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
  33. Reports <b class="caret"></b></a><ul class="dropdown-menu">
  34. <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
  35. <span class="label label-info">32</span></a></li>
  36. <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
  37. <ul><li>todo 
  38. <span class="label label-info">1</span>
  39. </li></ul></a></li>
  40. <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
  41. <span class="label label-info">0</span></a></li>
  42. </ul>
  43. </li>
  44. </ul></div>
  45. </div></div>
  46. <div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
  47. </div>
  48. <div id="___" class="container">
  49. <noscript><div class="alert alert-warning">
  50. Javascript is disabled; several features are only available
  51. if Javascript is enabled.
  52. </div></noscript>
  53. <div class="row">
  54. <div class="span4">
  55. <span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
  56. <button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
  57. </div>
  58. <ul class="side-nav nav nav-list">
  59. <li class="nav-header">
  60. <i class="icon-custom icon-method"></i> Methods</li>
  61. <li class="method public "><a href="#__construct" title="__construct :: Cache constructor."><span class="description">Cache constructor.</span><pre>__construct()</pre></a></li>
  62. <li class="method public "><a href="#clear" title="clear :: Clear a named value from the cache"><span class="description">Clear a named value from the cache</span><pre>clear()</pre></a></li>
  63. <li class="method public "><a href="#clearAll" title="clearAll :: Clear all values from the cache"><span class="description">Clear all values from the cache</span><pre>clearAll()</pre></a></li>
  64. <li class="method public "><a href="#load" title="load :: Load a named value from the cache (or null if not present)"><span class="description">Load a named value from the cache (or null if not present)</span><pre>load()</pre></a></li>
  65. <li class="method public "><a href="#save" title="save :: Save a named value to the cache"><span class="description">Save a named value to the cache</span><pre>save()</pre></a></li>
  66. <li class="nav-header">
  67. <i class="icon-custom icon-property"></i> Properties</li>
  68. <li class="nav-header protected">» Protected</li>
  69. <li class="property protected "><a href="#%24_prefix" title="$_prefix :: "><span class="description">$_prefix</span><pre>$_prefix</pre></a></li>
  70. <li class="property protected "><a href="#%24_ttl" title="$_ttl :: "><span class="description">$_ttl</span><pre>$_ttl</pre></a></li>
  71. </ul>
  72. </div>
  73. <div class="span8">
  74. <a name="%5COSS_SNMP%5CCache%5CAPC" id="\OSS_SNMP\Cache\APC"></a><ul class="breadcrumb">
  75. <li>
  76. <a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
  77. </li>
  78. <li><a href="../namespaces/OSS_SNMP.html">OSS_SNMP</a></li>
  79. <span class="divider">\</span><li><a href="../namespaces/OSS_SNMP.Cache.html">Cache</a></li>
  80. <li class="active">
  81. <span class="divider">\</span><a href="../classes/OSS_SNMP.Cache.APC.html">APC</a>
  82. </li>
  83. </ul>
  84. <div href="../classes/OSS_SNMP.Cache.APC.html" class="element class">
  85. <p class="short_description">APC cache implementation</p>
  86. <div class="details">
  87. <p class="long_description"></p>
  88. <table class="table table-bordered">
  89. <tr>
  90. <th>copyright</th>
  91. <td>Copyright (c) 2012, Open Source Solutions Limited, Dublin, Ireland</td>
  92. </tr>
  93. <tr>
  94. <th>author</th>
  95. <td><a href="mailto:barry@opensolutions.ie">Barry O'Donovan</a></td>
  96. </tr>
  97. </table>
  98. <h3>
  99. <i class="icon-custom icon-method"></i> Methods</h3>
  100. <a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
  101. <h2>Cache constructor.</h2>
  102. <pre>__construct(int $ttl, string $prefix) : <a href="../classes/OSS_SNMP.Cache.Basic.html">\OSS_SNMP\Cache\Basic</a></pre>
  103. <div class="labels"></div>
  104. <div class="row collapse"><div class="detail-description">
  105. <p class="long_description"><p>For basic cache, takes no parameters.</p></p>
  106. <h3>Parameters</h3>
  107. <div class="subelement argument">
  108. <h4>$ttl</h4>
  109. <code>int</code><p>Set the default ttl</p></div>
  110. <div class="subelement argument">
  111. <h4>$prefix</h4>
  112. <code>string</code><p>Set the default prefix for caching variable names</p></div>
  113. <h3>Returns</h3>
  114. <div class="subelement response">
  115. <code><a href="../classes/OSS_SNMP.Cache.Basic.html">\OSS_SNMP\Cache\Basic</a></code>An instance of the cache ($this) for fluent interfaces</div>
  116. </div></div>
  117. </div>
  118. <a name="clear" id="clear"></a><div class="element clickable method public clear" data-toggle="collapse" data-target=".clear .collapse">
  119. <h2>Clear a named value from the cache</h2>
  120. <pre>clear(string $var) </pre>
  121. <div class="labels"></div>
  122. <div class="row collapse"><div class="detail-description">
  123. <p class="long_description"></p>
  124. <h3>Parameters</h3>
  125. <div class="subelement argument">
  126. <h4>$var</h4>
  127. <code>string</code><p>The name of the value to clear</p></div>
  128. </div></div>
  129. </div>
  130. <a name="clearAll" id="clearAll"></a><div class="element clickable method public clearAll" data-toggle="collapse" data-target=".clearAll .collapse">
  131. <h2>Clear all values from the cache</h2>
  132. <pre>clearAll() </pre>
  133. <div class="labels"></div>
  134. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  135. </div>
  136. <a name="load" id="load"></a><div class="element clickable method public load" data-toggle="collapse" data-target=".load .collapse">
  137. <h2>Load a named value from the cache (or null if not present)</h2>
  138. <pre>load(string $var) : mixed | null</pre>
  139. <div class="labels"></div>
  140. <div class="row collapse"><div class="detail-description">
  141. <p class="long_description"></p>
  142. <h3>Parameters</h3>
  143. <div class="subelement argument">
  144. <h4>$var</h4>
  145. <code>string</code><p>The name of the value to load</p></div>
  146. <h3>Returns</h3>
  147. <div class="subelement response">
  148. <code>mixed</code><code>null</code>The value from the cache or null</div>
  149. </div></div>
  150. </div>
  151. <a name="save" id="save"></a><div class="element clickable method public save" data-toggle="collapse" data-target=".save .collapse">
  152. <h2>Save a named value to the cache</h2>
  153. <pre>save(string $var, mixed $val, int $ttl) : mixed</pre>
  154. <div class="labels"></div>
  155. <div class="row collapse"><div class="detail-description">
  156. <p class="long_description"></p>
  157. <h3>Parameters</h3>
  158. <div class="subelement argument">
  159. <h4>$var</h4>
  160. <code>string</code><p>The name of the value to save</p></div>
  161. <div class="subelement argument">
  162. <h4>$val</h4>
  163. <code>mixed</code><p>The value to save</p></div>
  164. <div class="subelement argument">
  165. <h4>$ttl</h4>
  166. <code>int</code><p>The time to live of the variable if you want to override the default</p></div>
  167. <h3>Returns</h3>
  168. <div class="subelement response">
  169. <code>mixed</code>The value (as passed)</div>
  170. </div></div>
  171. </div>
  172. <h3>
  173. <i class="icon-custom icon-property"></i> Properties</h3>
  174. <a name="%24_prefix" id="$_prefix"> </a><div class="element clickable property protected $_prefix" data-toggle="collapse" data-target=".$_prefix .collapse">
  175. <h2>$_prefix</h2>
  176. <pre>$_prefix </pre>
  177. <div class="labels"></div>
  178. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  179. </div>
  180. <a name="%24_ttl" id="$_ttl"> </a><div class="element clickable property protected $_ttl" data-toggle="collapse" data-target=".$_ttl .collapse">
  181. <h2>$_ttl</h2>
  182. <pre>$_ttl </pre>
  183. <div class="labels"></div>
  184. <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
  185. </div>
  186. </div>
  187. </div>
  188. </div>
  189. </div>
  190. <div class="row"><footer class="span12">
  191. Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
  192. Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a5</a> and<br>
  193. generated on 2012-06-20T19:41:09+01:00.<br></footer></div>
  194. </div>
  195. </body>
  196. </html>