| 464 |
jpm |
1 |
<!DOCTYPE html>
|
|
|
2 |
<html>
|
|
|
3 |
<head>
|
|
|
4 |
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
|
5 |
<meta name="generator" content="ApiGen 2.8.0">
|
|
|
6 |
|
|
|
7 |
<title>Class Cache | TBFramework - v0.4</title>
|
|
|
8 |
|
|
|
9 |
<script type="text/javascript" src="resources/combined.js?4205936287"></script>
|
|
|
10 |
<script type="text/javascript" src="elementlist.js?1964084359"></script>
|
|
|
11 |
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360">
|
|
|
12 |
|
|
|
13 |
</head>
|
|
|
14 |
|
|
|
15 |
<body>
|
|
|
16 |
<div id="left">
|
|
|
17 |
<div id="menu">
|
|
|
18 |
<a href="index.html" title="Overview"><span>Overview</span></a>
|
|
|
19 |
|
|
|
20 |
|
|
|
21 |
<div id="groups">
|
|
|
22 |
<h3>Packages</h3>
|
|
|
23 |
<ul>
|
|
|
24 |
<li class="active"><a href="package-Framework.html">Framework</a>
|
|
|
25 |
</li>
|
|
|
26 |
<li><a href="package-None.html">None</a>
|
|
|
27 |
</li>
|
|
|
28 |
<li><a href="package-PHP.html">PHP</a>
|
|
|
29 |
</li>
|
|
|
30 |
<li><a href="package-Utilitaire.html">Utilitaire</a>
|
|
|
31 |
</li>
|
|
|
32 |
</ul>
|
|
|
33 |
</div>
|
|
|
34 |
|
|
|
35 |
<hr>
|
|
|
36 |
|
|
|
37 |
|
|
|
38 |
<div id="elements">
|
|
|
39 |
<h3>Classes</h3>
|
|
|
40 |
<ul>
|
|
|
41 |
<li><a href="class-Bdd.html">Bdd</a></li>
|
|
|
42 |
<li class="active"><a href="class-Cache.html">Cache</a></li>
|
|
|
43 |
<li><a href="class-CacheSimple.html">CacheSimple</a></li>
|
|
|
44 |
<li><a href="class-Chronometre.html">Chronometre</a></li>
|
|
|
45 |
<li><a href="class-Cli.html">Cli</a></li>
|
|
|
46 |
<li><a href="class-Config.html">Config</a></li>
|
|
|
47 |
<li><a href="class-Controleur.html">Controleur</a></li>
|
|
|
48 |
<li><a href="class-Debug.html">Debug</a></li>
|
|
|
49 |
<li><a href="class-Framework.html">Framework</a></li>
|
|
|
50 |
<li><a href="class-GestionnaireException.html">GestionnaireException</a></li>
|
|
|
51 |
<li><a href="class-I18n.html">I18n</a></li>
|
|
|
52 |
<li><a href="class-Log.html">Log</a></li>
|
|
|
53 |
<li><a href="class-MonService.html">MonService</a></li>
|
|
|
54 |
<li><a href="class-Registre.html">Registre</a></li>
|
|
|
55 |
<li><a href="class-RestClient.html">RestClient</a></li>
|
|
|
56 |
<li><a href="class-RestServeur.html">RestServeur</a></li>
|
|
|
57 |
<li><a href="class-RestService.html">RestService</a></li>
|
|
|
58 |
<li><a href="class-Script.html">Script</a></li>
|
|
|
59 |
<li><a href="class-ServiceCacheFichier.html">ServiceCacheFichier</a></li>
|
|
|
60 |
<li><a href="class-ServiceCacheSimple.html">ServiceCacheSimple</a></li>
|
|
|
61 |
<li><a href="class-ServiceCacheSqlite.html">ServiceCacheSqlite</a></li>
|
|
|
62 |
<li><a href="class-SquelettePhp.html">SquelettePhp</a></li>
|
|
|
63 |
<li><a href="class-Url.html">Url</a></li>
|
|
|
64 |
</ul>
|
|
|
65 |
|
|
|
66 |
|
|
|
67 |
|
|
|
68 |
|
|
|
69 |
|
|
|
70 |
</div>
|
|
|
71 |
</div>
|
|
|
72 |
</div>
|
|
|
73 |
|
|
|
74 |
<div id="splitter"></div>
|
|
|
75 |
|
|
|
76 |
<div id="right">
|
|
|
77 |
<div id="rightInner">
|
|
|
78 |
<form id="search">
|
|
|
79 |
<input type="hidden" name="cx" value="">
|
|
|
80 |
<input type="hidden" name="ie" value="UTF-8">
|
|
|
81 |
<input type="text" name="q" class="text">
|
|
|
82 |
<input type="submit" value="Search">
|
|
|
83 |
</form>
|
|
|
84 |
|
|
|
85 |
<div id="navigation">
|
|
|
86 |
<ul>
|
|
|
87 |
<li>
|
|
|
88 |
<a href="index.html" title="Overview"><span>Overview</span></a>
|
|
|
89 |
</li>
|
|
|
90 |
<li>
|
|
|
91 |
<a href="package-Framework.html" title="Summary of Framework"><span>Package</span></a>
|
|
|
92 |
</li>
|
|
|
93 |
<li class="active">
|
|
|
94 |
<span>Class</span> </li>
|
|
|
95 |
</ul>
|
|
|
96 |
<ul>
|
|
|
97 |
<li>
|
|
|
98 |
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
|
|
|
99 |
</li>
|
|
|
100 |
<li>
|
|
|
101 |
<a href="deprecated.html" title="List of deprecated elements"><span>Deprecated</span></a>
|
|
|
102 |
</li>
|
|
|
103 |
<li>
|
|
|
104 |
<a href="todo.html" title="Todo list"><span>Todo</span></a>
|
|
|
105 |
</li>
|
|
|
106 |
</ul>
|
|
|
107 |
<ul>
|
|
|
108 |
</ul>
|
|
|
109 |
</div>
|
|
|
110 |
|
|
|
111 |
<div id="content" class="class">
|
|
|
112 |
<h1>Class Cache</h1>
|
|
|
113 |
|
|
|
114 |
|
|
|
115 |
<div class="description">
|
|
|
116 |
|
|
|
117 |
<p>Classe Cache permettant de mettre en cache des données. Basée sur les
|
|
|
118 |
principes de Zend_Cache (Copyright (c) 2005-2010, Zend Technologies USA, Inc.
|
|
|
119 |
All rights reserved.)</p>
|
|
|
120 |
|
|
|
121 |
</div>
|
|
|
122 |
|
|
|
123 |
|
|
|
124 |
|
|
|
125 |
|
|
|
126 |
|
|
|
127 |
|
|
|
128 |
|
|
|
129 |
|
|
|
130 |
|
|
|
131 |
<div class="info">
|
|
|
132 |
|
|
|
133 |
|
|
|
134 |
|
|
|
135 |
<b>Package:</b> <a href="package-Framework.html">Framework</a><br>
|
|
|
136 |
|
|
|
137 |
<b>Category:</b>
|
|
|
138 |
php 5.2<br>
|
|
|
139 |
<b>Copyright:</b>
|
|
|
140 |
Copyright (c) 2010, Tela Botanica (<a
|
|
|
141 |
href="mailto:accueil@tela-botanica.org">accueil@<!-- -->tela-botanica.org</a>)<br>
|
|
|
142 |
<b>License:</b>
|
|
|
143 |
<a href="http://framework.zend.com/license/new-bsd">Licence New BSD</a><br>
|
|
|
144 |
<b>License:</b>
|
|
|
145 |
<a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL</a><br>
|
|
|
146 |
<b>License:</b>
|
|
|
147 |
<a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL</a><br>
|
|
|
148 |
<b>Author:</b>
|
|
|
149 |
Jean-Pascal MILCENT <<a
|
|
|
150 |
href="mailto:jpm@tela-botanica.org">jpm@<!-- -->tela-botanica.org</a>><br>
|
|
|
151 |
<b>Version:</b>
|
|
|
152 |
$Id: Cache.php 299 2011-01-18 14:03:46Z jpm $<br>
|
|
|
153 |
<b>Link:</b>
|
|
|
154 |
/doc/framework/<br>
|
|
|
155 |
<b>Located at</b> <a href="source-class-Cache.html#3-507" title="Go to source code">framework/Cache.php</a><br>
|
|
|
156 |
</div>
|
|
|
157 |
|
|
|
158 |
|
|
|
159 |
|
|
|
160 |
<table class="summary" id="methods">
|
|
|
161 |
<caption>Methods summary</caption>
|
|
|
162 |
<tr data-order="__construct" id="___construct">
|
|
|
163 |
|
|
|
164 |
<td class="attributes"><code>
|
|
|
165 |
public
|
|
|
166 |
|
|
|
167 |
|
|
|
168 |
</code>
|
|
|
169 |
</td>
|
|
|
170 |
|
|
|
171 |
<td class="name"><div>
|
|
|
172 |
<a class="anchor" href="#___construct">#</a>
|
|
|
173 |
<code><a href="source-class-Cache.html#98-110" title="Go to source code">__construct</a>( <span>mixed <var>$options</var> = <span class="php-keyword1">array</span>()</span>, <span>mixed <var>$options_stockage</var> = <span class="php-keyword1">array</span>()</span> )</code>
|
|
|
174 |
|
|
|
175 |
<div class="description short">
|
|
|
176 |
|
|
|
177 |
</div>
|
|
|
178 |
|
|
|
179 |
<div class="description detailed hidden">
|
|
|
180 |
|
|
|
181 |
|
|
|
182 |
|
|
|
183 |
|
|
|
184 |
|
|
|
185 |
|
|
|
186 |
|
|
|
187 |
|
|
|
188 |
</div>
|
|
|
189 |
</div></td>
|
|
|
190 |
</tr>
|
|
|
191 |
<tr data-order="setEmplacement" id="_setEmplacement">
|
|
|
192 |
|
|
|
193 |
<td class="attributes"><code>
|
|
|
194 |
public
|
|
|
195 |
|
|
|
196 |
|
|
|
197 |
</code>
|
|
|
198 |
</td>
|
|
|
199 |
|
|
|
200 |
<td class="name"><div>
|
|
|
201 |
<a class="anchor" href="#_setEmplacement">#</a>
|
|
|
202 |
<code><a href="source-class-Cache.html#132-146" title="Go to source code">setEmplacement</a>( <span>string <var>$emplacement</var></span> )</code>
|
|
|
203 |
|
|
|
204 |
<div class="description short">
|
|
|
205 |
|
|
|
206 |
<p>Permet de (re-)définir l'emplacement pour le stockage du cache. En fonction
|
|
|
207 |
du mode de stockage utilisé , l'emplacement indiqué correspondra au chemin du
|
|
|
208 |
:<br />
|
|
|
209 |
- dossier où stocker les fichiers pour le mode "fichier".<br />
|
|
|
210 |
- fichier de la base de données pour le mode "sqlite".</p>
|
|
|
211 |
|
|
|
212 |
</div>
|
|
|
213 |
|
|
|
214 |
<div class="description detailed hidden">
|
|
|
215 |
|
|
|
216 |
<p>Permet de (re-)définir l'emplacement pour le stockage du cache. En fonction
|
|
|
217 |
du mode de stockage utilisé , l'emplacement indiqué correspondra au chemin du
|
|
|
218 |
: - dossier où stocker les fichiers pour le mode "fichier". - fichier de la
|
|
|
219 |
base de données pour le mode "sqlite".</p>
|
|
|
220 |
|
|
|
221 |
|
|
|
222 |
|
|
|
223 |
<h4>Parameters</h4>
|
|
|
224 |
<div class="list"><dl>
|
|
|
225 |
<dt><var>$emplacement</var></dt>
|
|
|
226 |
<dd><code>string</code><br>$emplacement chemin vers dossier (Cache::STOCKAGE_MODE_FICHIER) ou fichier base
|
|
|
227 |
Sqlite (Cache::STOCKAGE_MODE_SQLITE)</dd>
|
|
|
228 |
</dl></div>
|
|
|
229 |
|
|
|
230 |
|
|
|
231 |
|
|
|
232 |
|
|
|
233 |
|
|
|
234 |
</div>
|
|
|
235 |
</div></td>
|
|
|
236 |
</tr>
|
|
|
237 |
<tr data-order="fabriquer" id="_fabriquer">
|
|
|
238 |
|
|
|
239 |
<td class="attributes"><code>
|
|
|
240 |
public static
|
|
|
241 |
|
|
|
242 |
|
|
|
243 |
</code>
|
|
|
244 |
</td>
|
|
|
245 |
|
|
|
246 |
<td class="name"><div>
|
|
|
247 |
<a class="anchor" href="#_fabriquer">#</a>
|
|
|
248 |
<code><a href="source-class-Cache.html#148-155" title="Go to source code">fabriquer</a>( <span>mixed <var>$mode</var></span>, <span>mixed <var>$options</var> = <span class="php-keyword1">array</span>()</span> )</code>
|
|
|
249 |
|
|
|
250 |
<div class="description short">
|
|
|
251 |
|
|
|
252 |
</div>
|
|
|
253 |
|
|
|
254 |
<div class="description detailed hidden">
|
|
|
255 |
|
|
|
256 |
|
|
|
257 |
|
|
|
258 |
|
|
|
259 |
|
|
|
260 |
|
|
|
261 |
|
|
|
262 |
|
|
|
263 |
</div>
|
|
|
264 |
</div></td>
|
|
|
265 |
</tr>
|
|
|
266 |
<tr data-order="charger" id="_charger">
|
|
|
267 |
|
|
|
268 |
<td class="attributes"><code>
|
|
|
269 |
public
|
|
|
270 |
mixed|false
|
|
|
271 |
|
|
|
272 |
</code>
|
|
|
273 |
</td>
|
|
|
274 |
|
|
|
275 |
<td class="name"><div>
|
|
|
276 |
<a class="anchor" href="#_charger">#</a>
|
|
|
277 |
<code><a href="source-class-Cache.html#157-174" title="Go to source code">charger</a>( <span>string <var>$id</var></span>, <span>boolean <var>$ne_pas_tester_validiter_du_cache</var> = <span class="php-keyword1">false</span></span> )</code>
|
|
|
278 |
|
|
|
279 |
<div class="description short">
|
|
|
280 |
|
|
|
281 |
<p>Teste si un cache est disponible pour l'identifiant donné et (si oui) le
|
|
|
282 |
retourne (false dans le cas contraire)</p>
|
|
|
283 |
|
|
|
284 |
</div>
|
|
|
285 |
|
|
|
286 |
<div class="description detailed hidden">
|
|
|
287 |
|
|
|
288 |
<p>Teste si un cache est disponible pour l'identifiant donné et (si oui) le
|
|
|
289 |
retourne (false dans le cas contraire)</p>
|
|
|
290 |
|
|
|
291 |
|
|
|
292 |
|
|
|
293 |
<h4>Parameters</h4>
|
|
|
294 |
<div class="list"><dl>
|
|
|
295 |
<dt><var>$id</var></dt>
|
|
|
296 |
<dd><code>string</code><br>$id Identifiant de cache.</dd>
|
|
|
297 |
<dt><var>$ne_pas_tester_validiter_du_cache</var></dt>
|
|
|
298 |
<dd><code>boolean</code><br>$ne_pas_tester_validiter_du_cache Si mis à true, la validité du cache n'est
|
|
|
299 |
pas testée</dd>
|
|
|
300 |
</dl></div>
|
|
|
301 |
|
|
|
302 |
<h4>Returns</h4>
|
|
|
303 |
<div class="list">
|
|
|
304 |
<code>mixed|false</code><br>Cached datas<br>
|
|
|
305 |
</div>
|
|
|
306 |
|
|
|
307 |
|
|
|
308 |
|
|
|
309 |
|
|
|
310 |
</div>
|
|
|
311 |
</div></td>
|
|
|
312 |
</tr>
|
|
|
313 |
<tr data-order="tester" id="_tester">
|
|
|
314 |
|
|
|
315 |
<td class="attributes"><code>
|
|
|
316 |
public
|
|
|
317 |
integer|false
|
|
|
318 |
|
|
|
319 |
</code>
|
|
|
320 |
</td>
|
|
|
321 |
|
|
|
322 |
<td class="name"><div>
|
|
|
323 |
<a class="anchor" href="#_tester">#</a>
|
|
|
324 |
<code><a href="source-class-Cache.html#176-191" title="Go to source code">tester</a>( <span>string <var>$id</var></span> )</code>
|
|
|
325 |
|
|
|
326 |
<div class="description short">
|
|
|
327 |
|
|
|
328 |
<p>Test if a cache is available for the given id</p>
|
|
|
329 |
|
|
|
330 |
</div>
|
|
|
331 |
|
|
|
332 |
<div class="description detailed hidden">
|
|
|
333 |
|
|
|
334 |
<p>Test if a cache is available for the given id</p>
|
|
|
335 |
|
|
|
336 |
|
|
|
337 |
|
|
|
338 |
<h4>Parameters</h4>
|
|
|
339 |
<div class="list"><dl>
|
|
|
340 |
<dt><var>$id</var></dt>
|
|
|
341 |
<dd><code>string</code><br>$id Cache id</dd>
|
|
|
342 |
</dl></div>
|
|
|
343 |
|
|
|
344 |
<h4>Returns</h4>
|
|
|
345 |
<div class="list">
|
|
|
346 |
<code>integer|false</code><br>Last modified time of cache entry if it is available, false otherwise<br>
|
|
|
347 |
</div>
|
|
|
348 |
|
|
|
349 |
|
|
|
350 |
|
|
|
351 |
|
|
|
352 |
</div>
|
|
|
353 |
</div></td>
|
|
|
354 |
</tr>
|
|
|
355 |
<tr data-order="sauver" id="_sauver">
|
|
|
356 |
|
|
|
357 |
<td class="attributes"><code>
|
|
|
358 |
public
|
|
|
359 |
boolean
|
|
|
360 |
|
|
|
361 |
</code>
|
|
|
362 |
</td>
|
|
|
363 |
|
|
|
364 |
<td class="name"><div>
|
|
|
365 |
<a class="anchor" href="#_sauver">#</a>
|
|
|
366 |
<code><a href="source-class-Cache.html#193-222" title="Go to source code">sauver</a>( <span>mixed <var>$donnees</var></span>, <span>string <var>$id</var> = <span class="php-keyword1">null</span></span>, <span>array <var>$tags</var> = <span class="php-keyword1">array</span>()</span>, <span>integer <var>$duree_de_vie_specifique</var> = <span class="php-keyword1">false</span></span> )</code>
|
|
|
367 |
|
|
|
368 |
<div class="description short">
|
|
|
369 |
|
|
|
370 |
<p>Sauvegarde en cache les données passées en paramètre.</p>
|
|
|
371 |
|
|
|
372 |
</div>
|
|
|
373 |
|
|
|
374 |
<div class="description detailed hidden">
|
|
|
375 |
|
|
|
376 |
<p>Sauvegarde en cache les données passées en paramètre.</p>
|
|
|
377 |
|
|
|
378 |
|
|
|
379 |
|
|
|
380 |
<h4>Parameters</h4>
|
|
|
381 |
<div class="list"><dl>
|
|
|
382 |
<dt><var>$donnees</var></dt>
|
|
|
383 |
<dd><code>mixed</code><br>$donnees Données à mettre en cache (peut être différent d'une chaine si
|
|
|
384 |
serialisation_auto vaut true).</dd>
|
|
|
385 |
<dt><var>$id</var></dt>
|
|
|
386 |
<dd><code>string</code><br>$id Identifiant du cache (s'il n'est pas définit, le dernier identifiant sera
|
|
|
387 |
utilisé).</dd>
|
|
|
388 |
<dt><var>$tags</var></dt>
|
|
|
389 |
<dd><code>array</code><br>$tags Mots-clés du cache.</dd>
|
|
|
390 |
<dt><var>$duree_de_vie_specifique</var></dt>
|
|
|
391 |
<dd><code>integer</code><br>$duree_de_vie_specifique Si != false, indique une durée de vie spécifique pour
|
|
|
392 |
cet enregistrement en cache (null => durée de vie infinie)</dd>
|
|
|
393 |
</dl></div>
|
|
|
394 |
|
|
|
395 |
<h4>Returns</h4>
|
|
|
396 |
<div class="list">
|
|
|
397 |
<code>boolean</code><br>True si aucun problème n'est survenu.<br>
|
|
|
398 |
</div>
|
|
|
399 |
|
|
|
400 |
|
|
|
401 |
|
|
|
402 |
|
|
|
403 |
</div>
|
|
|
404 |
</div></td>
|
|
|
405 |
</tr>
|
|
|
406 |
<tr data-order="supprimer" id="_supprimer">
|
|
|
407 |
|
|
|
408 |
<td class="attributes"><code>
|
|
|
409 |
public
|
|
|
410 |
boolean
|
|
|
411 |
|
|
|
412 |
</code>
|
|
|
413 |
</td>
|
|
|
414 |
|
|
|
415 |
<td class="name"><div>
|
|
|
416 |
<a class="anchor" href="#_supprimer">#</a>
|
|
|
417 |
<code><a href="source-class-Cache.html#224-238" title="Go to source code">supprimer</a>( <span>string <var>$id</var></span> )</code>
|
|
|
418 |
|
|
|
419 |
<div class="description short">
|
|
|
420 |
|
|
|
421 |
<p>Supprime un enregistrement en cache.</p>
|
|
|
422 |
|
|
|
423 |
</div>
|
|
|
424 |
|
|
|
425 |
<div class="description detailed hidden">
|
|
|
426 |
|
|
|
427 |
<p>Supprime un enregistrement en cache.</p>
|
|
|
428 |
|
|
|
429 |
|
|
|
430 |
|
|
|
431 |
<h4>Parameters</h4>
|
|
|
432 |
<div class="list"><dl>
|
|
|
433 |
<dt><var>$id</var></dt>
|
|
|
434 |
<dd><code>string</code><br>$id Identificant du cache à supprimer.</dd>
|
|
|
435 |
</dl></div>
|
|
|
436 |
|
|
|
437 |
<h4>Returns</h4>
|
|
|
438 |
<div class="list">
|
|
|
439 |
<code>boolean</code><br>True si ok<br>
|
|
|
440 |
</div>
|
|
|
441 |
|
|
|
442 |
|
|
|
443 |
|
|
|
444 |
|
|
|
445 |
</div>
|
|
|
446 |
</div></td>
|
|
|
447 |
</tr>
|
|
|
448 |
<tr data-order="nettoyer" id="_nettoyer">
|
|
|
449 |
|
|
|
450 |
<td class="attributes"><code>
|
|
|
451 |
public
|
|
|
452 |
boolean
|
|
|
453 |
|
|
|
454 |
</code>
|
|
|
455 |
</td>
|
|
|
456 |
|
|
|
457 |
<td class="name"><div>
|
|
|
458 |
<a class="anchor" href="#_nettoyer">#</a>
|
|
|
459 |
<code><a href="source-class-Cache.html#240-269" title="Go to source code">nettoyer</a>( <span>string <var>$mode</var> = <code><a href="class-Cache.html#NETTOYAGE_MODE_TOUS">Cache::<b>NETTOYAGE_MODE_TOUS</b></a></code></span>, <span>array|string <var>$tags</var> = <span class="php-keyword1">array</span>()</span> )</code>
|
|
|
460 |
|
|
|
461 |
<div class="description short">
|
|
|
462 |
|
|
|
463 |
<p>Nettoyage des enregistrements en cache</p>
|
|
|
464 |
|
|
|
465 |
</div>
|
|
|
466 |
|
|
|
467 |
<div class="description detailed hidden">
|
|
|
468 |
|
|
|
469 |
<p>Nettoyage des enregistrements en cache</p>
|
|
|
470 |
|
|
|
471 |
<p>Mode de nettoyage disponibles : 'tous' (défaut) => supprime tous les
|
|
|
472 |
enregistrements ($tags n'est pas utilisé) 'expiration' => supprime tous les
|
|
|
473 |
enregistrements dont la date d'expériration est dépassée ($tags n'est pas
|
|
|
474 |
utilisé) 'avecLesTag' => supprime tous les enregistrements contenant tous
|
|
|
475 |
les tags indiqués 'sansLesTag' => supprime tous les enregistrements
|
|
|
476 |
contenant aucun des tags indiqués 'avecUnTag' => supprime tous les
|
|
|
477 |
enregistrements contenant au moins un des tags indiqués</p>
|
|
|
478 |
|
|
|
479 |
|
|
|
480 |
|
|
|
481 |
<h4>Parameters</h4>
|
|
|
482 |
<div class="list"><dl>
|
|
|
483 |
<dt><var>$mode</var></dt>
|
|
|
484 |
<dd><code>string</code><br>$mode mode de nettoyage</dd>
|
|
|
485 |
<dt><var>$tags</var></dt>
|
|
|
486 |
<dd><code>array|string</code><br>$tags peut être un tableau de chaîne ou une simple chaine.</dd>
|
|
|
487 |
</dl></div>
|
|
|
488 |
|
|
|
489 |
<h4>Returns</h4>
|
|
|
490 |
<div class="list">
|
|
|
491 |
<code>boolean</code><br>True si ok<br>
|
|
|
492 |
</div>
|
|
|
493 |
|
|
|
494 |
|
|
|
495 |
|
|
|
496 |
|
|
|
497 |
</div>
|
|
|
498 |
</div></td>
|
|
|
499 |
</tr>
|
|
|
500 |
<tr data-order="getIds" id="_getIds">
|
|
|
501 |
|
|
|
502 |
<td class="attributes"><code>
|
|
|
503 |
public
|
|
|
504 |
array
|
|
|
505 |
|
|
|
506 |
</code>
|
|
|
507 |
</td>
|
|
|
508 |
|
|
|
509 |
<td class="name"><div>
|
|
|
510 |
<a class="anchor" href="#_getIds">#</a>
|
|
|
511 |
<code><a href="source-class-Cache.html#271-280" title="Go to source code">getIds</a>( )</code>
|
|
|
512 |
|
|
|
513 |
<div class="description short">
|
|
|
514 |
|
|
|
515 |
<p>Return an array of stored cache ids</p>
|
|
|
516 |
|
|
|
517 |
</div>
|
|
|
518 |
|
|
|
519 |
<div class="description detailed hidden">
|
|
|
520 |
|
|
|
521 |
<p>Return an array of stored cache ids</p>
|
|
|
522 |
|
|
|
523 |
|
|
|
524 |
|
|
|
525 |
|
|
|
526 |
<h4>Returns</h4>
|
|
|
527 |
<div class="list">
|
|
|
528 |
<code>array</code><br>array of stored cache ids (string)<br>
|
|
|
529 |
</div>
|
|
|
530 |
|
|
|
531 |
|
|
|
532 |
|
|
|
533 |
|
|
|
534 |
</div>
|
|
|
535 |
</div></td>
|
|
|
536 |
</tr>
|
|
|
537 |
<tr data-order="getTags" id="_getTags">
|
|
|
538 |
|
|
|
539 |
<td class="attributes"><code>
|
|
|
540 |
public
|
|
|
541 |
array
|
|
|
542 |
|
|
|
543 |
</code>
|
|
|
544 |
</td>
|
|
|
545 |
|
|
|
546 |
<td class="name"><div>
|
|
|
547 |
<a class="anchor" href="#_getTags">#</a>
|
|
|
548 |
<code><a href="source-class-Cache.html#282-289" title="Go to source code">getTags</a>( )</code>
|
|
|
549 |
|
|
|
550 |
<div class="description short">
|
|
|
551 |
|
|
|
552 |
<p>Return an array of stored tags</p>
|
|
|
553 |
|
|
|
554 |
</div>
|
|
|
555 |
|
|
|
556 |
<div class="description detailed hidden">
|
|
|
557 |
|
|
|
558 |
<p>Return an array of stored tags</p>
|
|
|
559 |
|
|
|
560 |
|
|
|
561 |
|
|
|
562 |
|
|
|
563 |
<h4>Returns</h4>
|
|
|
564 |
<div class="list">
|
|
|
565 |
<code>array</code><br>array of stored tags (string)<br>
|
|
|
566 |
</div>
|
|
|
567 |
|
|
|
568 |
|
|
|
569 |
|
|
|
570 |
|
|
|
571 |
</div>
|
|
|
572 |
</div></td>
|
|
|
573 |
</tr>
|
|
|
574 |
<tr data-order="getIdsAvecLesTags" id="_getIdsAvecLesTags">
|
|
|
575 |
|
|
|
576 |
<td class="attributes"><code>
|
|
|
577 |
public
|
|
|
578 |
array
|
|
|
579 |
|
|
|
580 |
</code>
|
|
|
581 |
</td>
|
|
|
582 |
|
|
|
583 |
<td class="name"><div>
|
|
|
584 |
<a class="anchor" href="#_getIdsAvecLesTags">#</a>
|
|
|
585 |
<code><a href="source-class-Cache.html#291-303" title="Go to source code">getIdsAvecLesTags</a>( <span>array <var>$tags</var> = <span class="php-keyword1">array</span>()</span> )</code>
|
|
|
586 |
|
|
|
587 |
<div class="description short">
|
|
|
588 |
|
|
|
589 |
<p>Return an array of stored cache ids which match given tags</p>
|
|
|
590 |
|
|
|
591 |
</div>
|
|
|
592 |
|
|
|
593 |
<div class="description detailed hidden">
|
|
|
594 |
|
|
|
595 |
<p>Return an array of stored cache ids which match given tags</p>
|
|
|
596 |
|
|
|
597 |
<p>In case of multiple tags, a logical AND is made between tags</p>
|
|
|
598 |
|
|
|
599 |
|
|
|
600 |
|
|
|
601 |
<h4>Parameters</h4>
|
|
|
602 |
<div class="list"><dl>
|
|
|
603 |
<dt><var>$tags</var></dt>
|
|
|
604 |
<dd><code>array</code><br>$tags array of tags</dd>
|
|
|
605 |
</dl></div>
|
|
|
606 |
|
|
|
607 |
<h4>Returns</h4>
|
|
|
608 |
<div class="list">
|
|
|
609 |
<code>array</code><br>array of matching cache ids (string)<br>
|
|
|
610 |
</div>
|
|
|
611 |
|
|
|
612 |
|
|
|
613 |
|
|
|
614 |
|
|
|
615 |
</div>
|
|
|
616 |
</div></td>
|
|
|
617 |
</tr>
|
|
|
618 |
<tr data-order="getIdsSansLesTags" id="_getIdsSansLesTags">
|
|
|
619 |
|
|
|
620 |
<td class="attributes"><code>
|
|
|
621 |
public
|
|
|
622 |
array
|
|
|
623 |
|
|
|
624 |
</code>
|
|
|
625 |
</td>
|
|
|
626 |
|
|
|
627 |
<td class="name"><div>
|
|
|
628 |
<a class="anchor" href="#_getIdsSansLesTags">#</a>
|
|
|
629 |
<code><a href="source-class-Cache.html#305-317" title="Go to source code">getIdsSansLesTags</a>( <span>array <var>$tags</var> = <span class="php-keyword1">array</span>()</span> )</code>
|
|
|
630 |
|
|
|
631 |
<div class="description short">
|
|
|
632 |
|
|
|
633 |
<p>Return an array of stored cache ids which don't match given tags</p>
|
|
|
634 |
|
|
|
635 |
</div>
|
|
|
636 |
|
|
|
637 |
<div class="description detailed hidden">
|
|
|
638 |
|
|
|
639 |
<p>Return an array of stored cache ids which don't match given tags</p>
|
|
|
640 |
|
|
|
641 |
<p>In case of multiple tags, a logical OR is made between tags</p>
|
|
|
642 |
|
|
|
643 |
|
|
|
644 |
|
|
|
645 |
<h4>Parameters</h4>
|
|
|
646 |
<div class="list"><dl>
|
|
|
647 |
<dt><var>$tags</var></dt>
|
|
|
648 |
<dd><code>array</code><br>$tags array of tags</dd>
|
|
|
649 |
</dl></div>
|
|
|
650 |
|
|
|
651 |
<h4>Returns</h4>
|
|
|
652 |
<div class="list">
|
|
|
653 |
<code>array</code><br>array of not matching cache ids (string)<br>
|
|
|
654 |
</div>
|
|
|
655 |
|
|
|
656 |
|
|
|
657 |
|
|
|
658 |
|
|
|
659 |
</div>
|
|
|
660 |
</div></td>
|
|
|
661 |
</tr>
|
|
|
662 |
<tr data-order="getIdsAvecUnTag" id="_getIdsAvecUnTag">
|
|
|
663 |
|
|
|
664 |
<td class="attributes"><code>
|
|
|
665 |
public
|
|
|
666 |
array
|
|
|
667 |
|
|
|
668 |
</code>
|
|
|
669 |
</td>
|
|
|
670 |
|
|
|
671 |
<td class="name"><div>
|
|
|
672 |
<a class="anchor" href="#_getIdsAvecUnTag">#</a>
|
|
|
673 |
<code><a href="source-class-Cache.html#319-331" title="Go to source code">getIdsAvecUnTag</a>( <span>array <var>$tags</var> = <span class="php-keyword1">array</span>()</span> )</code>
|
|
|
674 |
|
|
|
675 |
<div class="description short">
|
|
|
676 |
|
|
|
677 |
<p>Return an array of stored cache ids which match any given tags</p>
|
|
|
678 |
|
|
|
679 |
</div>
|
|
|
680 |
|
|
|
681 |
<div class="description detailed hidden">
|
|
|
682 |
|
|
|
683 |
<p>Return an array of stored cache ids which match any given tags</p>
|
|
|
684 |
|
|
|
685 |
<p>In case of multiple tags, a logical OR is made between tags</p>
|
|
|
686 |
|
|
|
687 |
|
|
|
688 |
|
|
|
689 |
<h4>Parameters</h4>
|
|
|
690 |
<div class="list"><dl>
|
|
|
691 |
<dt><var>$tags</var></dt>
|
|
|
692 |
<dd><code>array</code><br>$tags array of tags</dd>
|
|
|
693 |
</dl></div>
|
|
|
694 |
|
|
|
695 |
<h4>Returns</h4>
|
|
|
696 |
<div class="list">
|
|
|
697 |
<code>array</code><br>array of matching any cache ids (string)<br>
|
|
|
698 |
</div>
|
|
|
699 |
|
|
|
700 |
|
|
|
701 |
|
|
|
702 |
|
|
|
703 |
</div>
|
|
|
704 |
</div></td>
|
|
|
705 |
</tr>
|
|
|
706 |
<tr data-order="getPourcentageRemplissage" id="_getPourcentageRemplissage">
|
|
|
707 |
|
|
|
708 |
<td class="attributes"><code>
|
|
|
709 |
public
|
|
|
710 |
integer
|
|
|
711 |
|
|
|
712 |
</code>
|
|
|
713 |
</td>
|
|
|
714 |
|
|
|
715 |
<td class="name"><div>
|
|
|
716 |
<a class="anchor" href="#_getPourcentageRemplissage">#</a>
|
|
|
717 |
<code><a href="source-class-Cache.html#333-340" title="Go to source code">getPourcentageRemplissage</a>( )</code>
|
|
|
718 |
|
|
|
719 |
<div class="description short">
|
|
|
720 |
|
|
|
721 |
<p>Return the filling percentage of the backend storage</p>
|
|
|
722 |
|
|
|
723 |
</div>
|
|
|
724 |
|
|
|
725 |
<div class="description detailed hidden">
|
|
|
726 |
|
|
|
727 |
<p>Return the filling percentage of the backend storage</p>
|
|
|
728 |
|
|
|
729 |
|
|
|
730 |
|
|
|
731 |
|
|
|
732 |
<h4>Returns</h4>
|
|
|
733 |
<div class="list">
|
|
|
734 |
<code>integer</code><br>integer between 0 and 100<br>
|
|
|
735 |
</div>
|
|
|
736 |
|
|
|
737 |
|
|
|
738 |
|
|
|
739 |
|
|
|
740 |
</div>
|
|
|
741 |
</div></td>
|
|
|
742 |
</tr>
|
|
|
743 |
<tr data-order="getMetadonnees" id="_getMetadonnees">
|
|
|
744 |
|
|
|
745 |
<td class="attributes"><code>
|
|
|
746 |
public
|
|
|
747 |
array
|
|
|
748 |
|
|
|
749 |
</code>
|
|
|
750 |
</td>
|
|
|
751 |
|
|
|
752 |
<td class="name"><div>
|
|
|
753 |
<a class="anchor" href="#_getMetadonnees">#</a>
|
|
|
754 |
<code><a href="source-class-Cache.html#342-356" title="Go to source code">getMetadonnees</a>( <span>string <var>$id</var></span> )</code>
|
|
|
755 |
|
|
|
756 |
<div class="description short">
|
|
|
757 |
|
|
|
758 |
<p>Return an array of metadatas for the given cache id</p>
|
|
|
759 |
|
|
|
760 |
</div>
|
|
|
761 |
|
|
|
762 |
<div class="description detailed hidden">
|
|
|
763 |
|
|
|
764 |
<p>Return an array of metadatas for the given cache id</p>
|
|
|
765 |
|
|
|
766 |
<p>The array will include these keys :</p>
|
|
|
767 |
|
|
|
768 |
<ul>
|
|
|
769 |
<li>expire : the expire timestamp</li>
|
|
|
770 |
|
|
|
771 |
<li>tags : a string array of tags</li>
|
|
|
772 |
|
|
|
773 |
<li>mtime : timestamp of last modification time</li>
|
|
|
774 |
</ul>
|
|
|
775 |
|
|
|
776 |
|
|
|
777 |
|
|
|
778 |
<h4>Parameters</h4>
|
|
|
779 |
<div class="list"><dl>
|
|
|
780 |
<dt><var>$id</var></dt>
|
|
|
781 |
<dd><code>string</code><br>$id cache id</dd>
|
|
|
782 |
</dl></div>
|
|
|
783 |
|
|
|
784 |
<h4>Returns</h4>
|
|
|
785 |
<div class="list">
|
|
|
786 |
<code>array</code><br>array of metadatas (false if the cache id is not found)<br>
|
|
|
787 |
</div>
|
|
|
788 |
|
|
|
789 |
|
|
|
790 |
|
|
|
791 |
|
|
|
792 |
</div>
|
|
|
793 |
</div></td>
|
|
|
794 |
</tr>
|
|
|
795 |
<tr data-order="ajouterSupplementDureeDeVie" id="_ajouterSupplementDureeDeVie">
|
|
|
796 |
|
|
|
797 |
<td class="attributes"><code>
|
|
|
798 |
public
|
|
|
799 |
boolean
|
|
|
800 |
|
|
|
801 |
</code>
|
|
|
802 |
</td>
|
|
|
803 |
|
|
|
804 |
<td class="name"><div>
|
|
|
805 |
<a class="anchor" href="#_ajouterSupplementDureeDeVie">#</a>
|
|
|
806 |
<code><a href="source-class-Cache.html#358-368" title="Go to source code">ajouterSupplementDureeDeVie</a>( <span>string <var>$id</var></span>, <span>integer <var>$supplement_duree_de_vie</var></span> )</code>
|
|
|
807 |
|
|
|
808 |
<div class="description short">
|
|
|
809 |
|
|
|
810 |
<p>Give (if possible) an extra lifetime to the given cache id</p>
|
|
|
811 |
|
|
|
812 |
</div>
|
|
|
813 |
|
|
|
814 |
<div class="description detailed hidden">
|
|
|
815 |
|
|
|
816 |
<p>Give (if possible) an extra lifetime to the given cache id</p>
|
|
|
817 |
|
|
|
818 |
|
|
|
819 |
|
|
|
820 |
<h4>Parameters</h4>
|
|
|
821 |
<div class="list"><dl>
|
|
|
822 |
<dt><var>$id</var></dt>
|
|
|
823 |
<dd><code>string</code><br>$id cache id</dd>
|
|
|
824 |
<dt><var>$supplement_duree_de_vie</var></dt>
|
|
|
825 |
<dd><code>integer</code><br>$extraLifetime</dd>
|
|
|
826 |
</dl></div>
|
|
|
827 |
|
|
|
828 |
<h4>Returns</h4>
|
|
|
829 |
<div class="list">
|
|
|
830 |
<code>boolean</code><br>true if ok<br>
|
|
|
831 |
</div>
|
|
|
832 |
|
|
|
833 |
|
|
|
834 |
|
|
|
835 |
|
|
|
836 |
</div>
|
|
|
837 |
</div></td>
|
|
|
838 |
</tr>
|
|
|
839 |
<tr data-order="validerIdOuTag" id="_validerIdOuTag">
|
|
|
840 |
|
|
|
841 |
<td class="attributes"><code>
|
|
|
842 |
protected static
|
|
|
843 |
|
|
|
844 |
|
|
|
845 |
</code>
|
|
|
846 |
</td>
|
|
|
847 |
|
|
|
848 |
<td class="name"><div>
|
|
|
849 |
<a class="anchor" href="#_validerIdOuTag">#</a>
|
|
|
850 |
<code><a href="source-class-Cache.html#456-472" title="Go to source code">validerIdOuTag</a>( <span>string <var>$chaine</var></span> )</code>
|
|
|
851 |
|
|
|
852 |
<div class="description short">
|
|
|
853 |
|
|
|
854 |
<p>Valide un identifiant de cache ou un tag (securité, nom de fichiers fiables,
|
|
|
855 |
préfixes réservés...)</p>
|
|
|
856 |
|
|
|
857 |
</div>
|
|
|
858 |
|
|
|
859 |
<div class="description detailed hidden">
|
|
|
860 |
|
|
|
861 |
<p>Valide un identifiant de cache ou un tag (securité, nom de fichiers fiables,
|
|
|
862 |
préfixes réservés...)</p>
|
|
|
863 |
|
|
|
864 |
|
|
|
865 |
|
|
|
866 |
<h4>Parameters</h4>
|
|
|
867 |
<div class="list"><dl>
|
|
|
868 |
<dt><var>$chaine</var></dt>
|
|
|
869 |
<dd><code>string</code><br>$chaine Identificant de cache ou tag</dd>
|
|
|
870 |
</dl></div>
|
|
|
871 |
|
|
|
872 |
|
|
|
873 |
|
|
|
874 |
|
|
|
875 |
|
|
|
876 |
</div>
|
|
|
877 |
</div></td>
|
|
|
878 |
</tr>
|
|
|
879 |
<tr data-order="validerTableauDeTags" id="_validerTableauDeTags">
|
|
|
880 |
|
|
|
881 |
<td class="attributes"><code>
|
|
|
882 |
protected static
|
|
|
883 |
|
|
|
884 |
|
|
|
885 |
</code>
|
|
|
886 |
</td>
|
|
|
887 |
|
|
|
888 |
<td class="name"><div>
|
|
|
889 |
<a class="anchor" href="#_validerTableauDeTags">#</a>
|
|
|
890 |
<code><a href="source-class-Cache.html#474-488" title="Go to source code">validerTableauDeTags</a>( <span>array <var>$tags</var></span> )</code>
|
|
|
891 |
|
|
|
892 |
<div class="description short">
|
|
|
893 |
|
|
|
894 |
<p>Valide un tableau de tags (securité, nom de fichiers fiables, préfixes
|
|
|
895 |
réservés...)</p>
|
|
|
896 |
|
|
|
897 |
</div>
|
|
|
898 |
|
|
|
899 |
<div class="description detailed hidden">
|
|
|
900 |
|
|
|
901 |
<p>Valide un tableau de tags (securité, nom de fichiers fiables, préfixes
|
|
|
902 |
réservés...)</p>
|
|
|
903 |
|
|
|
904 |
|
|
|
905 |
|
|
|
906 |
<h4>Parameters</h4>
|
|
|
907 |
<div class="list"><dl>
|
|
|
908 |
<dt><var>$tags</var></dt>
|
|
|
909 |
<dd><code>array</code><br>$tags tableau de tags</dd>
|
|
|
910 |
</dl></div>
|
|
|
911 |
|
|
|
912 |
|
|
|
913 |
|
|
|
914 |
|
|
|
915 |
|
|
|
916 |
</div>
|
|
|
917 |
</div></td>
|
|
|
918 |
</tr>
|
|
|
919 |
<tr data-order="getTimestampExpiration" id="_getTimestampExpiration">
|
|
|
920 |
|
|
|
921 |
<td class="attributes"><code>
|
|
|
922 |
public
|
|
|
923 |
integer
|
|
|
924 |
|
|
|
925 |
</code>
|
|
|
926 |
</td>
|
|
|
927 |
|
|
|
928 |
<td class="name"><div>
|
|
|
929 |
<a class="anchor" href="#_getTimestampExpiration">#</a>
|
|
|
930 |
<code><a href="source-class-Cache.html#490-505" title="Go to source code">getTimestampExpiration</a>( <span>mixed <var>$duree_de_vie</var></span> )</code>
|
|
|
931 |
|
|
|
932 |
<div class="description short">
|
|
|
933 |
|
|
|
934 |
<p>Calcule et retourne le timestamp d'expiration</p>
|
|
|
935 |
|
|
|
936 |
</div>
|
|
|
937 |
|
|
|
938 |
<div class="description detailed hidden">
|
|
|
939 |
|
|
|
940 |
<p>Calcule et retourne le timestamp d'expiration</p>
|
|
|
941 |
|
|
|
942 |
|
|
|
943 |
|
|
|
944 |
|
|
|
945 |
<h4>Returns</h4>
|
|
|
946 |
<div class="list">
|
|
|
947 |
<code>integer</code><br>timestamp d'expiration (unix timestamp)<br>
|
|
|
948 |
</div>
|
|
|
949 |
|
|
|
950 |
|
|
|
951 |
|
|
|
952 |
|
|
|
953 |
</div>
|
|
|
954 |
</div></td>
|
|
|
955 |
</tr>
|
|
|
956 |
</table>
|
|
|
957 |
|
|
|
958 |
|
|
|
959 |
|
|
|
960 |
|
|
|
961 |
|
|
|
962 |
|
|
|
963 |
|
|
|
964 |
|
|
|
965 |
<table class="summary" id="constants">
|
|
|
966 |
<caption>Constants summary</caption>
|
|
|
967 |
<tr data-order="STOCKAGE_MODE_SIMPLE" id="STOCKAGE_MODE_SIMPLE">
|
|
|
968 |
|
|
|
969 |
<td class="attributes"><code>string</code></td>
|
|
|
970 |
<td class="name"><code>
|
|
|
971 |
<a href="source-class-Cache.html#18-19" title="Go to source code"><b>STOCKAGE_MODE_SIMPLE</b></a>
|
|
|
972 |
</code></td>
|
|
|
973 |
<td class="value"><code><span class="php-quote">"FichierSimple"</span></code></td>
|
|
|
974 |
<td class="description"><div>
|
|
|
975 |
<a href="#STOCKAGE_MODE_SIMPLE" class="anchor">#</a>
|
|
|
976 |
|
|
|
977 |
<div class="description short">
|
|
|
978 |
|
|
|
979 |
<p>Socke les enregistrements du cache dans des fichiers textes de façon
|
|
|
980 |
extremement simple.</p>
|
|
|
981 |
|
|
|
982 |
</div>
|
|
|
983 |
|
|
|
984 |
<div class="description detailed hidden">
|
|
|
985 |
|
|
|
986 |
<p>Socke les enregistrements du cache dans des fichiers textes de façon
|
|
|
987 |
extremement simple.</p>
|
|
|
988 |
|
|
|
989 |
|
|
|
990 |
</div>
|
|
|
991 |
</div></td>
|
|
|
992 |
</tr>
|
|
|
993 |
<tr data-order="STOCKAGE_MODE_FICHIER" id="STOCKAGE_MODE_FICHIER">
|
|
|
994 |
|
|
|
995 |
<td class="attributes"><code>string</code></td>
|
|
|
996 |
<td class="name"><code>
|
|
|
997 |
<a href="source-class-Cache.html#20-21" title="Go to source code"><b>STOCKAGE_MODE_FICHIER</b></a>
|
|
|
998 |
</code></td>
|
|
|
999 |
<td class="value"><code><span class="php-quote">"Fichier"</span></code></td>
|
|
|
1000 |
<td class="description"><div>
|
|
|
1001 |
<a href="#STOCKAGE_MODE_FICHIER" class="anchor">#</a>
|
|
|
1002 |
|
|
|
1003 |
<div class="description short">
|
|
|
1004 |
|
|
|
1005 |
<p>Socke les enregistrements du cache dans des fichiers textes.</p>
|
|
|
1006 |
|
|
|
1007 |
</div>
|
|
|
1008 |
|
|
|
1009 |
<div class="description detailed hidden">
|
|
|
1010 |
|
|
|
1011 |
<p>Socke les enregistrements du cache dans des fichiers textes.</p>
|
|
|
1012 |
|
|
|
1013 |
|
|
|
1014 |
</div>
|
|
|
1015 |
</div></td>
|
|
|
1016 |
</tr>
|
|
|
1017 |
<tr data-order="STOCKAGE_MODE_SQLITE" id="STOCKAGE_MODE_SQLITE">
|
|
|
1018 |
|
|
|
1019 |
<td class="attributes"><code>string</code></td>
|
|
|
1020 |
<td class="name"><code>
|
|
|
1021 |
<a href="source-class-Cache.html#22-23" title="Go to source code"><b>STOCKAGE_MODE_SQLITE</b></a>
|
|
|
1022 |
</code></td>
|
|
|
1023 |
<td class="value"><code><span class="php-quote">"Sqlite"</span></code></td>
|
|
|
1024 |
<td class="description"><div>
|
|
|
1025 |
<a href="#STOCKAGE_MODE_SQLITE" class="anchor">#</a>
|
|
|
1026 |
|
|
|
1027 |
<div class="description short">
|
|
|
1028 |
|
|
|
1029 |
<p>Socke les enregistrements du cache dans une base de données SQLite.</p>
|
|
|
1030 |
|
|
|
1031 |
</div>
|
|
|
1032 |
|
|
|
1033 |
<div class="description detailed hidden">
|
|
|
1034 |
|
|
|
1035 |
<p>Socke les enregistrements du cache dans une base de données SQLite.</p>
|
|
|
1036 |
|
|
|
1037 |
|
|
|
1038 |
</div>
|
|
|
1039 |
</div></td>
|
|
|
1040 |
</tr>
|
|
|
1041 |
<tr data-order="NETTOYAGE_MODE_TOUS" id="NETTOYAGE_MODE_TOUS">
|
|
|
1042 |
|
|
|
1043 |
<td class="attributes"><code>string</code></td>
|
|
|
1044 |
<td class="name"><code>
|
|
|
1045 |
<a href="source-class-Cache.html#25-26" title="Go to source code"><b>NETTOYAGE_MODE_TOUS</b></a>
|
|
|
1046 |
</code></td>
|
|
|
1047 |
<td class="value"><code><span class="php-quote">"tous"</span></code></td>
|
|
|
1048 |
<td class="description"><div>
|
|
|
1049 |
<a href="#NETTOYAGE_MODE_TOUS" class="anchor">#</a>
|
|
|
1050 |
|
|
|
1051 |
<div class="description short">
|
|
|
1052 |
|
|
|
1053 |
<p>'tous' (par défaut) : supprime tous les enregistrements.</p>
|
|
|
1054 |
|
|
|
1055 |
</div>
|
|
|
1056 |
|
|
|
1057 |
<div class="description detailed hidden">
|
|
|
1058 |
|
|
|
1059 |
<p>'tous' (par défaut) : supprime tous les enregistrements.</p>
|
|
|
1060 |
|
|
|
1061 |
|
|
|
1062 |
</div>
|
|
|
1063 |
</div></td>
|
|
|
1064 |
</tr>
|
|
|
1065 |
<tr data-order="NETTOYAGE_MODE_EXPIRATION" id="NETTOYAGE_MODE_EXPIRATION">
|
|
|
1066 |
|
|
|
1067 |
<td class="attributes"><code>string</code></td>
|
|
|
1068 |
<td class="name"><code>
|
|
|
1069 |
<a href="source-class-Cache.html#27-28" title="Go to source code"><b>NETTOYAGE_MODE_EXPIRATION</b></a>
|
|
|
1070 |
</code></td>
|
|
|
1071 |
<td class="value"><code><span class="php-quote">"expiration"</span></code></td>
|
|
|
1072 |
<td class="description"><div>
|
|
|
1073 |
<a href="#NETTOYAGE_MODE_EXPIRATION" class="anchor">#</a>
|
|
|
1074 |
|
|
|
1075 |
<div class="description short">
|
|
|
1076 |
|
|
|
1077 |
<p>'expiration' : supprime tous les enregistrements dont la date d'expériration
|
|
|
1078 |
est dépassée.</p>
|
|
|
1079 |
|
|
|
1080 |
</div>
|
|
|
1081 |
|
|
|
1082 |
<div class="description detailed hidden">
|
|
|
1083 |
|
|
|
1084 |
<p>'expiration' : supprime tous les enregistrements dont la date d'expériration
|
|
|
1085 |
est dépassée.</p>
|
|
|
1086 |
|
|
|
1087 |
|
|
|
1088 |
</div>
|
|
|
1089 |
</div></td>
|
|
|
1090 |
</tr>
|
|
|
1091 |
<tr data-order="NETTOYAGE_MODE_AVEC_LES_TAGS" id="NETTOYAGE_MODE_AVEC_LES_TAGS">
|
|
|
1092 |
|
|
|
1093 |
<td class="attributes"><code>string</code></td>
|
|
|
1094 |
<td class="name"><code>
|
|
|
1095 |
<a href="source-class-Cache.html#29-30" title="Go to source code"><b>NETTOYAGE_MODE_AVEC_LES_TAGS</b></a>
|
|
|
1096 |
</code></td>
|
|
|
1097 |
<td class="value"><code><span class="php-quote">"avecLesTags"</span></code></td>
|
|
|
1098 |
<td class="description"><div>
|
|
|
1099 |
<a href="#NETTOYAGE_MODE_AVEC_LES_TAGS" class="anchor">#</a>
|
|
|
1100 |
|
|
|
1101 |
<div class="description short">
|
|
|
1102 |
|
|
|
1103 |
<p>'avecLesTags' : supprime tous les enregistrements contenant tous les tags
|
|
|
1104 |
indiqués.</p>
|
|
|
1105 |
|
|
|
1106 |
</div>
|
|
|
1107 |
|
|
|
1108 |
<div class="description detailed hidden">
|
|
|
1109 |
|
|
|
1110 |
<p>'avecLesTags' : supprime tous les enregistrements contenant tous les tags
|
|
|
1111 |
indiqués.</p>
|
|
|
1112 |
|
|
|
1113 |
|
|
|
1114 |
</div>
|
|
|
1115 |
</div></td>
|
|
|
1116 |
</tr>
|
|
|
1117 |
<tr data-order="NETTOYAGE_MODE_SANS_LES_TAGS" id="NETTOYAGE_MODE_SANS_LES_TAGS">
|
|
|
1118 |
|
|
|
1119 |
<td class="attributes"><code>string</code></td>
|
|
|
1120 |
<td class="name"><code>
|
|
|
1121 |
<a href="source-class-Cache.html#31-32" title="Go to source code"><b>NETTOYAGE_MODE_SANS_LES_TAGS</b></a>
|
|
|
1122 |
</code></td>
|
|
|
1123 |
<td class="value"><code><span class="php-quote">"sansLesTags"</span></code></td>
|
|
|
1124 |
<td class="description"><div>
|
|
|
1125 |
<a href="#NETTOYAGE_MODE_SANS_LES_TAGS" class="anchor">#</a>
|
|
|
1126 |
|
|
|
1127 |
<div class="description short">
|
|
|
1128 |
|
|
|
1129 |
<p>'sansLesTags' : supprime tous les enregistrements contenant aucun des tags
|
|
|
1130 |
indiqués.</p>
|
|
|
1131 |
|
|
|
1132 |
</div>
|
|
|
1133 |
|
|
|
1134 |
<div class="description detailed hidden">
|
|
|
1135 |
|
|
|
1136 |
<p>'sansLesTags' : supprime tous les enregistrements contenant aucun des tags
|
|
|
1137 |
indiqués.</p>
|
|
|
1138 |
|
|
|
1139 |
|
|
|
1140 |
</div>
|
|
|
1141 |
</div></td>
|
|
|
1142 |
</tr>
|
|
|
1143 |
<tr data-order="NETTOYAGE_MODE_AVEC_UN_TAG" id="NETTOYAGE_MODE_AVEC_UN_TAG">
|
|
|
1144 |
|
|
|
1145 |
<td class="attributes"><code>string</code></td>
|
|
|
1146 |
<td class="name"><code>
|
|
|
1147 |
<a href="source-class-Cache.html#33-34" title="Go to source code"><b>NETTOYAGE_MODE_AVEC_UN_TAG</b></a>
|
|
|
1148 |
</code></td>
|
|
|
1149 |
<td class="value"><code><span class="php-quote">"avecUnTag"</span></code></td>
|
|
|
1150 |
<td class="description"><div>
|
|
|
1151 |
<a href="#NETTOYAGE_MODE_AVEC_UN_TAG" class="anchor">#</a>
|
|
|
1152 |
|
|
|
1153 |
<div class="description short">
|
|
|
1154 |
|
|
|
1155 |
<p>'avecUnTag' : supprime tous les enregistrements contenant au moins un des
|
|
|
1156 |
tags indiqués.</p>
|
|
|
1157 |
|
|
|
1158 |
</div>
|
|
|
1159 |
|
|
|
1160 |
<div class="description detailed hidden">
|
|
|
1161 |
|
|
|
1162 |
<p>'avecUnTag' : supprime tous les enregistrements contenant au moins un des
|
|
|
1163 |
tags indiqués.</p>
|
|
|
1164 |
|
|
|
1165 |
|
|
|
1166 |
</div>
|
|
|
1167 |
</div></td>
|
|
|
1168 |
</tr>
|
|
|
1169 |
</table>
|
|
|
1170 |
|
|
|
1171 |
|
|
|
1172 |
|
|
|
1173 |
|
|
|
1174 |
<table class="summary" id="properties">
|
|
|
1175 |
<caption>Properties summary</caption>
|
|
|
1176 |
<tr data-order="options" id="$options">
|
|
|
1177 |
<td class="attributes"><code>
|
|
|
1178 |
protected
|
|
|
1179 |
array
|
|
|
1180 |
</code></td>
|
|
|
1181 |
|
|
|
1182 |
<td class="name">
|
|
|
1183 |
<a href="source-class-Cache.html#43-94" title="Go to source code"><var>$options</var></a>
|
|
|
1184 |
</td>
|
|
|
1185 |
<td class="value"><code><span class="php-keyword1">array</span>(
|
|
|
1186 |
<span class="php-quote">'stockage_mode'</span> => self::STOCKAGE_MODE_FICHIER,
|
|
|
1187 |
<span class="php-quote">'stockage_chemin'</span> => <span class="php-keyword1">null</span>,
|
|
|
1188 |
<span class="php-quote">'controle_ecriture'</span> => <span class="php-keyword1">true</span>,
|
|
|
1189 |
<span class="php-quote">'mise_en_cache'</span> => <span class="php-keyword1">true</span>,
|
|
|
1190 |
<span class="php-quote">'cache_id_prefixe'</span> => <span class="php-keyword1">null</span>,
|
|
|
1191 |
<span class="php-quote">'serialisation_auto'</span> => <span class="php-keyword1">false</span>,
|
|
|
1192 |
<span class="php-quote">'nettoyage_auto'</span> => <span class="php-num">10</span>,
|
|
|
1193 |
<span class="php-quote">'duree_de_vie'</span> => <span class="php-num">3600</span>,
|
|
|
1194 |
)</code></td>
|
|
|
1195 |
<td class="description"><div>
|
|
|
1196 |
<a href="#$options" class="anchor">#</a>
|
|
|
1197 |
|
|
|
1198 |
<div class="description short">
|
|
|
1199 |
|
|
|
1200 |
<p>Les options disponibles pour le cache :</p>
|
|
|
1201 |
|
|
|
1202 |
<h1>> (string) stockage_mode :</h1>
|
|
|
1203 |
|
|
|
1204 |
<p>Indique le mode de stockage du cache à utiliser parmis :</p>
|
|
|
1205 |
|
|
|
1206 |
<ul>
|
|
|
1207 |
<li>Cache::STOCKAGE_MODE_FICHIER : sous forme d'une arborescence de fichiers et
|
|
|
1208 |
dossier</li>
|
|
|
1209 |
|
|
|
1210 |
<li>Cache::STOCKAGE_MODE_SQLITE : sous forme d'une base de données SQLite</li>
|
|
|
1211 |
</ul>
|
|
|
1212 |
|
|
|
1213 |
</div>
|
|
|
1214 |
|
|
|
1215 |
<div class="description detailed hidden">
|
|
|
1216 |
|
|
|
1217 |
<p>Les options disponibles pour le cache :</p>
|
|
|
1218 |
|
|
|
1219 |
<h2>> (string) stockage_mode :</h2>
|
|
|
1220 |
|
|
|
1221 |
<p>Indique le mode de stockage du cache à utiliser parmis :</p>
|
|
|
1222 |
|
|
|
1223 |
<ul>
|
|
|
1224 |
<li>Cache::STOCKAGE_MODE_FICHIER : sous forme d'une arborescence de fichiers et
|
|
|
1225 |
dossier</li>
|
|
|
1226 |
|
|
|
1227 |
<li>Cache::STOCKAGE_MODE_SQLITE : sous forme d'une base de données SQLite</li>
|
|
|
1228 |
</ul>
|
|
|
1229 |
|
|
|
1230 |
<h2>> (string) stockage_chemin :</h2>
|
|
|
1231 |
|
|
|
1232 |
<p>Chemin vers :</p>
|
|
|
1233 |
|
|
|
1234 |
<ul>
|
|
|
1235 |
<li>Cache::STOCKAGE_MODE_FICHIER : le dossier devant contenir
|
|
|
1236 |
l'arborescence.</li>
|
|
|
1237 |
|
|
|
1238 |
<li>Cache::STOCKAGE_MODE_SQLITE : le fichier contenant la base SQLite.</li>
|
|
|
1239 |
</ul>
|
|
|
1240 |
|
|
|
1241 |
<h2>> (boolean) controle_ecriture :</h2>
|
|
|
1242 |
|
|
|
1243 |
<ul>
|
|
|
1244 |
<li>Active / Désactive le controle d'écriture (le cache est lue jute après
|
|
|
1245 |
l'écriture du fichier pour détecter sa corruption)</li>
|
|
|
1246 |
|
|
|
1247 |
<li>Activer le controle d'écriture ralentira légèrement l'écriture du
|
|
|
1248 |
fichier de cache mais pas sa lecture</li>
|
|
|
1249 |
</ul>
|
|
|
1250 |
|
|
|
1251 |
<p>Le controle d'écriture peut détecter la corruption de fichier mais ce n'est
|
|
|
1252 |
pas un système de controle parfait.</p>
|
|
|
1253 |
|
|
|
1254 |
<h2>> (boolean) mise_en_cache :</h2>
|
|
|
1255 |
|
|
|
1256 |
<ul>
|
|
|
1257 |
<li>Active / Désactive la mise en cache</li>
|
|
|
1258 |
</ul>
|
|
|
1259 |
|
|
|
1260 |
<p>(peut être très utile pour le débogage des scripts utilisant le cache</p>
|
|
|
1261 |
|
|
|
1262 |
<h1>> (string) cache_id_prefixe :</h1>
|
|
|
1263 |
|
|
|
1264 |
<ul>
|
|
|
1265 |
<li>préfixe pour les identifiant de cache ( = espace de nom)</li>
|
|
|
1266 |
</ul>
|
|
|
1267 |
|
|
|
1268 |
<h2>> (boolean) serialisation_auto :</h2>
|
|
|
1269 |
|
|
|
1270 |
<ul>
|
|
|
1271 |
<li>Active / Désactive la sérialisation automatique</li>
|
|
|
1272 |
|
|
|
1273 |
<li>Peut être utilisé pour sauver directement des données qui ne sont pas des
|
|
|
1274 |
chaines (mais c'est plus lent)</li>
|
|
|
1275 |
</ul>
|
|
|
1276 |
|
|
|
1277 |
<h2>> (int) nettoyage_auto :</h2>
|
|
|
1278 |
|
|
|
1279 |
<ul>
|
|
|
1280 |
<li>Désactive / Régler le processus de nettoyage automatique</li>
|
|
|
1281 |
|
|
|
1282 |
<li>Le processus de nettoyage automatiques détruit les fichier trop vieux (pour
|
|
|
1283 |
la durée de vie donnée) quand un nouveau fichier de cache est écrit : 0 =>
|
|
|
1284 |
pas de nettoyage automatique 1 => nettoyage automatique systématique x
|
|
|
1285 |
(integer) > 1 => nettoyage automatique toutes les 1 fois (au hasard) sur x
|
|
|
1286 |
écriture de fichier de cache</li>
|
|
|
1287 |
</ul>
|
|
|
1288 |
|
|
|
1289 |
<h2>> (int) duree_de_vie :</h2>
|
|
|
1290 |
|
|
|
1291 |
<ul>
|
|
|
1292 |
<li>Durée de vie du cache (en secondes)</li>
|
|
|
1293 |
|
|
|
1294 |
<li>Si null, le cache est valide indéfiniment.</li>
|
|
|
1295 |
</ul>
|
|
|
1296 |
|
|
|
1297 |
|
|
|
1298 |
</div>
|
|
|
1299 |
</div></td>
|
|
|
1300 |
</tr>
|
|
|
1301 |
<tr data-order="stockage" id="$stockage">
|
|
|
1302 |
<td class="attributes"><code>
|
|
|
1303 |
protected
|
|
|
1304 |
mixed
|
|
|
1305 |
</code></td>
|
|
|
1306 |
|
|
|
1307 |
<td class="name">
|
|
|
1308 |
<a href="source-class-Cache.html#96" title="Go to source code"><var>$stockage</var></a>
|
|
|
1309 |
</td>
|
|
|
1310 |
<td class="value"><code><span class="php-keyword1">null</span></code></td>
|
|
|
1311 |
<td class="description"><div>
|
|
|
1312 |
<a href="#$stockage" class="anchor">#</a>
|
|
|
1313 |
|
|
|
1314 |
<div class="description short">
|
|
|
1315 |
|
|
|
1316 |
</div>
|
|
|
1317 |
|
|
|
1318 |
<div class="description detailed hidden">
|
|
|
1319 |
|
|
|
1320 |
|
|
|
1321 |
</div>
|
|
|
1322 |
</div></td>
|
|
|
1323 |
</tr>
|
|
|
1324 |
</table>
|
|
|
1325 |
|
|
|
1326 |
|
|
|
1327 |
|
|
|
1328 |
|
|
|
1329 |
|
|
|
1330 |
|
|
|
1331 |
</div>
|
|
|
1332 |
|
|
|
1333 |
<div id="footer">
|
|
|
1334 |
TBFramework - v0.4 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
|
|
1335 |
</div>
|
|
|
1336 |
</div>
|
|
|
1337 |
</div>
|
|
|
1338 |
</body>
|
|
|
1339 |
</html>
|