PageRenderTime 59ms CodeModel.GetById 26ms RepoModel.GetById 0ms app.codeStats 0ms

/phpids-0.6.5/docs/phpdocumentor/PHPIDS/IDS_Caching_Memcached.html

https://github.com/xrayn/phpips
HTML | 243 lines | 196 code | 41 blank | 6 comment | 0 complexity | df7b4617518fc9675498b11877dd90df MD5 | raw file
  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 IDS_Caching_Memcached</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 IDS_Caching_Memcached</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. <p class="implements">
  22. Implements interfaces:
  23. <ul>
  24. <li><a href="../PHPIDS/IDS_Caching_Interface.html">IDS_Caching_Interface</a></li> </ul>
  25. </p>
  26. <!-- ========== Info from phpDoc block ========= -->
  27. <p class="short-description">File caching wrapper</p>
  28. <p class="description"><p>This class inhabits functionality to get and set cache via memcached.</p></p>
  29. <ul class="tags">
  30. <li><span class="field">author:</span> Lars Strojny &lt;<a href="mailto:lars@strojny.net">lars@strojny.net</a>&gt;</li>
  31. <li><span class="field">author:</span> Christian Matthies &lt;<a href="mailto:ch0012@gmail.com">ch0012@gmail.com</a>&gt;</li>
  32. <li><span class="field">author:</span> Mario Heiderich &lt;<a href="mailto:mario.heiderich@gmail.com">mario.heiderich@gmail.com</a>&gt;</li>
  33. <li><span class="field">version:</span> Release: $Id:Memcached.php 517 2007-09-15 15:04:13Z mario $</li>
  34. <li><span class="field">copyright:</span> 2007 The PHPIDS Groupoup</li>
  35. <li><span class="field">link:</span> <a href="http://php-ids.org/">http://php-ids.org/</a></li>
  36. <li><span class="field">since:</span> Version 0.4</li>
  37. <li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/lgpl.html">LGPL</a></li>
  38. </ul>
  39. <p class="notes">
  40. Located in <a class="field" href="_Caching---Memcached.php.html">/Caching/Memcached.php</a> (line <span class="field">52</span>)
  41. </p>
  42. <pre></pre>
  43. </div>
  44. </div>
  45. <a name="sec-method-summary"></a>
  46. <div class="info-box">
  47. <div class="info-box-title">Method Summary</span></div>
  48. <div class="nav-bar">
  49. <a href="#sec-description">Description</a> |
  50. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  51. </div>
  52. <div class="info-box-body">
  53. <div class="method-summary">
  54. <div class="method-definition">
  55. static <span class="method-result">object</span>
  56. <a href="#getInstance" title="details" class="method-name">getInstance</a>
  57. (<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$init</span>)
  58. </div>
  59. <div class="method-definition">
  60. <span class="method-result">void</span>
  61. <a href="#__construct" title="details" class="method-name">__construct</a>
  62. (<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$init</span>)
  63. </div>
  64. <div class="method-definition">
  65. <span class="method-result">mixed</span>
  66. <a href="#getCache" title="details" class="method-name">getCache</a>
  67. ()
  68. </div>
  69. <div class="method-definition">
  70. <span class="method-result">object</span>
  71. <a href="#setCache" title="details" class="method-name">setCache</a>
  72. (<span class="var-type"></span>&nbsp;<span class="var-name">$data</span>)
  73. </div>
  74. </div>
  75. </div>
  76. </div>
  77. <a name="sec-methods"></a>
  78. <div class="info-box">
  79. <div class="info-box-title">Methods</div>
  80. <div class="nav-bar">
  81. <a href="#sec-description">Description</a> |
  82. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  83. </div>
  84. <div class="info-box-body">
  85. <A NAME='method_detail'></A>
  86. <a name="methodgetInstance" id="getInstance"><!-- --></a>
  87. <div class="oddrow">
  88. <div class="method-header">
  89. <span class="method-title">static method getInstance</span> (line <span class="line-number">124</span>)
  90. </div>
  91. <!-- ========== Info from phpDoc block ========= -->
  92. <p class="short-description">Returns an instance of this class</p>
  93. <ul class="tags">
  94. <li><span class="field">access:</span> public</li>
  95. </ul>
  96. <div class="method-signature">
  97. static
  98. <span class="method-result">object</span>
  99. <span class="method-name">
  100. getInstance
  101. </span>
  102. (<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$init</span>)
  103. </div>
  104. <ul class="parameters">
  105. <li>
  106. <span class="var-type">string</span>
  107. <span class="var-name">$type</span><span class="var-description">: caching type</span> </li>
  108. <li>
  109. <span class="var-type">array</span>
  110. <span class="var-name">$init</span><span class="var-description">: the IDS_Init object</span> </li>
  111. </ul>
  112. </div>
  113. <a name="method__construct" id="__construct"><!-- --></a>
  114. <div class="evenrow">
  115. <div class="method-header">
  116. <span class="method-title">Constructor __construct</span> (line <span class="line-number">100</span>)
  117. </div>
  118. <!-- ========== Info from phpDoc block ========= -->
  119. <p class="short-description">Constructor</p>
  120. <ul class="tags">
  121. <li><span class="field">throws:</span> Exception if necessary files aren't writeable</li>
  122. <li><span class="field">access:</span> public</li>
  123. </ul>
  124. <div class="method-signature">
  125. <span class="method-result">void</span>
  126. <span class="method-name">
  127. __construct
  128. </span>
  129. (<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$init</span>)
  130. </div>
  131. <ul class="parameters">
  132. <li>
  133. <span class="var-type">string</span>
  134. <span class="var-name">$type</span><span class="var-description">: caching type</span> </li>
  135. <li>
  136. <span class="var-type">array</span>
  137. <span class="var-name">$init</span><span class="var-description">: the IDS_Init object</span> </li>
  138. </ul>
  139. </div>
  140. <a name="methodgetCache" id="getCache"><!-- --></a>
  141. <div class="oddrow">
  142. <div class="method-header">
  143. <span class="method-title">getCache</span> (line <span class="line-number">172</span>)
  144. </div>
  145. <!-- ========== Info from phpDoc block ========= -->
  146. <p class="short-description">Returns the cached data</p>
  147. <p class="description"><p>Note that this method returns false if either type or file cache is not set</p></p>
  148. <ul class="tags">
  149. <li><span class="field">return:</span> cache data or false</li>
  150. <li><span class="field">access:</span> public</li>
  151. </ul>
  152. <div class="method-signature">
  153. <span class="method-result">mixed</span>
  154. <span class="method-name">
  155. getCache
  156. </span>
  157. ()
  158. </div>
  159. <hr class="separator" />
  160. <div class="notes">Implementation of:</div>
  161. <dl>
  162. <dt><a href="../PHPIDS/IDS_Caching_Interface.html#methodgetCache">IDS_Caching_Interface::getCache()</a></dt>
  163. <dd>Interface method</dd>
  164. </dl>
  165. </div>
  166. <a name="methodsetCache" id="setCache"><!-- --></a>
  167. <div class="evenrow">
  168. <div class="method-header">
  169. <span class="method-title">setCache</span> (line <span class="line-number">142</span>)
  170. </div>
  171. <!-- ========== Info from phpDoc block ========= -->
  172. <p class="short-description">Writes cache data</p>
  173. <ul class="tags">
  174. <li><span class="field">throws:</span> Exception if necessary files aren't writeable</li>
  175. <li><span class="field">access:</span> public</li>
  176. </ul>
  177. <div class="method-signature">
  178. <span class="method-result">object</span>
  179. <span class="method-name">
  180. setCache
  181. </span>
  182. (<span class="var-type"></span>&nbsp;<span class="var-name">$data</span>)
  183. </div>
  184. <ul class="parameters">
  185. <li>
  186. <span class="var-type">array</span>
  187. <span class="var-name">$data</span><span class="var-description">: the caching data</span> </li>
  188. </ul>
  189. <hr class="separator" />
  190. <div class="notes">Implementation of:</div>
  191. <dl>
  192. <dt><a href="../PHPIDS/IDS_Caching_Interface.html#methodsetCache">IDS_Caching_Interface::setCache()</a></dt>
  193. <dd>Interface method</dd>
  194. </dl>
  195. </div>
  196. </div>
  197. </div>
  198. <p class="notes" id="credit">
  199. Documentation generated on Mon, 22 Dec 2008 13:36:50 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
  200. </p>
  201. </div></body>
  202. </html>