PageRenderTime 39ms CodeModel.GetById 32ms app.highlight 4ms 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
 14<a name="sec-description"></a>
 15<div class="info-box">
 16	<div class="info-box-title">Description</div>
 17	<div class="nav-bar">
 18					<span class="disabled">Description</span> |
 19															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
 20						
 21					</div>
 22	<div class="info-box-body">
 23                <p class="implements">
 24            Implements interfaces:
 25            <ul>
 26                <li><a href="../PHPIDS/IDS_Caching_Interface.html">IDS_Caching_Interface</a></li>            </ul>
 27        </p>
 28        		<!-- ========== Info from phpDoc block ========= -->
 29<p class="short-description">File caching wrapper</p>
 30<p class="description"><p>This class inhabits functionality to get and set cache via memcached.</p></p>
 31	<ul class="tags">
 32				<li><span class="field">author:</span> Lars Strojny &lt;<a href="mailto:lars@strojny.net">lars@strojny.net</a>&gt;</li>
 33				<li><span class="field">author:</span> Christian Matthies &lt;<a href="mailto:ch0012@gmail.com">ch0012@gmail.com</a>&gt;</li>
 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				<li><span class="field">version:</span> Release: $Id:Memcached.php 517 2007-09-15 15:04:13Z mario $</li>
 36				<li><span class="field">copyright:</span> 2007 The PHPIDS Groupoup</li>
 37				<li><span class="field">link:</span> <a href="http://php-ids.org/">http://php-ids.org/</a></li>
 38				<li><span class="field">since:</span> Version 0.4</li>
 39				<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/lgpl.html">LGPL</a></li>
 40			</ul>
 41		<p class="notes">
 42			Located in <a class="field" href="_Caching---Memcached.php.html">/Caching/Memcached.php</a> (line <span class="field">52</span>)
 43		</p>
 44		
 45				
 46		<pre></pre>
 47	
 48			</div>
 49</div>
 50
 51
 52
 53
 54	<a name="sec-method-summary"></a>
 55	<div class="info-box">
 56		<div class="info-box-title">Method Summary</span></div>
 57		<div class="nav-bar">
 58			<a href="#sec-description">Description</a> |
 59												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
 60		</div>
 61		<div class="info-box-body">			
 62			<div class="method-summary">
 63																												<div class="method-definition">
 64					static 						<span class="method-result">object</span>
 65										<a href="#getInstance" title="details" class="method-name">getInstance</a>
 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									</div>
 68																
 69												<div class="method-definition">
 70											<span class="method-result">void</span>
 71										<a href="#__construct" title="details" class="method-name">__construct</a>
 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									</div>
 74																<div class="method-definition">
 75											<span class="method-result">mixed</span>
 76										<a href="#getCache" title="details" class="method-name">getCache</a>
 77										()
 78									</div>
 79																								<div class="method-definition">
 80											<span class="method-result">object</span>
 81										<a href="#setCache" title="details" class="method-name">setCache</a>
 82											(<span class="var-type"></span>&nbsp;<span class="var-name">$data</span>)
 83									</div>
 84								</div>
 85		</div>
 86	</div>		
 87
 88	
 89	<a name="sec-methods"></a>
 90	<div class="info-box">
 91		<div class="info-box-title">Methods</div>
 92		<div class="nav-bar">
 93			<a href="#sec-description">Description</a> |
 94																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
 95						
 96		</div>
 97		<div class="info-box-body">
 98			<A NAME='method_detail'></A>
 99<a name="methodgetInstance" id="getInstance"><!-- --></a>
