| 297 |
jpm |
1 |
<?xml version="1.0" encoding="UTF-8"?>
|
|
|
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 CacheSqlite</title>
|
|
|
7 |
<meta http-equiv='Content-Type' content='text/html; charset=UTF-8'/>
|
|
|
8 |
<link rel="stylesheet" href="../media/stylesheet.css" />
|
|
|
9 |
<script src="../media/lib/classTree.js"></script>
|
|
|
10 |
<script language="javascript" type="text/javascript">
|
|
|
11 |
var imgPlus = new Image();
|
|
|
12 |
var imgMinus = new Image();
|
|
|
13 |
imgPlus.src = "../media/images/plus.png";
|
|
|
14 |
imgMinus.src = "../media/images/minus.png";
|
|
|
15 |
|
|
|
16 |
function showNode(Node){
|
|
|
17 |
switch(navigator.family){
|
|
|
18 |
case 'nn4':
|
|
|
19 |
// Nav 4.x code fork...
|
|
|
20 |
var oTable = document.layers["span" + Node];
|
|
|
21 |
var oImg = document.layers["img" + Node];
|
|
|
22 |
break;
|
|
|
23 |
case 'ie4':
|
|
|
24 |
// IE 4/5 code fork...
|
|
|
25 |
var oTable = document.all["span" + Node];
|
|
|
26 |
var oImg = document.all["img" + Node];
|
|
|
27 |
break;
|
|
|
28 |
case 'gecko':
|
|
|
29 |
// Standards Compliant code fork...
|
|
|
30 |
var oTable = document.getElementById("span" + Node);
|
|
|
31 |
var oImg = document.getElementById("img" + Node);
|
|
|
32 |
break;
|
|
|
33 |
}
|
|
|
34 |
oImg.src = imgMinus.src;
|
|
|
35 |
oTable.style.display = "block";
|
|
|
36 |
}
|
|
|
37 |
|
|
|
38 |
function hideNode(Node){
|
|
|
39 |
switch(navigator.family){
|
|
|
40 |
case 'nn4':
|
|
|
41 |
// Nav 4.x code fork...
|
|
|
42 |
var oTable = document.layers["span" + Node];
|
|
|
43 |
var oImg = document.layers["img" + Node];
|
|
|
44 |
break;
|
|
|
45 |
case 'ie4':
|
|
|
46 |
// IE 4/5 code fork...
|
|
|
47 |
var oTable = document.all["span" + Node];
|
|
|
48 |
var oImg = document.all["img" + Node];
|
|
|
49 |
break;
|
|
|
50 |
case 'gecko':
|
|
|
51 |
// Standards Compliant code fork...
|
|
|
52 |
var oTable = document.getElementById("span" + Node);
|
|
|
53 |
var oImg = document.getElementById("img" + Node);
|
|
|
54 |
break;
|
|
|
55 |
}
|
|
|
56 |
oImg.src = imgPlus.src;
|
|
|
57 |
oTable.style.display = "none";
|
|
|
58 |
}
|
|
|
59 |
|
|
|
60 |
function nodeIsVisible(Node){
|
|
|
61 |
switch(navigator.family){
|
|
|
62 |
case 'nn4':
|
|
|
63 |
// Nav 4.x code fork...
|
|
|
64 |
var oTable = document.layers["span" + Node];
|
|
|
65 |
break;
|
|
|
66 |
case 'ie4':
|
|
|
67 |
// IE 4/5 code fork...
|
|
|
68 |
var oTable = document.all["span" + Node];
|
|
|
69 |
break;
|
|
|
70 |
case 'gecko':
|
|
|
71 |
// Standards Compliant code fork...
|
|
|
72 |
var oTable = document.getElementById("span" + Node);
|
|
|
73 |
break;
|
|
|
74 |
}
|
|
|
75 |
return (oTable && oTable.style.display == "block");
|
|
|
76 |
}
|
|
|
77 |
|
|
|
78 |
function toggleNodeVisibility(Node){
|
|
|
79 |
if (nodeIsVisible(Node)){
|
|
|
80 |
hideNode(Node);
|
|
|
81 |
}else{
|
|
|
82 |
showNode(Node);
|
|
|
83 |
}
|
|
|
84 |
}
|
|
|
85 |
</script>
|
|
|
86 |
</head>
|
|
|
87 |
<body>
|
|
|
88 |
<div class="page-body">
|
|
|
89 |
<h2 class="class-name">Class CacheSqlite</h2>
|
|
|
90 |
|
|
|
91 |
<a name="sec-description"></a>
|
|
|
92 |
<div class="info-box">
|
|
|
93 |
<div class="info-box-title">Description</div>
|
|
|
94 |
<div class="nav-bar">
|
|
|
95 |
<span class="disabled">Description</span> |
|
|
|
96 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
|
|
97 |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
98 |
|
|
|
99 |
</div>
|
|
|
100 |
<div class="info-box-body">
|
|
|
101 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
102 |
<p class="notes">
|
|
|
103 |
Located in <a class="field" href="_CacheSqlite.php.html">/CacheSqlite.php</a> (line <span class="field"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a2">2</a></span>)
|
|
|
104 |
</p>
|
|
|
105 |
|
|
|
106 |
|
|
|
107 |
<pre></pre>
|
|
|
108 |
|
|
|
109 |
</div>
|
|
|
110 |
</div>
|
|
|
111 |
|
|
|
112 |
|
|
|
113 |
|
|
|
114 |
<a name="sec-var-summary"></a>
|
|
|
115 |
<div class="info-box">
|
|
|
116 |
<div class="info-box-title">Variable Summary</span></div>
|
|
|
117 |
<div class="nav-bar">
|
|
|
118 |
<a href="#sec-description">Description</a> |
|
|
|
119 |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
|
|
120 |
|
|
|
|
121 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
122 |
|
|
|
123 |
</div>
|
|
|
124 |
<div class="info-box-body">
|
|
|
125 |
<div class="var-summary">
|
|
|
126 |
<div class="var-title">
|
|
|
127 |
<span class="var-type">array</span>
|
|
|
128 |
<a href="#$options" title="details" class="var-name">$options</a>
|
|
|
129 |
</div>
|
|
|
130 |
</div>
|
|
|
131 |
</div>
|
|
|
132 |
</div>
|
|
|
133 |
|
|
|
134 |
<a name="sec-method-summary"></a>
|
|
|
135 |
<div class="info-box">
|
|
|
136 |
<div class="info-box-title">Method Summary</span></div>
|
|
|
137 |
<div class="nav-bar">
|
|
|
138 |
<a href="#sec-description">Description</a> |
|
|
|
139 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
|
|
140 |
|
|
|
141 |
|
|
|
|
142 |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
|
|
143 |
</div>
|
|
|
144 |
<div class="info-box-body">
|
|
|
145 |
<div class="method-summary">
|
|
|
146 |
|
|
|
147 |
<div class="method-definition">
|
|
|
148 |
<span class="method-result">void</span>
|
|
|
149 |
<a href="#__construct" title="details" class="method-name">__construct</a>
|
|
|
150 |
([<span class="var-type"></span> <span class="var-name">$options</span> = <span class="var-default">array()</span>], <span class="var-type"><a href="../Framework/Cache.html">Cache</a></span> <span class="var-name">$cache</span>)
|
|
|
151 |
</div>
|
|
|
152 |
|
|
|
153 |
<div class="method-definition">
|
|
|
154 |
<span class="method-result">void</span>
|
|
|
155 |
<a href="#__destruct" title="details" class="method-name">__destruct</a>
|
|
|
156 |
()
|
|
|
157 |
</div>
|
|
|
158 |
|
|
|
159 |
<div class="method-definition">
|
|
|
160 |
<span class="method-result">boolean</span>
|
|
|
161 |
<a href="#ajouterSupplementDureeDeVie" title="details" class="method-name">ajouterSupplementDureeDeVie</a>
|
|
|
162 |
(<span class="var-type">string</span> <span class="var-name">$id</span>, <span class="var-type"></span> <span class="var-name">$supplement_duree_de_vie</span>, <span class="var-type">int</span> <span class="var-name">$extraLifetime</span>)
|
|
|
163 |
</div>
|
|
|
164 |
|
|
|
165 |
<div class="method-definition">
|
|
|
166 |
<span class="method-result">string|false</span>
|
|
|
167 |
<a href="#charger" title="details" class="method-name">charger</a>
|
|
|
168 |
(<span class="var-type">string</span> <span class="var-name">$id</span>, [<span class="var-type"></span> <span class="var-name">$ne_pas_tester_validiter_du_cache</span> = <span class="var-default">false</span>], <span class="var-type">boolean</span> <span class="var-name">$doNotTestCacheValidity</span>)
|
|
|
169 |
</div>
|
|
|
170 |
|
|
|
171 |
<div class="method-definition">
|
|
|
172 |
<span class="method-result">array</span>
|
|
|
173 |
<a href="#getIds" title="details" class="method-name">getIds</a>
|
|
|
174 |
()
|
|
|
175 |
</div>
|
|
|
176 |
|
|
|
177 |
<div class="method-definition">
|
|
|
178 |
<span class="method-result">array</span>
|
|
|
179 |
<a href="#getIdsAvecLesTags" title="details" class="method-name">getIdsAvecLesTags</a>
|
|
|
180 |
([<span class="var-type">array</span> <span class="var-name">$tags</span> = <span class="var-default">array()</span>])
|
|
|
181 |
</div>
|
|
|
182 |
|
|
|
183 |
<div class="method-definition">
|
|
|
184 |
<span class="method-result">array</span>
|
|
|
185 |
<a href="#getIdsAvecUnTag" title="details" class="method-name">getIdsAvecUnTag</a>
|
|
|
186 |
([<span class="var-type">array</span> <span class="var-name">$tags</span> = <span class="var-default">array()</span>])
|
|
|
187 |
</div>
|
|
|
188 |
|
|
|
189 |
<div class="method-definition">
|
|
|
190 |
<span class="method-result">array</span>
|
|
|
191 |
<a href="#getIdsSansLesTags" title="details" class="method-name">getIdsSansLesTags</a>
|
|
|
192 |
([<span class="var-type">array</span> <span class="var-name">$tags</span> = <span class="var-default">array()</span>])
|
|
|
193 |
</div>
|
|
|
194 |
|
|
|
195 |
<div class="method-definition">
|
|
|
196 |
<span class="method-result">array</span>
|
|
|
197 |
<a href="#getMetadonnees" title="details" class="method-name">getMetadonnees</a>
|
|
|
198 |
(<span class="var-type">string</span> <span class="var-name">$id</span>)
|
|
|
199 |
</div>
|
|
|
200 |
|
|
|
201 |
<div class="method-definition">
|
|
|
202 |
<span class="method-result">int</span>
|
|
|
203 |
<a href="#getPourcentageRemplissage" title="details" class="method-name">getPourcentageRemplissage</a>
|
|
|
204 |
()
|
|
|
205 |
</div>
|
|
|
206 |
|
|
|
207 |
<div class="method-definition">
|
|
|
208 |
<span class="method-result">array</span>
|
|
|
209 |
<a href="#getTags" title="details" class="method-name">getTags</a>
|
|
|
210 |
()
|
|
|
211 |
</div>
|
|
|
212 |
|
|
|
213 |
<div class="method-definition">
|
|
|
214 |
<span class="method-result">boolean</span>
|
|
|
215 |
<a href="#nettoyer" title="details" class="method-name">nettoyer</a>
|
|
|
216 |
([<span class="var-type">string</span> <span class="var-name">$mode</span> = <span class="var-default">Cache::NETTOYAGE_MODE_TOUS</span>], [<span class="var-type">array</span> <span class="var-name">$tags</span> = <span class="var-default">array()</span>])
|
|
|
217 |
</div>
|
|
|
218 |
|
|
|
219 |
<div class="method-definition">
|
|
|
220 |
<span class="method-result">boolean</span>
|
|
|
221 |
<a href="#sauver" title="details" class="method-name">sauver</a>
|
|
|
222 |
(<span class="var-type"></span> <span class="var-name">$donnees</span>, <span class="var-type">string</span> <span class="var-name">$id</span>, [<span class="var-type">array</span> <span class="var-name">$tags</span> = <span class="var-default">array()</span>], [<span class="var-type"></span> <span class="var-name">$duree_vie_specifique</span> = <span class="var-default">false</span>], <span class="var-type">string</span> <span class="var-name">$data</span>, <span class="var-type">int</span> <span class="var-name">$specificLifetime</span>)
|
|
|
223 |
</div>
|
|
|
224 |
|
|
|
225 |
<div class="method-definition">
|
|
|
226 |
<span class="method-result">void</span>
|
|
|
227 |
<a href="#setEmplacement" title="details" class="method-name">setEmplacement</a>
|
|
|
228 |
(<span class="var-type"></span> <span class="var-name">$emplacement</span>)
|
|
|
229 |
</div>
|
|
|
230 |
|
|
|
231 |
<div class="method-definition">
|
|
|
232 |
<span class="method-result">boolean</span>
|
|
|
233 |
<a href="#supprimer" title="details" class="method-name">supprimer</a>
|
|
|
234 |
(<span class="var-type">string</span> <span class="var-name">$id</span>)
|
|
|
235 |
</div>
|
|
|
236 |
|
|
|
237 |
<div class="method-definition">
|
|
|
238 |
<span class="method-result">mixed|false</span>
|
|
|
239 |
<a href="#tester" title="details" class="method-name">tester</a>
|
|
|
240 |
(<span class="var-type">string</span> <span class="var-name">$id</span>)
|
|
|
241 |
</div>
|
|
|
242 |
</div>
|
|
|
243 |
</div>
|
|
|
244 |
</div>
|
|
|
245 |
|
|
|
246 |
<a name="sec-vars"></a>
|
|
|
247 |
<div class="info-box">
|
|
|
248 |
<div class="info-box-title">Variables</div>
|
|
|
249 |
<div class="nav-bar">
|
|
|
250 |
<a href="#sec-description">Description</a> |
|
|
|
251 |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
|
|
252 |
|
|
|
253 |
|
|
|
254 |
|
|
|
|
255 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
256 |
|
|
|
257 |
</div>
|
|
|
258 |
<div class="info-box-body">
|
|
|
259 |
|
|
|
260 |
<a name="var$options" id="$options"><!-- --></A>
|
|
|
261 |
<div class="evenrow">
|
|
|
262 |
|
|
|
263 |
<div class="var-header">
|
|
|
264 |
<span class="var-title">
|
|
|
265 |
<span class="var-type">array</span>
|
|
|
266 |
<span class="var-name">$options</span>
|
|
|
267 |
= <span class="var-default">array(<br /> 'stockage_chemin' => null,<br /> 'defragmentation_auto' => 10<br /> )</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a20">20</a></span>)
|
|
|
268 |
</span>
|
|
|
269 |
</div>
|
|
|
270 |
|
|
|
271 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
272 |
<p class="short-description">Options disponibles :</p>
|
|
|
273 |
<p class="description"><p>====> (string) stockage_chemin : Chemin vers le fichier contenant la base SQLite.</p><p>====> (int) defragmentation_auto : <ul><li>Désactive / Régler le processus de défragmentation automatique</li><li>Le processus de défragmentation automatiques réduit la taille du fichier contenant la base de données
|
|
|
274 |
quand un ajout ou une suppression de cache est réalisée :</li></ul> 0 => pas de défragmentation automatique 1 => défragmentation automatique systématique x (integer) > 1 => défragmentation automatique toutes les 1 fois (au hasard) sur x ajout ou suppression de cache</p></p>
|
|
|
275 |
<ul class="tags">
|
|
|
276 |
<li><span class="field">var:</span> options disponibles</li>
|
|
|
277 |
<li><span class="field">access:</span> protected</li>
|
|
|
278 |
</ul>
|
|
|
279 |
|
|
|
280 |
|
|
|
281 |
|
|
|
282 |
|
|
|
283 |
|
|
|
284 |
</div>
|
|
|
285 |
|
|
|
286 |
</div>
|
|
|
287 |
</div>
|
|
|
288 |
|
|
|
289 |
<a name="sec-methods"></a>
|
|
|
290 |
<div class="info-box">
|
|
|
291 |
<div class="info-box-title">Methods</div>
|
|
|
292 |
<div class="nav-bar">
|
|
|
293 |
<a href="#sec-description">Description</a> |
|
|
|
294 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
|
|
295 |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
|
|
296 |
|
|
|
297 |
</div>
|
|
|
298 |
<div class="info-box-body">
|
|
|
299 |
<A NAME='method_detail'></A>
|
|
|
300 |
<a name="method__construct" id="__construct"><!-- --></a>
|
|
|
301 |
<div class="oddrow">
|
|
|
302 |
|
|
|
303 |
<div class="method-header">
|
|
|
304 |
<span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a48">48</a></span>)
|
|
|
305 |
</div>
|
|
|
306 |
|
|
|
307 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
308 |
<p class="short-description">Constructor</p>
|
|
|
309 |
<ul class="tags">
|
|
|
310 |
<li><span class="field">throws:</span> Zend_cache_Exception</li>
|
|
|
311 |
<li><span class="field">access:</span> public</li>
|
|
|
312 |
</ul>
|
|
|
313 |
|
|
|
314 |
<div class="method-signature">
|
|
|
315 |
<span class="method-result">void</span>
|
|
|
316 |
<span class="method-name">
|
|
|
317 |
__construct
|
|
|
318 |
</span>
|
|
|
319 |
([<span class="var-type"></span> <span class="var-name">$options</span> = <span class="var-default">array()</span>], <span class="var-type"><a href="../Framework/Cache.html">Cache</a></span> <span class="var-name">$cache</span>)
|
|
|
320 |
</div>
|
|
|
321 |
|
|
|
322 |
<ul class="parameters">
|
|
|
323 |
<li>
|
|
|
324 |
<span class="var-type">array</span>
|
|
|
325 |
<span class="var-name">$options</span><span class="var-description">: Associative array of options</span> </li>
|
|
|
326 |
<li>
|
|
|
327 |
<span class="var-type"><a href="../Framework/Cache.html">Cache</a></span>
|
|
|
328 |
<span class="var-name">$cache</span> </li>
|
|
|
329 |
</ul>
|
|
|
330 |
|
|
|
331 |
|
|
|
332 |
</div>
|
|
|
333 |
<a name="method__destruct" id="__destruct"><!-- --></a>
|
|
|
334 |
<div class="evenrow">
|
|
|
335 |
|
|
|
336 |
<div class="method-header">
|
|
|
337 |
<span class="method-title">Destructor __destruct</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a72">72</a></span>)
|
|
|
338 |
</div>
|
|
|
339 |
|
|
|
340 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
341 |
<p class="short-description">Destructor</p>
|
|
|
342 |
<ul class="tags">
|
|
|
343 |
<li><span class="field">access:</span> public</li>
|
|
|
344 |
</ul>
|
|
|
345 |
|
|
|
346 |
<div class="method-signature">
|
|
|
347 |
<span class="method-result">void</span>
|
|
|
348 |
<span class="method-name">
|
|
|
349 |
__destruct
|
|
|
350 |
</span>
|
|
|
351 |
()
|
|
|
352 |
</div>
|
|
|
353 |
|
|
|
354 |
|
|
|
355 |
|
|
|
356 |
</div>
|
|
|
357 |
<a name="methodajouterSupplementDureeDeVie" id="ajouterSupplementDureeDeVie"><!-- --></a>
|
|
|
358 |
<div class="oddrow">
|
|
|
359 |
|
|
|
360 |
<div class="method-header">
|
|
|
361 |
<span class="method-title">ajouterSupplementDureeDeVie</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a403">403</a></span>)
|
|
|
362 |
</div>
|
|
|
363 |
|
|
|
364 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
365 |
<p class="short-description">Give (if possible) an extra lifetime to the given cache id</p>
|
|
|
366 |
<ul class="tags">
|
|
|
367 |
<li><span class="field">return:</span> true if ok</li>
|
|
|
368 |
<li><span class="field">access:</span> public</li>
|
|
|
369 |
</ul>
|
|
|
370 |
|
|
|
371 |
<div class="method-signature">
|
|
|
372 |
<span class="method-result">boolean</span>
|
|
|
373 |
<span class="method-name">
|
|
|
374 |
ajouterSupplementDureeDeVie
|
|
|
375 |
</span>
|
|
|
376 |
(<span class="var-type">string</span> <span class="var-name">$id</span>, <span class="var-type"></span> <span class="var-name">$supplement_duree_de_vie</span>, <span class="var-type">int</span> <span class="var-name">$extraLifetime</span>)
|
|
|
377 |
</div>
|
|
|
378 |
|
|
|
379 |
<ul class="parameters">
|
|
|
380 |
<li>
|
|
|
381 |
<span class="var-type">string</span>
|
|
|
382 |
<span class="var-name">$id</span><span class="var-description">: cache id</span> </li>
|
|
|
383 |
<li>
|
|
|
384 |
<span class="var-type">int</span>
|
|
|
385 |
<span class="var-name">$extraLifetime</span> </li>
|
|
|
386 |
<li>
|
|
|
387 |
<span class="var-type"></span>
|
|
|
388 |
<span class="var-name">$supplement_duree_de_vie</span> </li>
|
|
|
389 |
</ul>
|
|
|
390 |
|
|
|
391 |
|
|
|
392 |
</div>
|
|
|
393 |
<a name="methodcharger" id="charger"><!-- --></a>
|
|
|
394 |
<div class="evenrow">
|
|
|
395 |
|
|
|
396 |
<div class="method-header">
|
|
|
397 |
<span class="method-title">charger</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a104">104</a></span>)
|
|
|
398 |
</div>
|
|
|
399 |
|
|
|
400 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
401 |
<p class="short-description">Test if a cache is available for the given id and (if yes) return it (false else)</p>
|
|
|
402 |
<ul class="tags">
|
|
|
403 |
<li><span class="field">return:</span> Cached datas</li>
|
|
|
404 |
<li><span class="field">access:</span> public</li>
|
|
|
405 |
</ul>
|
|
|
406 |
|
|
|
407 |
<div class="method-signature">
|
|
|
408 |
<span class="method-result">string|false</span>
|
|
|
409 |
<span class="method-name">
|
|
|
410 |
charger
|
|
|
411 |
</span>
|
|
|
412 |
(<span class="var-type">string</span> <span class="var-name">$id</span>, [<span class="var-type"></span> <span class="var-name">$ne_pas_tester_validiter_du_cache</span> = <span class="var-default">false</span>], <span class="var-type">boolean</span> <span class="var-name">$doNotTestCacheValidity</span>)
|
|
|
413 |
</div>
|
|
|
414 |
|
|
|
415 |
<ul class="parameters">
|
|
|
416 |
<li>
|
|
|
417 |
<span class="var-type">string</span>
|
|
|
418 |
<span class="var-name">$id</span><span class="var-description">: Cache id</span> </li>
|
|
|
419 |
<li>
|
|
|
420 |
<span class="var-type">boolean</span>
|
|
|
421 |
<span class="var-name">$doNotTestCacheValidity</span><span class="var-description">: If set to true, the cache validity won't be tested</span> </li>
|
|
|
422 |
<li>
|
|
|
423 |
<span class="var-type"></span>
|
|
|
424 |
<span class="var-name">$ne_pas_tester_validiter_du_cache</span> </li>
|
|
|
425 |
</ul>
|
|
|
426 |
|
|
|
427 |
|
|
|
428 |
</div>
|
|
|
429 |
<a name="methodgetIds" id="getIds"><!-- --></a>
|
|
|
430 |
<div class="oddrow">
|
|
|
431 |
|
|
|
432 |
<div class="method-header">
|
|
|
433 |
<span class="method-title">getIds</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a209">209</a></span>)
|
|
|
434 |
</div>
|
|
|
435 |
|
|
|
436 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
437 |
<p class="short-description">Return an array of stored cache ids</p>
|
|
|
438 |
<ul class="tags">
|
|
|
439 |
<li><span class="field">return:</span> array of stored cache ids (string)</li>
|
|
|
440 |
<li><span class="field">access:</span> public</li>
|
|
|
441 |
</ul>
|
|
|
442 |
|
|
|
443 |
<div class="method-signature">
|
|
|
444 |
<span class="method-result">array</span>
|
|
|
445 |
<span class="method-name">
|
|
|
446 |
getIds
|
|
|
447 |
</span>
|
|
|
448 |
()
|
|
|
449 |
</div>
|
|
|
450 |
|
|
|
451 |
|
|
|
452 |
|
|
|
453 |
</div>
|
|
|
454 |
<a name="methodgetIdsAvecLesTags" id="getIdsAvecLesTags"><!-- --></a>
|
|
|
455 |
<div class="evenrow">
|
|
|
456 |
|
|
|
457 |
<div class="method-header">
|
|
|
458 |
<span class="method-title">getIdsAvecLesTags</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a242">242</a></span>)
|
|
|
459 |
</div>
|
|
|
460 |
|
|
|
461 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
462 |
<p class="short-description">Return an array of stored cache ids which match given tags</p>
|
|
|
463 |
<p class="description"><p>In case of multiple tags, a logical AND is made between tags</p></p>
|
|
|
464 |
<ul class="tags">
|
|
|
465 |
<li><span class="field">return:</span> array of matching cache ids (string)</li>
|
|
|
466 |
<li><span class="field">access:</span> public</li>
|
|
|
467 |
</ul>
|
|
|
468 |
|
|
|
469 |
<div class="method-signature">
|
|
|
470 |
<span class="method-result">array</span>
|
|
|
471 |
<span class="method-name">
|
|
|
472 |
getIdsAvecLesTags
|
|
|
473 |
</span>
|
|
|
474 |
([<span class="var-type">array</span> <span class="var-name">$tags</span> = <span class="var-default">array()</span>])
|
|
|
475 |
</div>
|
|
|
476 |
|
|
|
477 |
<ul class="parameters">
|
|
|
478 |
<li>
|
|
|
479 |
<span class="var-type">array</span>
|
|
|
480 |
<span class="var-name">$tags</span><span class="var-description">: array of tags</span> </li>
|
|
|
481 |
</ul>
|
|
|
482 |
|
|
|
483 |
|
|
|
484 |
</div>
|
|
|
485 |
<a name="methodgetIdsAvecUnTag" id="getIdsAvecUnTag"><!-- --></a>
|
|
|
486 |
<div class="oddrow">
|
|
|
487 |
|
|
|
488 |
<div class="method-header">
|
|
|
489 |
<span class="method-title">getIdsAvecUnTag</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a312">312</a></span>)
|
|
|
490 |
</div>
|
|
|
491 |
|
|
|
492 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
493 |
<p class="short-description">Return an array of stored cache ids which match any given tags</p>
|
|
|
494 |
<p class="description"><p>In case of multiple tags, a logical AND is made between tags</p></p>
|
|
|
495 |
<ul class="tags">
|
|
|
496 |
<li><span class="field">return:</span> array of any matching cache ids (string)</li>
|
|
|
497 |
<li><span class="field">access:</span> public</li>
|
|
|
498 |
</ul>
|
|
|
499 |
|
|
|
500 |
<div class="method-signature">
|
|
|
501 |
<span class="method-result">array</span>
|
|
|
502 |
<span class="method-name">
|
|
|
503 |
getIdsAvecUnTag
|
|
|
504 |
</span>
|
|
|
505 |
([<span class="var-type">array</span> <span class="var-name">$tags</span> = <span class="var-default">array()</span>])
|
|
|
506 |
</div>
|
|
|
507 |
|
|
|
508 |
<ul class="parameters">
|
|
|
509 |
<li>
|
|
|
510 |
<span class="var-type">array</span>
|
|
|
511 |
<span class="var-name">$tags</span><span class="var-description">: array of tags</span> </li>
|
|
|
512 |
</ul>
|
|
|
513 |
|
|
|
514 |
|
|
|
515 |
</div>
|
|
|
516 |
<a name="methodgetIdsSansLesTags" id="getIdsSansLesTags"><!-- --></a>
|
|
|
517 |
<div class="evenrow">
|
|
|
518 |
|
|
|
519 |
<div class="method-header">
|
|
|
520 |
<span class="method-title">getIdsSansLesTags</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a280">280</a></span>)
|
|
|
521 |
</div>
|
|
|
522 |
|
|
|
523 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
524 |
<p class="short-description">Return an array of stored cache ids which don't match given tags</p>
|
|
|
525 |
<p class="description"><p>In case of multiple tags, a logical OR is made between tags</p></p>
|
|
|
526 |
<ul class="tags">
|
|
|
527 |
<li><span class="field">return:</span> array of not matching cache ids (string)</li>
|
|
|
528 |
<li><span class="field">access:</span> public</li>
|
|
|
529 |
</ul>
|
|
|
530 |
|
|
|
531 |
<div class="method-signature">
|
|
|
532 |
<span class="method-result">array</span>
|
|
|
533 |
<span class="method-name">
|
|
|
534 |
getIdsSansLesTags
|
|
|
535 |
</span>
|
|
|
536 |
([<span class="var-type">array</span> <span class="var-name">$tags</span> = <span class="var-default">array()</span>])
|
|
|
537 |
</div>
|
|
|
538 |
|
|
|
539 |
<ul class="parameters">
|
|
|
540 |
<li>
|
|
|
541 |
<span class="var-type">array</span>
|
|
|
542 |
<span class="var-name">$tags</span><span class="var-description">: array of tags</span> </li>
|
|
|
543 |
</ul>
|
|
|
544 |
|
|
|
545 |
|
|
|
546 |
</div>
|
|
|
547 |
<a name="methodgetMetadonnees" id="getMetadonnees"><!-- --></a>
|
|
|
548 |
<div class="oddrow">
|
|
|
549 |
|
|
|
550 |
<div class="method-header">
|
|
|
551 |
<span class="method-title">getMetadonnees</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a373">373</a></span>)
|
|
|
552 |
</div>
|
|
|
553 |
|
|
|
554 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
555 |
<p class="short-description">Return an array of metadatas for the given cache id</p>
|
|
|
556 |
<p class="description"><p>The array must include these keys : <ul><li>expire : the expire timestamp</li><li>tags : a string array of tags</li><li>mtime : timestamp of last modification time</li></ul></p></p>
|
|
|
557 |
<ul class="tags">
|
|
|
558 |
<li><span class="field">return:</span> array of metadatas (false if the cache id is not found)</li>
|
|
|
559 |
<li><span class="field">access:</span> public</li>
|
|
|
560 |
</ul>
|
|
|
561 |
|
|
|
562 |
<div class="method-signature">
|
|
|
563 |
<span class="method-result">array</span>
|
|
|
564 |
<span class="method-name">
|
|
|
565 |
getMetadonnees
|
|
|
566 |
</span>
|
|
|
567 |
(<span class="var-type">string</span> <span class="var-name">$id</span>)
|
|
|
568 |
</div>
|
|
|
569 |
|
|
|
570 |
<ul class="parameters">
|
|
|
571 |
<li>
|
|
|
572 |
<span class="var-type">string</span>
|
|
|
573 |
<span class="var-name">$id</span><span class="var-description">: cache id</span> </li>
|
|
|
574 |
</ul>
|
|
|
575 |
|
|
|
576 |
|
|
|
577 |
</div>
|
|
|
578 |
<a name="methodgetPourcentageRemplissage" id="getPourcentageRemplissage"><!-- --></a>
|
|
|
579 |
<div class="evenrow">
|
|
|
580 |
|
|
|
581 |
<div class="method-header">
|
|
|
582 |
<span class="method-title">getPourcentageRemplissage</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a348">348</a></span>)
|
|
|
583 |
</div>
|
|
|
584 |
|
|
|
585 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
586 |
<p class="short-description">Return the filling percentage of the backend storage</p>
|
|
|
587 |
<ul class="tags">
|
|
|
588 |
<li><span class="field">return:</span> integer between 0 and 100</li>
|
|
|
589 |
<li><span class="field">throws:</span> Zend_Cache_Exception</li>
|
|
|
590 |
<li><span class="field">access:</span> public</li>
|
|
|
591 |
</ul>
|
|
|
592 |
|
|
|
593 |
<div class="method-signature">
|
|
|
594 |
<span class="method-result">int</span>
|
|
|
595 |
<span class="method-name">
|
|
|
596 |
getPourcentageRemplissage
|
|
|
597 |
</span>
|
|
|
598 |
()
|
|
|
599 |
</div>
|
|
|
600 |
|
|
|
601 |
|
|
|
602 |
|
|
|
603 |
</div>
|
|
|
604 |
<a name="methodgetTags" id="getTags"><!-- --></a>
|
|
|
605 |
<div class="oddrow">
|
|
|
606 |
|
|
|
607 |
<div class="method-header">
|
|
|
608 |
<span class="method-title">getTags</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a224">224</a></span>)
|
|
|
609 |
</div>
|
|
|
610 |
|
|
|
611 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
612 |
<p class="short-description">Return an array of stored tags</p>
|
|
|
613 |
<ul class="tags">
|
|
|
614 |
<li><span class="field">return:</span> array of stored tags (string)</li>
|
|
|
615 |
<li><span class="field">access:</span> public</li>
|
|
|
616 |
</ul>
|
|
|
617 |
|
|
|
618 |
<div class="method-signature">
|
|
|
619 |
<span class="method-result">array</span>
|
|
|
620 |
<span class="method-name">
|
|
|
621 |
getTags
|
|
|
622 |
</span>
|
|
|
623 |
()
|
|
|
624 |
</div>
|
|
|
625 |
|
|
|
626 |
|
|
|
627 |
|
|
|
628 |
</div>
|
|
|
629 |
<a name="methodnettoyer" id="nettoyer"><!-- --></a>
|
|
|
630 |
<div class="evenrow">
|
|
|
631 |
|
|
|
632 |
<div class="method-header">
|
|
|
633 |
<span class="method-title">nettoyer</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a197">197</a></span>)
|
|
|
634 |
</div>
|
|
|
635 |
|
|
|
636 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
637 |
<p class="short-description">Clean some cache records</p>
|
|
|
638 |
<p class="description"><p>Available modes are : Zend_Cache::CLEANING_MODE_ALL (default) => remove all cache entries ($tags is not used) Zend_Cache::CLEANING_MODE_OLD => remove too old cache entries ($tags is not used) Zend_Cache::CLEANING_MODE_MATCHING_TAG => remove cache entries matching all given tags ($tags can be an array of strings or a single string) Zend_Cache::CLEANING_MODE_NOT_MATCHING_TAG => remove cache entries not {matching one of the given tags} ($tags can be an array of strings or a single string) Zend_Cache::CLEANING_MODE_MATCHING_ANY_TAG => remove cache entries matching any given tags ($tags can be an array of strings or a single string)</p></p>
|
|
|
639 |
<ul class="tags">
|
|
|
640 |
<li><span class="field">return:</span> True if no problem</li>
|
|
|
641 |
<li><span class="field">access:</span> public</li>
|
|
|
642 |
</ul>
|
|
|
643 |
|
|
|
644 |
<div class="method-signature">
|
|
|
645 |
<span class="method-result">boolean</span>
|
|
|
646 |
<span class="method-name">
|
|
|
647 |
nettoyer
|
|
|
648 |
</span>
|
|
|
649 |
([<span class="var-type">string</span> <span class="var-name">$mode</span> = <span class="var-default">Cache::NETTOYAGE_MODE_TOUS</span>], [<span class="var-type">array</span> <span class="var-name">$tags</span> = <span class="var-default">array()</span>])
|
|
|
650 |
</div>
|
|
|
651 |
|
|
|
652 |
<ul class="parameters">
|
|
|
653 |
<li>
|
|
|
654 |
<span class="var-type">string</span>
|
|
|
655 |
<span class="var-name">$mode</span><span class="var-description">: Clean mode</span> </li>
|
|
|
656 |
<li>
|
|
|
657 |
<span class="var-type">array</span>
|
|
|
658 |
<span class="var-name">$tags</span><span class="var-description">: Array of tags</span> </li>
|
|
|
659 |
</ul>
|
|
|
660 |
|
|
|
661 |
|
|
|
662 |
</div>
|
|
|
663 |
<a name="methodsauver" id="sauver"><!-- --></a>
|
|
|
664 |
<div class="oddrow">
|
|
|
665 |
|
|
|
666 |
<div class="method-header">
|
|
|
667 |
<span class="method-title">sauver</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a140">140</a></span>)
|
|
|
668 |
</div>
|
|
|
669 |
|
|
|
670 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
671 |
<p class="short-description">Save some string datas into a cache record</p>
|
|
|
672 |
<p class="description"><p>Note : $data is always "string" (serialization is done by the core not by the backend)</p></p>
|
|
|
673 |
<ul class="tags">
|
|
|
674 |
<li><span class="field">return:</span> True if no problem</li>
|
|
|
675 |
<li><span class="field">throws:</span> Zend_Cache_Exception</li>
|
|
|
676 |
<li><span class="field">access:</span> public</li>
|
|
|
677 |
</ul>
|
|
|
678 |
|
|
|
679 |
<div class="method-signature">
|
|
|
680 |
<span class="method-result">boolean</span>
|
|
|
681 |
<span class="method-name">
|
|
|
682 |
sauver
|
|
|
683 |
</span>
|
|
|
684 |
(<span class="var-type"></span> <span class="var-name">$donnees</span>, <span class="var-type">string</span> <span class="var-name">$id</span>, [<span class="var-type">array</span> <span class="var-name">$tags</span> = <span class="var-default">array()</span>], [<span class="var-type"></span> <span class="var-name">$duree_vie_specifique</span> = <span class="var-default">false</span>], <span class="var-type">string</span> <span class="var-name">$data</span>, <span class="var-type">int</span> <span class="var-name">$specificLifetime</span>)
|
|
|
685 |
</div>
|
|
|
686 |
|
|
|
687 |
<ul class="parameters">
|
|
|
688 |
<li>
|
|
|
689 |
<span class="var-type">string</span>
|
|
|
690 |
<span class="var-name">$data</span><span class="var-description">: Datas to cache</span> </li>
|
|
|
691 |
<li>
|
|
|
692 |
<span class="var-type">string</span>
|
|
|
693 |
<span class="var-name">$id</span><span class="var-description">: Cache id</span> </li>
|
|
|
694 |
<li>
|
|
|
695 |
<span class="var-type">array</span>
|
|
|
696 |
<span class="var-name">$tags</span><span class="var-description">: Array of strings, the cache record will be tagged by each string entry</span> </li>
|
|
|
697 |
<li>
|
|
|
698 |
<span class="var-type">int</span>
|
|
|
699 |
<span class="var-name">$specificLifetime</span><span class="var-description">: If != false, set a specific lifetime for this cache record (null => infinite lifetime)</span> </li>
|
|
|
700 |
<li>
|
|
|
701 |
<span class="var-type"></span>
|
|
|
702 |
<span class="var-name">$donnees</span> </li>
|
|
|
703 |
<li>
|
|
|
704 |
<span class="var-type"></span>
|
|
|
705 |
<span class="var-name">$duree_vie_specifique</span> </li>
|
|
|
706 |
</ul>
|
|
|
707 |
|
|
|
708 |
|
|
|
709 |
</div>
|
|
|
710 |
<a name="methodsetEmplacement" id="setEmplacement"><!-- --></a>
|
|
|
711 |
<div class="evenrow">
|
|
|
712 |
|
|
|
713 |
<div class="method-header">
|
|
|
714 |
<span class="method-title">setEmplacement</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a88">88</a></span>)
|
|
|
715 |
</div>
|
|
|
716 |
|
|
|
717 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
718 |
<ul class="tags">
|
|
|
719 |
<li><span class="field">access:</span> public</li>
|
|
|
720 |
</ul>
|
|
|
721 |
|
|
|
722 |
<div class="method-signature">
|
|
|
723 |
<span class="method-result">void</span>
|
|
|
724 |
<span class="method-name">
|
|
|
725 |
setEmplacement
|
|
|
726 |
</span>
|
|
|
727 |
(<span class="var-type"></span> <span class="var-name">$emplacement</span>)
|
|
|
728 |
</div>
|
|
|
729 |
|
|
|
730 |
<ul class="parameters">
|
|
|
731 |
<li>
|
|
|
732 |
<span class="var-type"></span>
|
|
|
733 |
<span class="var-name">$emplacement</span> </li>
|
|
|
734 |
</ul>
|
|
|
735 |
|
|
|
736 |
|
|
|
737 |
</div>
|
|
|
738 |
<a name="methodsupprimer" id="supprimer"><!-- --></a>
|
|
|
739 |
<div class="oddrow">
|
|
|
740 |
|
|
|
741 |
<div class="method-header">
|
|
|
742 |
<span class="method-title">supprimer</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a170">170</a></span>)
|
|
|
743 |
</div>
|
|
|
744 |
|
|
|
745 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
746 |
<p class="short-description">Remove a cache record</p>
|
|
|
747 |
<ul class="tags">
|
|
|
748 |
<li><span class="field">return:</span> True if no problem</li>
|
|
|
749 |
<li><span class="field">access:</span> public</li>
|
|
|
750 |
</ul>
|
|
|
751 |
|
|
|
752 |
<div class="method-signature">
|
|
|
753 |
<span class="method-result">boolean</span>
|
|
|
754 |
<span class="method-name">
|
|
|
755 |
supprimer
|
|
|
756 |
</span>
|
|
|
757 |
(<span class="var-type">string</span> <span class="var-name">$id</span>)
|
|
|
758 |
</div>
|
|
|
759 |
|
|
|
760 |
<ul class="parameters">
|
|
|
761 |
<li>
|
|
|
762 |
<span class="var-type">string</span>
|
|
|
763 |
<span class="var-name">$id</span><span class="var-description">: Cache id</span> </li>
|
|
|
764 |
</ul>
|
|
|
765 |
|
|
|
766 |
|
|
|
767 |
</div>
|
|
|
768 |
<a name="methodtester" id="tester"><!-- --></a>
|
|
|
769 |
<div class="evenrow">
|
|
|
770 |
|
|
|
771 |
<div class="method-header">
|
|
|
772 |
<span class="method-title">tester</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a119">119</a></span>)
|
|
|
773 |
</div>
|
|
|
774 |
|
|
|
775 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
776 |
<p class="short-description">Test if a cache is available or not (for the given id)</p>
|
|
|
777 |
<ul class="tags">
|
|
|
778 |
<li><span class="field">return:</span> (a cache is not available) or "last modified" timestamp (int) of the available cache record</li>
|
|
|
779 |
<li><span class="field">access:</span> public</li>
|
|
|
780 |
</ul>
|
|
|
781 |
|
|
|
782 |
<div class="method-signature">
|
|
|
783 |
<span class="method-result">mixed|false</span>
|
|
|
784 |
<span class="method-name">
|
|
|
785 |
tester
|
|
|
786 |
</span>
|
|
|
787 |
(<span class="var-type">string</span> <span class="var-name">$id</span>)
|
|
|
788 |
</div>
|
|
|
789 |
|
|
|
790 |
<ul class="parameters">
|
|
|
791 |
<li>
|
|
|
792 |
<span class="var-type">string</span>
|
|
|
793 |
<span class="var-name">$id</span><span class="var-description">: Cache id</span> </li>
|
|
|
794 |
</ul>
|
|
|
795 |
|
|
|
796 |
|
|
|
797 |
</div>
|
|
|
798 |
|
|
|
799 |
</div>
|
|
|
800 |
</div>
|
|
|
801 |
|
|
|
802 |
|
|
|
803 |
<p class="notes" id="credit">
|
|
|
804 |
Documentation generated on Tue, 18 Jan 2011 15:01:27 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
|
|
|
805 |
</p>
|
|
|
806 |
</div></body>
|
|
|
807 |
</html>
|