PageRenderTime 48ms CodeModel.GetById 36ms 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. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3.   <html xmlns="http://www.w3.org/1999/xhtml">
    4. 

  4. 		<head>
    5. 

  5. 			<!-- template designed by Marco Von Ballmoos -->
    6. 

  6. 			<title>Docs For Class IDS_Caching_Memcached</title>
    7. 

  7. 			<link rel="stylesheet" href="../media/stylesheet.css" />
    8. 

  8. 			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
    9. 

  9. 		</head>
    10. 

  10. 		<body>
    11. 

  11. 			<div class="page-body">			
    12. 

  12. <h2 class="class-name">Class IDS_Caching_Memcached</h2>
    13. 

  13. 

  14. <a name="sec-description"></a>
    15. 

  15. <div class="info-box">
    16. 

  16. 	<div class="info-box-title">Description</div>
    17. 

  17. 	<div class="nav-bar">
    18. 

  18. 					<span class="disabled">Description</span> |
    19. 

  19. 															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
    20. 

  20. 						
    21. 

  21. 					</div>
    22. 

  22. 	<div class="info-box-body">
    23. 

  23.                 <p class="implements">
    24. 

  24.             Implements interfaces:
    25. 

  25.             <ul>
    26. 

  26.                 <li><a href="../PHPIDS/IDS_Caching_Interface.html">IDS_Caching_Interface</a></li>            </ul>
    27. 

  27.         </p>
    28. 

  28.         		<!-- ========== Info from phpDoc block ========= -->
    29. 

  29. <p class="short-description">File caching wrapper</p>
    30. 

  30. <p class="description"><p>This class inhabits functionality to get and set cache via memcached.</p></p>
    31. 

  31. 	<ul class="tags">
    32. 

  32. 				<li><span class="field">author:</span> Lars Strojny &lt;<a href="mailto:lars@strojny.net">lars@strojny.net</a>&gt;</li>
    33. 

  33. 				<li><span class="field">author:</span> Christian Matthies &lt;<a href="mailto:ch0012@gmail.com">ch0012@gmail.com</a>&gt;</li>
    34. 

  34. 				<li><span class="field">author:</span> Mario Heiderich &lt;<a href="mailto:mario.heiderich@gmail.com">mario.heiderich@gmail.com</a>&gt;</li>
    35. 

  35. 				<li><span class="field">version:</span> Release: $Id:Memcached.php 517 2007-09-15 15:04:13Z mario $</li>
    36. 

  36. 				<li><span class="field">copyright:</span> 2007 The PHPIDS Groupoup</li>
    37. 

  37. 				<li><span class="field">link:</span> <a href="http://php-ids.org/">http://php-ids.org/</a></li>
    38. 

  38. 				<li><span class="field">since:</span> Version 0.4</li>
    39. 

  39. 				<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/lgpl.html">LGPL</a></li>
    40. 

  40. 			</ul>
    41. 

  41. 		<p class="notes">
    42. 

  42. 			Located in <a class="field" href="_Caching---Memcached.php.html">/Caching/Memcached.php</a> (line <span class="field">52</span>)
    43. 

  43. 		</p>
    44. 

  44. 		
    45. 

  45. 				
    46. 

  46. 		<pre></pre>
    47. 

  47. 	
    48. 

  48. 			</div>
    49. 

  49. </div>
    50. 

  50. 

  51. 

  52. 

  53. 

  54. 	<a name="sec-method-summary"></a>
    55. 

  55. 	<div class="info-box">
    56. 

  56. 		<div class="info-box-title">Method Summary</span></div>
    57. 

  57. 		<div class="nav-bar">
    58. 

  58. 			<a href="#sec-description">Description</a> |
    59. 

  59. 												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
    60. 

  60. 		</div>
    61. 

  61. 		<div class="info-box-body">			
    62. 

  62. 			<div class="method-summary">
    63. 

  63. 																												<div class="method-definition">
    64. 

  64. 					static 						<span class="method-result">object</span>
    65. 

  65. 										<a href="#getInstance" title="details" class="method-name">getInstance</a>
    66. 

  66. 											(<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>)
    67. 

  67. 									</div>
    68. 

  68. 																
    69. 

  69. 												<div class="method-definition">
    70. 

  70. 											<span class="method-result">void</span>
    71. 

  71. 										<a href="#__construct" title="details" class="method-name">__construct</a>
    72. 

  72. 											(<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>)
    73. 

  73. 									</div>
    74. 

  74. 																<div class="method-definition">
    75. 

  75. 											<span class="method-result">mixed</span>
    76. 

  76. 										<a href="#getCache" title="details" class="method-name">getCache</a>
    77. 

  77. 										()
    78. 

  78. 									</div>
    79. 

  79. 																								<div class="method-definition">
    80. 

  80. 											<span class="method-result">object</span>
    81. 

  81. 										<a href="#setCache" title="details" class="method-name">setCache</a>
    82. 

  82. 											(<span class="var-type"></span>&nbsp;<span class="var-name">$data</span>)
    83. 

  83. 									</div>
    84. 

  84. 								</div>
    85. 

  85. 		</div>
    86. 

  86. 	</div>		
    87. 

  87. 

  88. 	
    89. 

  89. 	<a name="sec-methods"></a>
    90. 

  90. 	<div class="info-box">
    91. 

  91. 		<div class="info-box-title">Methods</div>
    92. 

  92. 		<div class="nav-bar">
    93. 

  93. 			<a href="#sec-description">Description</a> |
    94. 

  94. 																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
    95. 

  95. 						
    96. 

  96. 		</div>
    97. 

  97. 		<div class="info-box-body">
    98. 

  98. 			<A NAME='method_detail'></A>
    99. 

  99. <a name="methodgetInstance" id="getInstance"><!-- --></a>
    100. 

  100. <div class="oddrow">
    101. 

  101. 	
    102. 

  102. 	<div class="method-header">
    103. 

  103. 		<span class="method-title">static method getInstance</span> (line <span class="line-number">124</span>)
    104. 

  104. 	</div> 
    105. 

  105. 	
    106. 

  106. 	<!-- ========== Info from phpDoc block ========= -->
    107. 

  107. <p class="short-description">Returns an instance of this class</p>
    108. 

  108. 	<ul class="tags">
    109. 

  109. 				<li><span class="field">access:</span> public</li>
    110. 

  110. 			</ul>
    111. 

  111. 	
    112. 

  112. 	<div class="method-signature">
    113. 

  113. 	    static
    114. 

  114. 		<span class="method-result">object</span>
    115. 

  115. 		<span class="method-name">
    116. 

  116. 			getInstance
    117. 

  117. 		</span>
    118. 

  118. 					(<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>)
    119. 

  119. 			</div>
    120. 

  120. 	
    121. 

  121. 			<ul class="parameters">
    122. 

  122. 					<li>
    123. 

  123. 				<span class="var-type">string</span>
    124. 

  124. 				<span class="var-name">$type</span><span class="var-description">: caching type</span>			</li>
    125. 

  125. 					<li>
    126. 

  126. 				<span class="var-type">array</span>
    127. 

  127. 				<span class="var-name">$init</span><span class="var-description">: the IDS_Init object</span>			</li>
    128. 

  128. 				</ul>
    129. 

  129. 		
    130. 

  130. 			
    131. 

  131. 	</div>
    132. 

  132. 

  133. <a name="method__construct" id="__construct"><!-- --></a>
    134. 

  134. <div class="evenrow">
    135. 

  135. 	
    136. 

  136. 	<div class="method-header">
    137. 

  137. 		<span class="method-title">Constructor __construct</span> (line <span class="line-number">100</span>)
    138. 

  138. 	</div> 
    139. 

  139. 	
    140. 

  140. 	<!-- ========== Info from phpDoc block ========= -->
    141. 

  141. <p class="short-description">Constructor</p>
    142. 

  142. 	<ul class="tags">
    143. 

  143. 				<li><span class="field">throws:</span> Exception if necessary files aren't writeable</li>
    144. 

  144. 				<li><span class="field">access:</span> public</li>
    145. 

  145. 			</ul>
    146. 

  146. 	
    147. 

  147. 	<div class="method-signature">
    148. 

  148. 		<span class="method-result">void</span>
    149. 

  149. 		<span class="method-name">
    150. 

  150. 			__construct
    151. 

  151. 		</span>
    152. 

  152. 					(<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>)
    153. 

  153. 			</div>
    154. 

  154. 	
    155. 

  155. 			<ul class="parameters">
    156. 

  156. 					<li>
    157. 

  157. 				<span class="var-type">string</span>
    158. 

  158. 				<span class="var-name">$type</span><span class="var-description">: caching type</span>			</li>
    159. 

  159. 					<li>
    160. 

  160. 				<span class="var-type">array</span>
    161. 

  161. 				<span class="var-name">$init</span><span class="var-description">: the IDS_Init object</span>			</li>
    162. 

  162. 				</ul>
    163. 

  163. 		
    164. 

  164. 			
    165. 

  165. 	</div>
    166. 

  166. <a name="methodgetCache" id="getCache"><!-- --></a>
    167. 

  167. <div class="oddrow">
    168. 

  168. 	
    169. 

  169. 	<div class="method-header">
    170. 

  170. 		<span class="method-title">getCache</span> (line <span class="line-number">172</span>)
    171. 

  171. 	</div> 
    172. 

  172. 	
    173. 

  173. 	<!-- ========== Info from phpDoc block ========= -->
    174. 

  174. <p class="short-description">Returns the cached data</p>
    175. 

  175. <p class="description"><p>Note that this method returns false if either type or file cache is  not set</p></p>
    176. 

  176. 	<ul class="tags">
    177. 

  177. 				<li><span class="field">return:</span> cache data or false</li>
    178. 

  178. 				<li><span class="field">access:</span> public</li>
    179. 

  179. 			</ul>
    180. 

  180. 	
    181. 

  181. 	<div class="method-signature">
    182. 

  182. 		<span class="method-result">mixed</span>
    183. 

  183. 		<span class="method-name">
    184. 

  184. 			getCache
    185. 

  185. 		</span>
    186. 

  186. 				()
    187. 

  187. 			</div>
    188. 

  188. 	
    189. 

  189. 		
    190. 

  190. 				<hr class="separator" />
    191. 

  191. 		<div class="notes">Implementation of:</div>
    192. 

  192. 			<dl>
    193. 

  193. 			<dt><a href="../PHPIDS/IDS_Caching_Interface.html#methodgetCache">IDS_Caching_Interface::getCache()</a></dt>
    194. 

  194. 						<dd>Interface method</dd>
    195. 

  195. 					</dl>
    196. 

  196. 			
    197. 

  197. 	</div>
    198. 

  198. <a name="methodsetCache" id="setCache"><!-- --></a>
    199. 

  199. <div class="evenrow">
    200. 

  200. 	
    201. 

  201. 	<div class="method-header">
    202. 

  202. 		<span class="method-title">setCache</span> (line <span class="line-number">142</span>)
    203. 

  203. 	</div> 
    204. 

  204. 	
    205. 

  205. 	<!-- ========== Info from phpDoc block ========= -->
    206. 

  206. <p class="short-description">Writes cache data</p>
    207. 

  207. 	<ul class="tags">
    208. 

  208. 				<li><span class="field">throws:</span> Exception if necessary files aren't writeable</li>
    209. 

  209. 				<li><span class="field">access:</span> public</li>
    210. 

  210. 			</ul>
    211. 

  211. 	
    212. 

  212. 	<div class="method-signature">
    213. 

  213. 		<span class="method-result">object</span>
    214. 

  214. 		<span class="method-name">
    215. 

  215. 			setCache
    216. 

  216. 		</span>
    217. 

  217. 					(<span class="var-type"></span>&nbsp;<span class="var-name">$data</span>)
    218. 

  218. 			</div>
    219. 

  219. 	
    220. 

  220. 			<ul class="parameters">
    221. 

  221. 					<li>
    222. 

  222. 				<span class="var-type">array</span>
    223. 

  223. 				<span class="var-name">$data</span><span class="var-description">: the caching data</span>			</li>
    224. 

  224. 				</ul>
    225. 

  225. 		
    226. 

  226. 				<hr class="separator" />
    227. 

  227. 		<div class="notes">Implementation of:</div>
    228. 

  228. 			<dl>
    229. 

  229. 			<dt><a href="../PHPIDS/IDS_Caching_Interface.html#methodsetCache">IDS_Caching_Interface::setCache()</a></dt>
    230. 

  230. 						<dd>Interface method</dd>
    231. 

  231. 					</dl>
    232. 

  232. 			
    233. 

  233. 	</div>
    234. 

  234. 						
    235. 

  235. 		</div>
    236. 

  236. 	</div>
    237. 

  237. 

  238. 

  239. 	<p class="notes" id="credit">
    240. 

  240. 		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>
    241. 

  241. 	</p>
    242. 

  242. 	</div></body>
    243. 

  243. </html>
    244.