100<div class="oddrow">
101	
102	<div class="method-header">
103		<span class="method-title">static method getInstance</span> (line <span class="line-number">124</span>)
104	</div> 
105	
106	<!-- ========== Info from phpDoc block ========= -->
107<p class="short-description">Returns an instance of this class</p>
108	<ul class="tags">
109				<li><span class="field">access:</span> public</li>
110			</ul>
111	
112	<div class="method-signature">
113	    static
114		<span class="method-result">object</span>
115		<span class="method-name">
116			getInstance
117		</span>
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			</div>
120	
121			<ul class="parameters">
122					<li>
123				<span class="var-type">string</span>
124				<span class="var-name">$type</span><span class="var-description">: caching type</span>			</li>
125					<li>
126				<span class="var-type">array</span>
127				<span class="var-name">$init</span><span class="var-description">: the IDS_Init object</span>			</li>
128				</ul>
129		
130			
131	</div>
132
133<a name="method__construct" id="__construct"><!-- --></a>
134<div class="evenrow">
135	
136	<div class="method-header">
137		<span class="method-title">Constructor __construct</span> (line <span class="line-number">100</span>)
138	</div> 
139	
140	<!-- ========== Info from phpDoc block ========= -->
141<p class="short-description">Constructor</p>
142	<ul class="tags">
143				<li><span class="field">throws:</span> Exception if necessary files aren't writeable</li>
144				<li><span class="field">access:</span> public</li>
145			</ul>
146	
147	<div class="method-signature">
148		<span class="method-result">void</span>
149		<span class="method-name">
150			__construct
151		</span>
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			</div>
154	
155			<ul class="parameters">
156					<li>
157				<span class="var-type">string</span>
158				<span class="var-name">$type</span><span class="var-description">: caching type</span>			</li>
159					<li>
160				<span class="var-type">array</span>
161				<span class="var-name">$init</span><span class="var-description">: the IDS_Init object</span>			</li>
162				</ul>
163		
164			
165	</div>
166<a name="methodgetCache" id="getCache"><!-- --></a>
167<div class="oddrow">
168	
169	<div class="method-header">
170		<span class="method-title">getCache</span> (line <span class="line-number">172</span>)
171	</div> 
172	
173	<!-- ========== Info from phpDoc block ========= -->
174<p class="short-description">Returns the cached data</p>
175<p class="description"><p>Note that this method returns false if either type or file cache is  not set</p></p>
176	<ul class="tags">
177				<li><span class="field">return:</span> cache data or false</li>
178				<li><span class="field">access:</span> public</li>
179			</ul>
180	
181	<div class="method-signature">
182		<span class="method-result">mixed</span>
183		<span class="method-name">
184			getCache
185		</span>
186				()
187			</div>
188	
189		
190				<hr class="separator" />
191		<div class="notes">Implementation of:</div>
192			<dl>
193			<dt><a href="../PHPIDS/IDS_Caching_Interface.html#methodgetCache">IDS_Caching_Interface::getCache()</a></dt>
194						<dd>Interface method</dd>
195					</dl>
196			
197	</div>
198<a name="methodsetCache" id="setCache"><!-- --></a>
199<div class="evenrow">
200	
201	<div class="method-header">
202		<span class="method-title">setCache</span> (line <span class="line-number">142</span>)
203	</div> 
204	
205	<!-- ========== Info from phpDoc block ========= -->
206<p class="short-description">Writes cache data</p>
207	<ul class="tags">
208				<li><span class="field">throws:</span> Exception if necessary files aren't writeable</li>
209				<li><span class="field">access:</span> public</li>
210			</ul>
211	
212	<div class="method-signature">
213		<span class="method-result">object</span>
214		<span class="method-name">
215			setCache
216		</span>
217					(<span class="var-type"></span>&nbsp;<span class="var-name">$data</span>)
218			</div>
219	
220			<ul class="parameters">
221					<li>
222				<span class="var-type">array</span>
223				<span class="var-name">$data</span><span class="var-description">: the caching data</span>			</li>
224				</ul>
225		
226				<hr class="separator" />
227		<div class="notes">Implementation of:</div>
228			<dl>
229			<dt><a href="../PHPIDS/IDS_Caching_Interface.html#methodsetCache">IDS_Caching_Interface::setCache()</a></dt>
230						<dd>Interface method</dd>
231					</dl>
232			
233	</div>
234						
235		</div>
236	</div>
237
238
239	<p class="notes" id="credit">
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	</p>
242	</div></body>
243</html>