?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Release 0.49
[awl.git] / docs / api / awl / AwlCache.html
blob89b5ce7d4c97210718a5aaad6bc6649f688905ff
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 AwlCache</title>
7 <link rel="stylesheet" href="../media/stylesheet.css" />
8 <script src="../media/lib/classTree.js"></script>
9 <script language="javascript" type="text/javascript">
10 var imgPlus = new Image();
11 var imgMinus = new Image();
12 imgPlus.src = "../media/images/plus.png";
13 imgMinus.src = "../media/images/minus.png";
14
15 function showNode(Node){
16 switch(navigator.family){
17 case 'nn4':
18 // Nav 4.x code fork...
19 var oTable = document.layers["span" + Node];
20 var oImg = document.layers["img" + Node];
21 break;
22 case 'ie4':
23 // IE 4/5 code fork...
24 var oTable = document.all["span" + Node];
25 var oImg = document.all["img" + Node];
26 break;
27 case 'gecko':
28 // Standards Compliant code fork...
29 var oTable = document.getElementById("span" + Node);
30 var oImg = document.getElementById("img" + Node);
31 break;
32 }
33 oImg.src = imgMinus.src;
34 oTable.style.display = "block";
35 }
36
37 function hideNode(Node){
38 switch(navigator.family){
39 case 'nn4':
40 // Nav 4.x code fork...
41 var oTable = document.layers["span" + Node];
42 var oImg = document.layers["img" + Node];
43 break;
44 case 'ie4':
45 // IE 4/5 code fork...
46 var oTable = document.all["span" + Node];
47 var oImg = document.all["img" + Node];
48 break;
49 case 'gecko':
50 // Standards Compliant code fork...
51 var oTable = document.getElementById("span" + Node);
52 var oImg = document.getElementById("img" + Node);
53 break;
54 }
55 oImg.src = imgPlus.src;
56 oTable.style.display = "none";
57 }
58
59 function nodeIsVisible(Node){
60 switch(navigator.family){
61 case 'nn4':
62 // Nav 4.x code fork...
63 var oTable = document.layers["span" + Node];
64 break;
65 case 'ie4':
66 // IE 4/5 code fork...
67 var oTable = document.all["span" + Node];
68 break;
69 case 'gecko':
70 // Standards Compliant code fork...
71 var oTable = document.getElementById("span" + Node);
72 break;
73 }
74 return (oTable && oTable.style.display == "block");
75 }
76
77 function toggleNodeVisibility(Node){
78 if (nodeIsVisible(Node)){
79 hideNode(Node);
80 }else{
81 showNode(Node);
82 }
83 }
84 </script>
85 </head>
86 <body>
87 <div class="page-body">
88 <h2 class="class-name"><img src="../media/images/Class_logo.png"
89 alt=" Class"
90 title=" Class"
91 style="vertical-align: middle"> AwlCache</h2>
92
93 <a name="sec-description"></a>
94 <div class="info-box">
95 <div class="info-box-title">Description</div>
96 <div class="nav-bar">
97 <span class="disabled">Description</span> |
98 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
99
100 </div>
101 <div class="info-box-body">
102 <!-- ========== Info from phpDoc block ========= -->
103 <p class="short-description">A simple Memcached wrapper supporting namespacing of stored values.</p>
104 <ul class="tags">
105 <li><span class="field">author:</span> Andrew McMillan</li>
106 <li><span class="field">license:</span> LGPL</li>
107 </ul>
108 <p class="notes">
109 Located in <a class="field" href="_AwlCache.php.html">/AwlCache.php</a> (line <span class="field">10</span>)
110 </p>
111
112
113 <pre></pre>
114
115 </div>
116 </div>
117
118
119
120
121 <a name="sec-method-summary"></a>
122 <div class="info-box">
123 <div class="info-box-title">Method Summary</span></div>
124 <div class="nav-bar">
125 <a href="#sec-description">Description</a> |
126 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
127 </div>
128 <div class="info-box-body">
129 <div class="method-summary">
130
131 <div class="method-definition">
132 <img src="../media/images/Constructor.png" alt=" "/>
133 <span class="method-result">AwlCache</span>
134 <a href="#__construct" title="details" class="method-name">__construct</a>
135 ()
136 </div>
137
138 <div class="method-definition">
139 <img src="../media/images/Method.png" alt=" "/>
140 <span class="method-result">void</span>
141 <a href="#acquireLock" title="details" class="method-name">acquireLock</a>
142 (<span class="var-type"></span>&nbsp;<span class="var-name">$something</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$wait_for</span> = <span class="var-default">5</span>])
143 </div>
144
145 <div class="method-definition">
146 <img src="../media/images/Method.png" alt=" "/>
147 <span class="method-result">void</span>
148 <a href="#delete" title="details" class="method-name">delete</a>
149 (<span class="var-type">$namespace</span>&nbsp;<span class="var-name">$namespace</span>, <span class="var-type">$key</span>&nbsp;<span class="var-name">$key</span>)
150 </div>
151
152 <div class="method-definition">
153 <img src="../media/images/Method.png" alt=" "/>
154 <span class="method-result">void</span>
155 <a href="#flush" title="details" class="method-name">flush</a>
156 ()
157 </div>
158
159 <div class="method-definition">
160 <img src="../media/images/Method.png" alt=" "/>
161 <span class="method-result">void</span>
162 <a href="#get" title="details" class="method-name">get</a>
163 (<span class="var-type">$namespace</span>&nbsp;<span class="var-name">$namespace</span>, <span class="var-type">$key</span>&nbsp;<span class="var-name">$key</span>)
164 </div>
165
166 <div class="method-definition">
167 <img src="../media/images/Method.png" alt=" "/>
168 <span class="method-result">void</span>
169 <a href="#isActive" title="details" class="method-name">isActive</a>
170 ()
171 </div>
172
173 <div class="method-definition">
174 <img src="../media/images/Method.png" alt=" "/>
175 <span class="method-result">void</span>
176 <a href="#releaseLock" title="details" class="method-name">releaseLock</a>
177 (<span class="var-type"></span>&nbsp;<span class="var-name">$locker</span>)
178 </div>
179
180 <div class="method-definition">
181 <img src="../media/images/Method.png" alt=" "/>
182 <span class="method-result">void</span>
183 <a href="#set" title="details" class="method-name">set</a>
184 (<span class="var-type">$namespace</span>&nbsp;<span class="var-name">$namespace</span>, <span class="var-type">$key</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">$value</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type">$expiry</span>&nbsp;<span class="var-name">$expiry</span> = <span class="var-default">864000</span>])
185 </div>
186 </div>
187 </div>
188 </div>
189
190
191 <a name="sec-methods"></a>
192 <div class="info-box">
193 <div class="info-box-title">Methods</div>
194 <div class="nav-bar">
195 <a href="#sec-description">Description</a> |
196 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
197
198 </div>
199 <div class="info-box-body">
200 <A NAME='method_detail'></A>
201 <a name="method__construct" id="__construct"><!-- --></a>
202 <div class="evenrow">
203
204 <div class="method-header">
205 <img src="../media/images/Constructor.png" />
206 <span class="method-title">Constructor __construct</span> (line <span class="line-number">18</span>)
207 </div>
208
209 <!-- ========== Info from phpDoc block ========= -->
210 <p class="short-description">Initialise the cache connection. We use getpid() to give us a persistent connection.</p>
211
212 <div class="method-signature">
213 <span class="method-result">AwlCache</span>
214 <span class="method-name">
215 __construct
216 </span>
217 ()
218 </div>
219
220
221
222 </div>
223 <a name="methodacquireLock" id="acquireLock"><!-- --></a>
224 <div class="oddrow">
225
226 <div class="method-header">
227 <img src="../media/images/Method.png" />
228 <span class="method-title">acquireLock</span> (line <span class="line-number">147</span>)
229 </div>
230
231 <!-- ========== Info from phpDoc block ========= -->
232 <p class="short-description">Acquire a lock on something</p>
233
234 <div class="method-signature">
235 <span class="method-result">void</span>
236 <span class="method-name">
237 acquireLock
238 </span>
239 (<span class="var-type"></span>&nbsp;<span class="var-name">$something</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$wait_for</span> = <span class="var-default">5</span>])
240 </div>
241
242 <ul class="parameters">
243 <li>
244 <span class="var-type"></span>
245 <span class="var-name">$something</span> </li>
246 <li>
247 <span class="var-type"></span>
248 <span class="var-name">$wait_for</span> </li>
249 </ul>
250
251
252 </div>
253 <a name="methoddelete" id="delete"><!-- --></a>
254 <div class="evenrow">
255
256 <div class="method-header">
257 <img src="../media/images/Method.png" />
258 <span class="method-title">delete</span> (line <span class="line-number">116</span>)
259 </div>
260
261 <!-- ========== Info from phpDoc block ========= -->
262 <p class="short-description">Delete a value from a namespace/key, or for everything in a namespace if a 'null' key is supplied.</p>
263
264 <div class="method-signature">
265 <span class="method-result">void</span>
266 <span class="method-name">
267 delete
268 </span>
269 (<span class="var-type">$namespace</span>&nbsp;<span class="var-name">$namespace</span>, <span class="var-type">$key</span>&nbsp;<span class="var-name">$key</span>)
270 </div>
271
272 <ul class="parameters">
273 <li>
274 <span class="var-type">$namespace</span>
275 <span class="var-name">$namespace</span> </li>
276 <li>
277 <span class="var-type">$key</span>
278 <span class="var-name">$key</span> </li>
279 </ul>
280
281
282 </div>
283 <a name="methodflush" id="flush"><!-- --></a>
284 <div class="oddrow">
285
286 <div class="method-header">
287 <img src="../media/images/Method.png" />
288 <span class="method-title">flush</span> (line <span class="line-number">137</span>)
289 </div>
290
291 <!-- ========== Info from phpDoc block ========= -->
292 <p class="short-description">Flush the entire cache</p>
293
294 <div class="method-signature">
295 <span class="method-result">void</span>
296 <span class="method-name">
297 flush
298 </span>
299 ()
300 </div>
301
302
303
304 </div>
305 <a name="methodget" id="get"><!-- --></a>
306 <div class="evenrow">
307
308 <div class="method-header">
309 <img src="../media/images/Method.png" />
310 <span class="method-title">get</span> (line <span class="line-number">66</span>)
311 </div>
312
313 <!-- ========== Info from phpDoc block ========= -->
314 <p class="short-description">get a value from the specified namespace / key</p>
315
316 <div class="method-signature">
317 <span class="method-result">void</span>
318 <span class="method-name">
319 get
320 </span>
321 (<span class="var-type">$namespace</span>&nbsp;<span class="var-name">$namespace</span>, <span class="var-type">$key</span>&nbsp;<span class="var-name">$key</span>)
322 </div>
323
324 <ul class="parameters">
325 <li>
326 <span class="var-type">$namespace</span>
327 <span class="var-name">$namespace</span> </li>
328 <li>
329 <span class="var-type">$key</span>
330 <span class="var-name">$key</span> </li>
331 </ul>
332
333
334 </div>
335 <a name="methodisActive" id="isActive"><!-- --></a>
336 <div class="oddrow">
337
338 <div class="method-header">
339 <img src="../media/images/Method.png" />
340 <span class="method-title">isActive</span> (line <span class="line-number">48</span>)
341 </div>
342
343 <!-- ========== Info from phpDoc block ========= -->
344 <p class="short-description">So we can find out if we are actually using the cache.</p>
345
346 <div class="method-signature">
347 <span class="method-result">void</span>
348 <span class="method-name">
349 isActive
350 </span>
351 ()
352 </div>
353
354
355
356 </div>
357 <a name="methodreleaseLock" id="releaseLock"><!-- --></a>
358 <div class="evenrow">
359
360 <div class="method-header">
361 <img src="../media/images/Method.png" />
362 <span class="method-title">releaseLock</span> (line <span class="line-number">160</span>)
363 </div>
364
365 <!-- ========== Info from phpDoc block ========= -->
366 <p class="short-description">Release a lock</p>
367
368 <div class="method-signature">
369 <span class="method-result">void</span>
370 <span class="method-name">
371 releaseLock
372 </span>
373 (<span class="var-type"></span>&nbsp;<span class="var-name">$locker</span>)
374 </div>
375
376 <ul class="parameters">
377 <li>
378 <span class="var-type"></span>
379 <span class="var-name">$locker</span> </li>
380 </ul>
381
382
383 </div>
384 <a name="methodset" id="set"><!-- --></a>
385 <div class="oddrow">
386
387 <div class="method-header">
388 <img src="../media/images/Method.png" />
389 <span class="method-title">set</span> (line <span class="line-number">82</span>)
390 </div>
391
392 <!-- ========== Info from phpDoc block ========= -->
393 <p class="short-description">Set a value for the specified namespace/key, perhaps with an expiry (default 10 days)</p>
394
395 <div class="method-signature">
396 <span class="method-result">void</span>
397 <span class="method-name">
398 set
399 </span>
400 (<span class="var-type">$namespace</span>&nbsp;<span class="var-name">$namespace</span>, <span class="var-type">$key</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">$value</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type">$expiry</span>&nbsp;<span class="var-name">$expiry</span> = <span class="var-default">864000</span>])
401 </div>
402
403 <ul class="parameters">
404 <li>
405 <span class="var-type">$namespace</span>
406 <span class="var-name">$namespace</span> </li>
407 <li>
408 <span class="var-type">$key</span>
409 <span class="var-name">$key</span> </li>
410 <li>
411 <span class="var-type">$value</span>
412 <span class="var-name">$value</span> </li>
413 <li>
414 <span class="var-type">$expiry</span>
415 <span class="var-name">$expiry</span> </li>
416 </ul>
417
418
419 </div>
420
421 </div>
422 </div>
423
424
425 <p class="notes" id="credit">
426 Documentation generated on Mon, 24 Oct 2011 20:10:09 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
427 </p>
428 </div></body>
429 </html>
Andrew's Web Libraries