| 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 Cache</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 Cache</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 |
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
|
|
|
100 |
|
|
|
101 |
</div>
|
|
|
102 |
<div class="info-box-body">
|
|
|
103 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
104 |
<p class="short-description">Classe Cache permettant de mettre en cache des données.</p>
|
|
|
105 |
<p class="description"><p>Basée sur les principes de Zend_Cache (Copyright (c) 2005-2010, Zend Technologies USA, Inc. All rights reserved.)</p></p>
|
|
|
106 |
<ul class="tags">
|
|
|
107 |
<li><span class="field">author:</span> Jean-Pascal MILCENT <<a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a>></li>
|
| 300 |
jpm |
108 |
<li><span class="field">version:</span> $Id: Cache.php 299 2011-01-18 14:03:46Z jpm $</li>
|
| 297 |
jpm |
109 |
<li><span class="field">copyright:</span> Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</li>
|
|
|
110 |
<li><span class="field">link:</span> /doc/framework/</li>
|
|
|
111 |
<li><span class="field">license:</span> <a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL</a></li>
|
|
|
112 |
<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL</a></li>
|
|
|
113 |
<li><span class="field">license:</span> <a href="http://framework.zend.com/license/new-bsd">Licence New BSD</a></li>
|
|
|
114 |
</ul>
|
|
|
115 |
<p class="notes">
|
|
|
116 |
Located in <a class="field" href="_Cache.php.html">/Cache.php</a> (line <span class="field"><a href="../__filesource/fsource_Framework__Cache.php.html#a17">17</a></span>)
|
|
|
117 |
</p>
|
|
|
118 |
|
|
|
119 |
|
|
|
120 |
<pre></pre>
|
|
|
121 |
|
|
|
122 |
</div>
|
|
|
123 |
</div>
|
|
|
124 |
|
|
|
125 |
|
|
|
126 |
<a name="sec-const-summary"></a>
|
|
|
127 |
<div class="info-box">
|
|
|
128 |
<div class="info-box-title">Class Constant Summary</span></div>
|
|
|
129 |
<div class="nav-bar">
|
|
|
130 |
<a href="#sec-description">Description</a> |
|
|
|
131 |
<span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
|
|
|
132 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
|
|
133 |
|
|
|
134 |
|
|
|
|
135 |
|
|
|
|
136 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
137 |
|
|
|
138 |
</div>
|
|
|
139 |
<div class="info-box-body">
|
|
|
140 |
<div class="const-summary">
|
|
|
141 |
<div class="const-title">
|
|
|
142 |
<img src="../media/images/Constant.png" alt=" " />
|
|
|
143 |
<a href="#NETTOYAGE_MODE_AVEC_LES_TAGS" title="details" class="const-name">NETTOYAGE_MODE_AVEC_LES_TAGS</a> = <span class="var-type"> "avecLesTags"</span>
|
|
|
144 |
|
|
|
145 |
</div>
|
|
|
146 |
<div class="const-title">
|
|
|
147 |
<img src="../media/images/Constant.png" alt=" " />
|
|
|
148 |
<a href="#NETTOYAGE_MODE_AVEC_UN_TAG" title="details" class="const-name">NETTOYAGE_MODE_AVEC_UN_TAG</a> = <span class="var-type"> "avecUnTag"</span>
|
|
|
149 |
|
|
|
150 |
</div>
|
|
|
151 |
<div class="const-title">
|
|
|
152 |
<img src="../media/images/Constant.png" alt=" " />
|
|
|
153 |
<a href="#NETTOYAGE_MODE_EXPIRATION" title="details" class="const-name">NETTOYAGE_MODE_EXPIRATION</a> = <span class="var-type"> "expiration"</span>
|
|
|
154 |
|
|
|
155 |
</div>
|
|
|
156 |
<div class="const-title">
|
|
|
157 |
<img src="../media/images/Constant.png" alt=" " />
|
|
|
158 |
<a href="#NETTOYAGE_MODE_SANS_LES_TAGS" title="details" class="const-name">NETTOYAGE_MODE_SANS_LES_TAGS</a> = <span class="var-type"> "sansLesTags"</span>
|
|
|
159 |
|
|
|
160 |
</div>
|
|
|
161 |
<div class="const-title">
|
|
|
162 |
<img src="../media/images/Constant.png" alt=" " />
|
|
|
163 |
<a href="#NETTOYAGE_MODE_TOUS" title="details" class="const-name">NETTOYAGE_MODE_TOUS</a> = <span class="var-type"> "tous"</span>
|
|
|
164 |
|
|
|
165 |
</div>
|
|
|
166 |
<div class="const-title">
|
|
|
167 |
<img src="../media/images/Constant.png" alt=" " />
|
|
|
168 |
<a href="#STOCKAGE_MODE_FICHIER" title="details" class="const-name">STOCKAGE_MODE_FICHIER</a> = <span class="var-type"> "Fichier"</span>
|
|
|
169 |
|
|
|
170 |
</div>
|
|
|
171 |
<div class="const-title">
|
|
|
172 |
<img src="../media/images/Constant.png" alt=" " />
|
|
|
173 |
<a href="#STOCKAGE_MODE_SIMPLE" title="details" class="const-name">STOCKAGE_MODE_SIMPLE</a> = <span class="var-type"> "FichierSimple"</span>
|
|
|
174 |
|
|
|
175 |
</div>
|
|
|
176 |
<div class="const-title">
|
|
|
177 |
<img src="../media/images/Constant.png" alt=" " />
|
|
|
178 |
<a href="#STOCKAGE_MODE_SQLITE" title="details" class="const-name">STOCKAGE_MODE_SQLITE</a> = <span class="var-type"> "Sqlite"</span>
|
|
|
179 |
|
|
|
180 |
</div>
|
|
|
181 |
</div>
|
|
|
182 |
</div>
|
|
|
183 |
</div>
|
|
|
184 |
|
|
|
185 |
<a name="sec-var-summary"></a>
|
|
|
186 |
<div class="info-box">
|
|
|
187 |
<div class="info-box-title">Variable Summary</span></div>
|
|
|
188 |
<div class="nav-bar">
|
|
|
189 |
<a href="#sec-description">Description</a> |
|
|
|
190 |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
|
|
191 |
|
|
|
|
192 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
193 |
|
|
|
194 |
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
|
|
|
195 |
|
|
|
196 |
</div>
|
|
|
197 |
<div class="info-box-body">
|
|
|
198 |
<div class="var-summary">
|
|
|
199 |
<div class="var-title">
|
|
|
200 |
<span class="var-type">array</span>
|
|
|
201 |
<a href="#$options" title="details" class="var-name">$options</a>
|
|
|
202 |
</div>
|
|
|
203 |
<div class="var-title">
|
|
|
204 |
<span class="var-type">mixed</span>
|
|
|
205 |
<a href="#$stockage" title="details" class="var-name">$stockage</a>
|
|
|
206 |
</div>
|
|
|
207 |
</div>
|
|
|
208 |
</div>
|
|
|
209 |
</div>
|
|
|
210 |
|
|
|
211 |
<a name="sec-method-summary"></a>
|
|
|
212 |
<div class="info-box">
|
|
|
213 |
<div class="info-box-title">Method Summary</span></div>
|
|
|
214 |
<div class="nav-bar">
|
|
|
215 |
<a href="#sec-description">Description</a> |
|
|
|
216 |
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
|
|
|
217 |
|
|
|
218 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
|
|
219 |
|
|
|
220 |
|
|
|
|
221 |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
|
|
222 |
</div>
|
|
|
223 |
<div class="info-box-body">
|
|
|
224 |
<div class="method-summary">
|
|
|
225 |
|
|
|
226 |
<div class="method-definition">
|
|
|
227 |
static <span class="method-result">void</span>
|
|
|
228 |
<a href="#fabriquer" title="details" class="method-name">fabriquer</a>
|
|
|
229 |
(<span class="var-type"></span> <span class="var-name">$mode</span>, [<span class="var-type"></span> <span class="var-name">$options</span> = <span class="var-default">array()</span>])
|
|
|
230 |
</div>
|
|
|
231 |
|
|
|
232 |
<div class="method-definition">
|
|
|
233 |
static <span class="method-result">void</span>
|
|
|
234 |
<a href="#validerIdOuTag" title="details" class="method-name">validerIdOuTag</a>
|
|
|
235 |
(<span class="var-type">string</span> <span class="var-name">$chaine</span>)
|
|
|
236 |
</div>
|
|
|
237 |
|
|
|
238 |
<div class="method-definition">
|
|
|
239 |
static <span class="method-result">void</span>
|
|
|
240 |
<a href="#validerTableauDeTags" title="details" class="method-name">validerTableauDeTags</a>
|
|
|
241 |
(<span class="var-type">array</span> <span class="var-name">$tags</span>)
|
|
|
242 |
</div>
|
|
|
243 |
|
|
|
244 |
<div class="method-definition">
|
|
|
245 |
<span class="method-result">Cache</span>
|
|
|
246 |
<a href="#__construct" title="details" class="method-name">__construct</a>
|
|
|
247 |
([<span class="var-type"></span> <span class="var-name">$options</span> = <span class="var-default">array()</span>], [<span class="var-type"></span> <span class="var-name">$options_stockage</span> = <span class="var-default">array()</span>])
|
|
|
248 |
</div>
|
|
|
249 |
|
|
|
250 |
<div class="method-definition">
|
|
|
251 |
<span class="method-result">boolean</span>
|
|
|
252 |
<a href="#ajouterSupplementDureeDeVie" title="details" class="method-name">ajouterSupplementDureeDeVie</a>
|
|
|
253 |
(<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>)
|
|
|
254 |
</div>
|
|
|
255 |
|
|
|
256 |
<div class="method-definition">
|
|
|
257 |
<span class="method-result">mixed|false</span>
|
|
|
258 |
<a href="#charger" title="details" class="method-name">charger</a>
|
|
|
259 |
(<span class="var-type">string</span> <span class="var-name">$id</span>, [<span class="var-type">boolean</span> <span class="var-name">$ne_pas_tester_validiter_du_cache</span> = <span class="var-default">false</span>])
|
|
|
260 |
</div>
|
|
|
261 |
|
|
|
262 |
<div class="method-definition">
|
|
|
263 |
<span class="method-result">array</span>
|
|
|
264 |
<a href="#getIds" title="details" class="method-name">getIds</a>
|
|
|
265 |
()
|
|
|
266 |
</div>
|
|
|
267 |
|
|
|
268 |
<div class="method-definition">
|
|
|
269 |
<span class="method-result">array</span>
|
|
|
270 |
<a href="#getIdsAvecLesTags" title="details" class="method-name">getIdsAvecLesTags</a>
|
|
|
271 |
([<span class="var-type">array</span> <span class="var-name">$tags</span> = <span class="var-default">array()</span>])
|
|
|
272 |
</div>
|
|
|
273 |
|
|
|
274 |
<div class="method-definition">
|
|
|
275 |
<span class="method-result">array</span>
|
|
|
276 |
<a href="#getIdsAvecUnTag" title="details" class="method-name">getIdsAvecUnTag</a>
|
|
|
277 |
([<span class="var-type">array</span> <span class="var-name">$tags</span> = <span class="var-default">array()</span>])
|
|
|
278 |
</div>
|
|
|
279 |
|
|
|
280 |
<div class="method-definition">
|
|
|
281 |
<span class="method-result">array</span>
|
|
|
282 |
<a href="#getIdsSansLesTags" title="details" class="method-name">getIdsSansLesTags</a>
|
|
|
283 |
([<span class="var-type">array</span> <span class="var-name">$tags</span> = <span class="var-default">array()</span>])
|
|
|
284 |
</div>
|
|
|
285 |
|
|
|
286 |
<div class="method-definition">
|
|
|
287 |
<span class="method-result">array</span>
|
|
|
288 |
<a href="#getMetadonnees" title="details" class="method-name">getMetadonnees</a>
|
|
|
289 |
(<span class="var-type">string</span> <span class="var-name">$id</span>)
|
|
|
290 |
</div>
|
|
|
291 |
|
|
|
292 |
<div class="method-definition">
|
|
|
293 |
<span class="method-result">int</span>
|
|
|
294 |
<a href="#getPourcentageRemplissage" title="details" class="method-name">getPourcentageRemplissage</a>
|
|
|
295 |
()
|
|
|
296 |
</div>
|
|
|
297 |
|
|
|
298 |
<div class="method-definition">
|
|
|
299 |
<span class="method-result">array</span>
|
|
|
300 |
<a href="#getTags" title="details" class="method-name">getTags</a>
|
|
|
301 |
()
|
|
|
302 |
</div>
|
|
|
303 |
|
|
|
304 |
<div class="method-definition">
|
|
|
305 |
<span class="method-result">int</span>
|
|
|
306 |
<a href="#getTimestampExpiration" title="details" class="method-name">getTimestampExpiration</a>
|
|
|
307 |
(<span class="var-type"></span> <span class="var-name">$duree_de_vie</span>)
|
|
|
308 |
</div>
|
|
|
309 |
|
|
|
310 |
<div class="method-definition">
|
|
|
311 |
<span class="method-result">boolean</span>
|
|
|
312 |
<a href="#nettoyer" title="details" class="method-name">nettoyer</a>
|
|
|
313 |
([<span class="var-type">string</span> <span class="var-name">$mode</span> = <span class="var-default">self::NETTOYAGE_MODE_TOUS</span>], [<span class="var-type">array|string</span> <span class="var-name">$tags</span> = <span class="var-default">array()</span>])
|
|
|
314 |
</div>
|
|
|
315 |
|
|
|
316 |
<div class="method-definition">
|
|
|
317 |
<span class="method-result">boolean</span>
|
|
|
318 |
<a href="#sauver" title="details" class="method-name">sauver</a>
|
|
|
319 |
(<span class="var-type">mixed</span> <span class="var-name">$donnees</span>, [<span class="var-type">string</span> <span class="var-name">$id</span> = <span class="var-default">null</span>], [<span class="var-type">array</span> <span class="var-name">$tags</span> = <span class="var-default">array()</span>], [<span class="var-type">int</span> <span class="var-name">$duree_de_vie_specifique</span> = <span class="var-default">false</span>])
|
|
|
320 |
</div>
|
|
|
321 |
|
|
|
322 |
<div class="method-definition">
|
|
|
323 |
<span class="method-result">void</span>
|
|
|
324 |
<a href="#setEmplacement" title="details" class="method-name">setEmplacement</a>
|
|
|
325 |
(<span class="var-type">string</span> <span class="var-name">$emplacement</span>)
|
|
|
326 |
</div>
|
|
|
327 |
|
|
|
328 |
<div class="method-definition">
|
|
|
329 |
<span class="method-result">boolean</span>
|
|
|
330 |
<a href="#supprimer" title="details" class="method-name">supprimer</a>
|
|
|
331 |
(<span class="var-type">string</span> <span class="var-name">$id</span>)
|
|
|
332 |
</div>
|
|
|
333 |
|
|
|
334 |
<div class="method-definition">
|
|
|
335 |
<span class="method-result">int|false</span>
|
|
|
336 |
<a href="#tester" title="details" class="method-name">tester</a>
|
|
|
337 |
(<span class="var-type">string</span> <span class="var-name">$id</span>)
|
|
|
338 |
</div>
|
|
|
339 |
</div>
|
|
|
340 |
</div>
|
|
|
341 |
</div>
|
|
|
342 |
|
|
|
343 |
<a name="sec-vars"></a>
|
|
|
344 |
<div class="info-box">
|
|
|
345 |
<div class="info-box-title">Variables</div>
|
|
|
346 |
<div class="nav-bar">
|
|
|
347 |
<a href="#sec-description">Description</a> |
|
|
|
348 |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
|
|
349 |
|
|
|
350 |
|
|
|
351 |
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
|
|
|
352 |
|
|
|
353 |
|
|
|
|
354 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
355 |
|
|
|
356 |
</div>
|
|
|
357 |
<div class="info-box-body">
|
|
|
358 |
|
|
|
359 |
<a name="var$options" id="$options"><!-- --></A>
|
|
|
360 |
<div class="oddrow">
|
|
|
361 |
|
|
|
362 |
<div class="var-header">
|
|
|
363 |
<span class="var-title">
|
|
|
364 |
<span class="var-type">array</span>
|
|
|
365 |
<span class="var-name">$options</span>
|
|
|
366 |
= <span class="var-default">array(<br /> 'stockage_mode' => self::STOCKAGE_MODE_FICHIER,<br /> 'stockage_chemin' => null, <br /> 'controle_ecriture' => true,<br /> 'mise_en_cache' => true,<br /> 'cache_id_prefixe' => null,<br /> 'serialisation_auto' => false,<br /> 'nettoyage_auto' => 10,<br /> 'duree_de_vie' => 3600,<br /> )</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Cache.php.html#a85">85</a></span>)
|
|
|
367 |
</span>
|
|
|
368 |
</div>
|
|
|
369 |
|
|
|
370 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
371 |
<p class="short-description">Les options disponibles pour le cache :</p>
|
|
|
372 |
<p class="description"><p>====> (string) stockage_mode : Indique le mode de stockage du cache à utiliser parmis : <ul><li>Cache::STOCKAGE_MODE_FICHIER : sous forme d'une arborescence de fichiers et dossier</li><li>Cache::STOCKAGE_MODE_SQLITE : sous forme d'une base de données SQLite</li></ul> ====> (string) stockage_chemin : Chemin vers : <ul><li>Cache::STOCKAGE_MODE_FICHIER : le dossier devant contenir l'arborescence.</li><li>Cache::STOCKAGE_MODE_SQLITE : le fichier contenant la base SQLite.</li></ul> ====> (boolean) controle_ecriture : <ul><li>Active / Désactive le controle d'écriture (le cache est lue jute après l'écriture du fichier pour détecter sa corruption)</li><li>Activer le controle d'écriture ralentira légèrement l'écriture du fichier de cache mais pas sa lecture</li></ul> Le controle d'écriture peut détecter la corruption de fichier mais ce n'est pas un système de controle parfait.</p><p>====> (boolean) mise_en_cache : <ul><li>Active / Désactive la mise en cache</li></ul> (peut être très utile pour le débogage des scripts utilisant le cache</p><p>=====> (string) cache_id_prefixe : <ul><li>préfixe pour les identifiant de cache ( = espace de nom)</li></ul> ====> (boolean) serialisation_auto : <ul><li>Active / Désactive la sérialisation automatique</li><li>Peut être utilisé pour sauver directement des données qui ne sont pas des chaines (mais c'est plus lent)</li></ul> ====> (int) nettoyage_auto : <ul><li>Désactive / Régler le processus de nettoyage automatique</li><li>Le processus de nettoyage automatiques détruit les fichier trop vieux (pour la durée de vie donnée)
|
|
|
373 |
quand un nouveau fichier de cache est écrit :</li></ul> 0 => pas de nettoyage automatique 1 => nettoyage automatique systématique x (integer) > 1 => nettoyage automatique toutes les 1 fois (au hasard) sur x écriture de fichier de cache</p><p>====> (int) duree_de_vie : <ul><li>Durée de vie du cache (en secondes)</li><li>Si null, le cache est valide indéfiniment.</li></ul></p></p>
|
|
|
374 |
<ul class="tags">
|
|
|
375 |
<li><span class="field">var:</span> les options disponibles pour le cache .</li>
|
|
|
376 |
<li><span class="field">access:</span> protected</li>
|
|
|
377 |
</ul>
|
|
|
378 |
|
|
|
379 |
|
|
|
380 |
|
|
|
381 |
|
|
|
382 |
|
|
|
383 |
</div>
|
|
|
384 |
<a name="var$stockage" id="$stockage"><!-- --></A>
|
|
|
385 |
<div class="evenrow">
|
|
|
386 |
|
|
|
387 |
<div class="var-header">
|
|
|
388 |
<span class="var-title">
|
|
|
389 |
<span class="var-type">mixed</span>
|
|
|
390 |
<span class="var-name">$stockage</span>
|
|
|
391 |
= <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Cache.php.html#a96">96</a></span>)
|
|
|
392 |
</span>
|
|
|
393 |
</div>
|
|
|
394 |
|
|
|
395 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
396 |
<ul class="tags">
|
|
|
397 |
<li><span class="field">access:</span> protected</li>
|
|
|
398 |
</ul>
|
|
|
399 |
|
|
|
400 |
|
|
|
401 |
|
|
|
402 |
|
|
|
403 |
|
|
|
404 |
</div>
|
|
|
405 |
|
|
|
406 |
</div>
|
|
|
407 |
</div>
|
|
|
408 |
|
|
|
409 |
<a name="sec-methods"></a>
|
|
|
410 |
<div class="info-box">
|
|
|
411 |
<div class="info-box-title">Methods</div>
|
|
|
412 |
<div class="nav-bar">
|
|
|
413 |
<a href="#sec-description">Description</a> |
|
|
|
414 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
|
|
415 |
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
|
|
|
416 |
|
|
|
417 |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
|
|
418 |
|
|
|
419 |
</div>
|
|
|
420 |
<div class="info-box-body">
|
|
|
421 |
<A NAME='method_detail'></A>
|
|
|
422 |
<a name="methodfabriquer" id="fabriquer"><!-- --></a>
|
|
|
423 |
<div class="oddrow">
|
|
|
424 |
|
|
|
425 |
<div class="method-header">
|
|
|
426 |
<span class="method-title">static fabriquer</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Cache.php.html#a148">148</a></span>)
|
|
|
427 |
</div>
|
|
|
428 |
|
|
|
429 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
430 |
<ul class="tags">
|
|
|
431 |
<li><span class="field">access:</span> public</li>
|
|
|
432 |
</ul>
|
|
|
433 |
|
|
|
434 |
<div class="method-signature">
|
|
|
435 |
static <span class="method-result">void</span>
|
|
|
436 |
<span class="method-name">
|
|
|
437 |
fabriquer
|
|
|
438 |
</span>
|
|
|
439 |
(<span class="var-type"></span> <span class="var-name">$mode</span>, [<span class="var-type"></span> <span class="var-name">$options</span> = <span class="var-default">array()</span>])
|
|
|
440 |
</div>
|
|
|
441 |
|
|
|
442 |
<ul class="parameters">
|
|
|
443 |
<li>
|
|
|
444 |
<span class="var-type"></span>
|
|
|
445 |
<span class="var-name">$mode</span> </li>
|
|
|
446 |
<li>
|
|
|
447 |
<span class="var-type"></span>
|
|
|
448 |
<span class="var-name">$options</span> </li>
|
|
|
449 |
</ul>
|
|
|
450 |
|
|
|
451 |
|
|
|
452 |
</div>
|
|
|
453 |
<a name="methodvaliderIdOuTag" id="validerIdOuTag"><!-- --></a>
|
|
|
454 |
<div class="evenrow">
|
|
|
455 |
|
|
|
456 |
<div class="method-header">
|
|
|
457 |
<span class="method-title">static validerIdOuTag</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Cache.php.html#a462">462</a></span>)
|
|
|
458 |
</div>
|
|
|
459 |
|
|
|
460 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
461 |
<p class="short-description">Valide un identifiant de cache ou un tag (securité, nom de fichiers fiables, préfixes réservés...)</p>
|
|
|
462 |
<ul class="tags">
|
|
|
463 |
<li><span class="field">access:</span> protected</li>
|
|
|
464 |
</ul>
|
|
|
465 |
|
|
|
466 |
<div class="method-signature">
|
|
|
467 |
static <span class="method-result">void</span>
|
|
|
468 |
<span class="method-name">
|
|
|
469 |
validerIdOuTag
|
|
|
470 |
</span>
|
|
|
471 |
(<span class="var-type">string</span> <span class="var-name">$chaine</span>)
|
|
|
472 |
</div>
|
|
|
473 |
|
|
|
474 |
<ul class="parameters">
|
|
|
475 |
<li>
|
|
|
476 |
<span class="var-type">string</span>
|
|
|
477 |
<span class="var-name">$chaine</span><span class="var-description">: Identificant de cache ou tag</span> </li>
|
|
|
478 |
</ul>
|
|
|
479 |
|
|
|
480 |
|
|
|
481 |
</div>
|
|
|
482 |
<a name="methodvaliderTableauDeTags" id="validerTableauDeTags"><!-- --></a>
|
|
|
483 |
<div class="oddrow">
|
|
|
484 |
|
|
|
485 |
<div class="method-header">
|
|
|
486 |
<span class="method-title">static validerTableauDeTags</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Cache.php.html#a480">480</a></span>)
|
|
|
487 |
</div>
|
|
|
488 |
|
|
|
489 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
490 |
<p class="short-description">Valide un tableau de tags (securité, nom de fichiers fiables, préfixes réservés...)</p>
|
|
|
491 |
<ul class="tags">
|
|
|
492 |
<li><span class="field">access:</span> protected</li>
|
|
|
493 |
</ul>
|
|
|
494 |
|
|
|
495 |
<div class="method-signature">
|
|
|
496 |
static <span class="method-result">void</span>
|
|
|
497 |
<span class="method-name">
|
|
|
498 |
validerTableauDeTags
|
|
|
499 |
</span>
|
|
|
500 |
(<span class="var-type">array</span> <span class="var-name">$tags</span>)
|
|
|
501 |
</div>
|
|
|
502 |
|
|
|
503 |
<ul class="parameters">
|
|
|
504 |
<li>
|
|
|
505 |
<span class="var-type">array</span>
|
|
|
506 |
<span class="var-name">$tags</span><span class="var-description">: tableau de tags</span> </li>
|
|
|
507 |
</ul>
|
|
|
508 |
|
|
|
509 |
|
|
|
510 |
</div>
|
|
|
511 |
<a name="method__construct" id="__construct"><!-- --></a>
|
|
|
512 |
<div class="evenrow">
|
|
|
513 |
|
|
|
514 |
<div class="method-header">
|
|
|
515 |
<span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Cache.php.html#a98">98</a></span>)
|
|
|
516 |
</div>
|
|
|
517 |
|
|
|
518 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
519 |
<ul class="tags">
|
|
|
520 |
<li><span class="field">access:</span> public</li>
|
|
|
521 |
</ul>
|
|
|
522 |
|
|
|
523 |
<div class="method-signature">
|
|
|
524 |
<span class="method-result">Cache</span>
|
|
|
525 |
<span class="method-name">
|
|
|
526 |
__construct
|
|
|
527 |
</span>
|
|
|
528 |
([<span class="var-type"></span> <span class="var-name">$options</span> = <span class="var-default">array()</span>], [<span class="var-type"></span> <span class="var-name">$options_stockage</span> = <span class="var-default">array()</span>])
|
|
|
529 |
</div>
|
|
|
530 |
|
|
|
531 |
<ul class="parameters">
|
|
|
532 |
<li>
|
|
|
533 |
<span class="var-type"></span>
|
|
|
534 |
<span class="var-name">$options</span> </li>
|
|
|
535 |
<li>
|
|
|
536 |
<span class="var-type"></span>
|
|
|
537 |
<span class="var-name">$options_stockage</span> </li>
|
|
|
538 |
</ul>
|
|
|
539 |
|
|
|
540 |
|
|
|
541 |
</div>
|
|
|
542 |
<a name="methodajouterSupplementDureeDeVie" id="ajouterSupplementDureeDeVie"><!-- --></a>
|
|
|
543 |
<div class="oddrow">
|
|
|
544 |
|
|
|
545 |
<div class="method-header">
|
|
|
546 |
<span class="method-title">ajouterSupplementDureeDeVie</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Cache.php.html#a365">365</a></span>)
|
|
|
547 |
</div>
|
|
|
548 |
|
|
|
549 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
550 |
<p class="short-description">Give (if possible) an extra lifetime to the given cache id</p>
|
|
|
551 |
<ul class="tags">
|
|
|
552 |
<li><span class="field">return:</span> true if ok</li>
|
|
|
553 |
<li><span class="field">access:</span> public</li>
|
|
|
554 |
</ul>
|
|
|
555 |
|
|
|
556 |
<div class="method-signature">
|
|
|
557 |
<span class="method-result">boolean</span>
|
|
|
558 |
<span class="method-name">
|
|
|
559 |
ajouterSupplementDureeDeVie
|
|
|
560 |
</span>
|
|
|
561 |
(<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>)
|
|
|
562 |
</div>
|
|
|
563 |
|
|
|
564 |
<ul class="parameters">
|
|
|
565 |
<li>
|
|
|
566 |
<span class="var-type">string</span>
|
|
|
567 |
<span class="var-name">$id</span><span class="var-description">: cache id</span> </li>
|
|
|
568 |
<li>
|
|
|
569 |
<span class="var-type">int</span>
|
|
|
570 |
<span class="var-name">$extraLifetime</span> </li>
|
|
|
571 |
<li>
|
|
|
572 |
<span class="var-type"></span>
|
|
|
573 |
<span class="var-name">$supplement_duree_de_vie</span> </li>
|
|
|
574 |
</ul>
|
|
|
575 |
|
|
|
576 |
|
|
|
577 |
</div>
|
|
|
578 |
<a name="methodcharger" id="charger"><!-- --></a>
|
|
|
579 |
<div class="evenrow">
|
|
|
580 |
|
|
|
581 |
<div class="method-header">
|
|
|
582 |
<span class="method-title">charger</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Cache.php.html#a164">164</a></span>)
|
|
|
583 |
</div>
|
|
|
584 |
|
|
|
585 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
586 |
<p class="short-description">Teste si un cache est disponible pour l'identifiant donné et (si oui) le retourne (false dans le cas contraire)</p>
|
|
|
587 |
<ul class="tags">
|
|
|
588 |
<li><span class="field">return:</span> Cached datas</li>
|
|
|
589 |
<li><span class="field">access:</span> public</li>
|
|
|
590 |
</ul>
|
|
|
591 |
|
|
|
592 |
<div class="method-signature">
|
|
|
593 |
<span class="method-result">mixed|false</span>
|
|
|
594 |
<span class="method-name">
|
|
|
595 |
charger
|
|
|
596 |
</span>
|
|
|
597 |
(<span class="var-type">string</span> <span class="var-name">$id</span>, [<span class="var-type">boolean</span> <span class="var-name">$ne_pas_tester_validiter_du_cache</span> = <span class="var-default">false</span>])
|
|
|
598 |
</div>
|
|
|
599 |
|
|
|
600 |
<ul class="parameters">
|
|
|
601 |
<li>
|
|
|
602 |
<span class="var-type">string</span>
|
|
|
603 |
<span class="var-name">$id</span><span class="var-description">: Identifiant de cache.</span> </li>
|
|
|
604 |
<li>
|
|
|
605 |
<span class="var-type">boolean</span>
|
|
|
606 |
<span class="var-name">$ne_pas_tester_validiter_du_cache</span><span class="var-description">: Si mis à true, la validité du cache n'est pas testée</span> </li>
|
|
|
607 |
</ul>
|
|
|
608 |
|
|
|
609 |
|
|
|
610 |
</div>
|
|
|
611 |
<a name="methodgetIds" id="getIds"><!-- --></a>
|
|
|
612 |
<div class="oddrow">
|
|
|
613 |
|
|
|
614 |
<div class="method-header">
|
|
|
615 |
<span class="method-title">getIds</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Cache.php.html#a276">276</a></span>)
|
|
|
616 |
</div>
|
|
|
617 |
|
|
|
618 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
619 |
<p class="short-description">Return an array of stored cache ids</p>
|
|
|
620 |
<ul class="tags">
|
|
|
621 |
<li><span class="field">return:</span> array of stored cache ids (string)</li>
|
|
|
622 |
<li><span class="field">access:</span> public</li>
|
|
|
623 |
</ul>
|
|
|
624 |
|
|
|
625 |
<div class="method-signature">
|
|
|
626 |
<span class="method-result">array</span>
|
|
|
627 |
<span class="method-name">
|
|
|
628 |
getIds
|
|
|
629 |
</span>
|
|
|
630 |
()
|
|
|
631 |
</div>
|
|
|
632 |
|
|
|
633 |
|
|
|
634 |
|
|
|
635 |
</div>
|
|
|
636 |
<a name="methodgetIdsAvecLesTags" id="getIdsAvecLesTags"><!-- --></a>
|
|
|
637 |
<div class="evenrow">
|
|
|
638 |
|
|
|
639 |
<div class="method-header">
|
|
|
640 |
<span class="method-title">getIdsAvecLesTags</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Cache.php.html#a299">299</a></span>)
|
|
|
641 |
</div>
|
|
|
642 |
|
|
|
643 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
644 |
<p class="short-description">Return an array of stored cache ids which match given tags</p>
|
|
|
645 |
<p class="description"><p>In case of multiple tags, a logical AND is made between tags</p></p>
|
|
|
646 |
<ul class="tags">
|
|
|
647 |
<li><span class="field">return:</span> array of matching cache ids (string)</li>
|
|
|
648 |
<li><span class="field">access:</span> public</li>
|
|
|
649 |
</ul>
|
|
|
650 |
|
|
|
651 |
<div class="method-signature">
|
|
|
652 |
<span class="method-result">array</span>
|
|
|
653 |
<span class="method-name">
|
|
|
654 |
getIdsAvecLesTags
|
|
|
655 |
</span>
|
|
|
656 |
([<span class="var-type">array</span> <span class="var-name">$tags</span> = <span class="var-default">array()</span>])
|
|
|
657 |
</div>
|
|
|
658 |
|
|
|
659 |
<ul class="parameters">
|
|
|
660 |
<li>
|
|
|
661 |
<span class="var-type">array</span>
|
|
|
662 |
<span class="var-name">$tags</span><span class="var-description">: array of tags</span> </li>
|
|
|
663 |
</ul>
|
|
|
664 |
|
|
|
665 |
|
|
|
666 |
</div>
|
|
|
667 |
<a name="methodgetIdsAvecUnTag" id="getIdsAvecUnTag"><!-- --></a>
|
|
|
668 |
<div class="oddrow">
|
|
|
669 |
|
|
|
670 |
<div class="method-header">
|
|
|
671 |
<span class="method-title">getIdsAvecUnTag</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Cache.php.html#a327">327</a></span>)
|
|
|
672 |
</div>
|
|
|
673 |
|
|
|
674 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
675 |
<p class="short-description">Return an array of stored cache ids which match any given tags</p>
|
|
|
676 |
<p class="description"><p>In case of multiple tags, a logical OR is made between tags</p></p>
|
|
|
677 |
<ul class="tags">
|
|
|
678 |
<li><span class="field">return:</span> array of matching any cache ids (string)</li>
|
|
|
679 |
<li><span class="field">access:</span> public</li>
|
|
|
680 |
</ul>
|
|
|
681 |
|
|
|
682 |
<div class="method-signature">
|
|
|
683 |
<span class="method-result">array</span>
|
|
|
684 |
<span class="method-name">
|
|
|
685 |
getIdsAvecUnTag
|
|
|
686 |
</span>
|
|
|
687 |
([<span class="var-type">array</span> <span class="var-name">$tags</span> = <span class="var-default">array()</span>])
|
|
|
688 |
</div>
|
|
|
689 |
|
|
|
690 |
<ul class="parameters">
|
|
|
691 |
<li>
|
|
|
692 |
<span class="var-type">array</span>
|
|
|
693 |
<span class="var-name">$tags</span><span class="var-description">: array of tags</span> </li>
|
|
|
694 |
</ul>
|
|
|
695 |
|
|
|
696 |
|
|
|
697 |
</div>
|
|
|
698 |
<a name="methodgetIdsSansLesTags" id="getIdsSansLesTags"><!-- --></a>
|
|
|
699 |
<div class="evenrow">
|
|
|
700 |
|
|
|
701 |
<div class="method-header">
|
|
|
702 |
<span class="method-title">getIdsSansLesTags</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Cache.php.html#a313">313</a></span>)
|
|
|
703 |
</div>
|
|
|
704 |
|
|
|
705 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
706 |
<p class="short-description">Return an array of stored cache ids which don't match given tags</p>
|
|
|
707 |
<p class="description"><p>In case of multiple tags, a logical OR is made between tags</p></p>
|
|
|
708 |
<ul class="tags">
|
|
|
709 |
<li><span class="field">return:</span> array of not matching cache ids (string)</li>
|
|
|
710 |
<li><span class="field">access:</span> public</li>
|
|
|
711 |
</ul>
|
|
|
712 |
|
|
|
713 |
<div class="method-signature">
|
|
|
714 |
<span class="method-result">array</span>
|
|
|
715 |
<span class="method-name">
|
|
|
716 |
getIdsSansLesTags
|
|
|
717 |
</span>
|
|
|
718 |
([<span class="var-type">array</span> <span class="var-name">$tags</span> = <span class="var-default">array()</span>])
|
|
|
719 |
</div>
|
|
|
720 |
|
|
|
721 |
<ul class="parameters">
|
|
|
722 |
<li>
|
|
|
723 |
<span class="var-type">array</span>
|
|
|
724 |
<span class="var-name">$tags</span><span class="var-description">: array of tags</span> </li>
|
|
|
725 |
</ul>
|
|
|
726 |
|
|
|
727 |
|
|
|
728 |
</div>
|
|
|
729 |
<a name="methodgetMetadonnees" id="getMetadonnees"><!-- --></a>
|
|
|
730 |
<div class="oddrow">
|
|
|
731 |
|
|
|
732 |
<div class="method-header">
|
|
|
733 |
<span class="method-title">getMetadonnees</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Cache.php.html#a353">353</a></span>)
|
|
|
734 |
</div>
|
|
|
735 |
|
|
|
736 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
737 |
<p class="short-description">Return an array of metadatas for the given cache id</p>
|
|
|
738 |
<p class="description"><p>The array will 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>
|
|
|
739 |
<ul class="tags">
|
|
|
740 |
<li><span class="field">return:</span> array of metadatas (false if the cache id is not found)</li>
|
|
|
741 |
<li><span class="field">access:</span> public</li>
|
|
|
742 |
</ul>
|
|
|
743 |
|
|
|
744 |
<div class="method-signature">
|
|
|
745 |
<span class="method-result">array</span>
|
|
|
746 |
<span class="method-name">
|
|
|
747 |
getMetadonnees
|
|
|
748 |
</span>
|
|
|
749 |
(<span class="var-type">string</span> <span class="var-name">$id</span>)
|
|
|
750 |
</div>
|
|
|
751 |
|
|
|
752 |
<ul class="parameters">
|
|
|
753 |
<li>
|
|
|
754 |
<span class="var-type">string</span>
|
|
|
755 |
<span class="var-name">$id</span><span class="var-description">: cache id</span> </li>
|
|
|
756 |
</ul>
|
|
|
757 |
|
|
|
758 |
|
|
|
759 |
</div>
|
|
|
760 |
<a name="methodgetPourcentageRemplissage" id="getPourcentageRemplissage"><!-- --></a>
|
|
|
761 |
<div class="evenrow">
|
|
|
762 |
|
|
|
763 |
<div class="method-header">
|
|
|
764 |
<span class="method-title">getPourcentageRemplissage</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Cache.php.html#a338">338</a></span>)
|
|
|
765 |
</div>
|
|
|
766 |
|
|
|
767 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
768 |
<p class="short-description">Return the filling percentage of the backend storage</p>
|
|
|
769 |
<ul class="tags">
|
|
|
770 |
<li><span class="field">return:</span> integer between 0 and 100</li>
|
|
|
771 |
<li><span class="field">access:</span> public</li>
|
|
|
772 |
</ul>
|
|
|
773 |
|
|
|
774 |
<div class="method-signature">
|
|
|
775 |
<span class="method-result">int</span>
|
|
|
776 |
<span class="method-name">
|
|
|
777 |
getPourcentageRemplissage
|
|
|
778 |
</span>
|
|
|
779 |
()
|
|
|
780 |
</div>
|
|
|
781 |
|
|
|
782 |
|
|
|
783 |
|
|
|
784 |
</div>
|
|
|
785 |
<a name="methodgetTags" id="getTags"><!-- --></a>
|
|
|
786 |
<div class="oddrow">
|
|
|
787 |
|
|
|
788 |
<div class="method-header">
|
|
|
789 |
<span class="method-title">getTags</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Cache.php.html#a287">287</a></span>)
|
|
|
790 |
</div>
|
|
|
791 |
|
|
|
792 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
793 |
<p class="short-description">Return an array of stored tags</p>
|
|
|
794 |
<ul class="tags">
|
|
|
795 |
<li><span class="field">return:</span> array of stored tags (string)</li>
|
|
|
796 |
<li><span class="field">access:</span> public</li>
|
|
|
797 |
</ul>
|
|
|
798 |
|
|
|
799 |
<div class="method-signature">
|
|
|
800 |
<span class="method-result">array</span>
|
|
|
801 |
<span class="method-name">
|
|
|
802 |
getTags
|
|
|
803 |
</span>
|
|
|
804 |
()
|
|
|
805 |
</div>
|
|
|
806 |
|
|
|
807 |
|
|
|
808 |
|
|
|
809 |
</div>
|
|
|
810 |
<a name="methodgetTimestampExpiration" id="getTimestampExpiration"><!-- --></a>
|
|
|
811 |
<div class="evenrow">
|
|
|
812 |
|
|
|
813 |
<div class="method-header">
|
|
|
814 |
<span class="method-title">getTimestampExpiration</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Cache.php.html#a495">495</a></span>)
|
|
|
815 |
</div>
|
|
|
816 |
|
|
|
817 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
818 |
<p class="short-description">Calcule et retourne le timestamp d'expiration</p>
|
|
|
819 |
<ul class="tags">
|
|
|
820 |
<li><span class="field">return:</span> timestamp d'expiration (unix timestamp)</li>
|
|
|
821 |
<li><span class="field">access:</span> public</li>
|
|
|
822 |
</ul>
|
|
|
823 |
|
|
|
824 |
<div class="method-signature">
|
|
|
825 |
<span class="method-result">int</span>
|
|
|
826 |
<span class="method-name">
|
|
|
827 |
getTimestampExpiration
|
|
|
828 |
</span>
|
|
|
829 |
(<span class="var-type"></span> <span class="var-name">$duree_de_vie</span>)
|
|
|
830 |
</div>
|
|
|
831 |
|
|
|
832 |
<ul class="parameters">
|
|
|
833 |
<li>
|
|
|
834 |
<span class="var-type"></span>
|
|
|
835 |
<span class="var-name">$duree_de_vie</span> </li>
|
|
|
836 |
</ul>
|
|
|
837 |
|
|
|
838 |
|
|
|
839 |
</div>
|
|
|
840 |
<a name="methodnettoyer" id="nettoyer"><!-- --></a>
|
|
|
841 |
<div class="oddrow">
|
|
|
842 |
|
|
|
843 |
<div class="method-header">
|
|
|
844 |
<span class="method-title">nettoyer</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Cache.php.html#a254">254</a></span>)
|
|
|
845 |
</div>
|
|
|
846 |
|
|
|
847 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
848 |
<p class="short-description">Nettoyage des enregistrements en cache</p>
|
|
|
849 |
<p class="description"><p>Mode de nettoyage disponibles : 'tous' (défaut) => supprime tous les enregistrements ($tags n'est pas utilisé) 'expiration' => supprime tous les enregistrements dont la date d'expériration est dépassée ($tags n'est pas utilisé) 'avecLesTag' => supprime tous les enregistrements contenant tous les tags indiqués 'sansLesTag' => supprime tous les enregistrements contenant aucun des tags indiqués 'avecUnTag' => supprime tous les enregistrements contenant au moins un des tags indiqués</p></p>
|
|
|
850 |
<ul class="tags">
|
|
|
851 |
<li><span class="field">return:</span> True si ok</li>
|
|
|
852 |
<li><span class="field">access:</span> public</li>
|
|
|
853 |
</ul>
|
|
|
854 |
|
|
|
855 |
<div class="method-signature">
|
|
|
856 |
<span class="method-result">boolean</span>
|
|
|
857 |
<span class="method-name">
|
|
|
858 |
nettoyer
|
|
|
859 |
</span>
|
|
|
860 |
([<span class="var-type">string</span> <span class="var-name">$mode</span> = <span class="var-default">self::NETTOYAGE_MODE_TOUS</span>], [<span class="var-type">array|string</span> <span class="var-name">$tags</span> = <span class="var-default">array()</span>])
|
|
|
861 |
</div>
|
|
|
862 |
|
|
|
863 |
<ul class="parameters">
|
|
|
864 |
<li>
|
|
|
865 |
<span class="var-type">string</span>
|
|
|
866 |
<span class="var-name">$mode</span><span class="var-description">: mode de nettoyage</span> </li>
|
|
|
867 |
<li>
|
|
|
868 |
<span class="var-type">array|string</span>
|
|
|
869 |
<span class="var-name">$tags</span><span class="var-description">: peut être un tableau de chaîne ou une simple chaine.</span> </li>
|
|
|
870 |
</ul>
|
|
|
871 |
|
|
|
872 |
|
|
|
873 |
</div>
|
|
|
874 |
<a name="methodsauver" id="sauver"><!-- --></a>
|
|
|
875 |
<div class="evenrow">
|
|
|
876 |
|
|
|
877 |
<div class="method-header">
|
|
|
878 |
<span class="method-title">sauver</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Cache.php.html#a202">202</a></span>)
|
|
|
879 |
</div>
|
|
|
880 |
|
|
|
881 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
882 |
<p class="short-description">Sauvegarde en cache les données passées en paramètre.</p>
|
|
|
883 |
<ul class="tags">
|
|
|
884 |
<li><span class="field">return:</span> True si aucun problème n'est survenu.</li>
|
|
|
885 |
<li><span class="field">access:</span> public</li>
|
|
|
886 |
</ul>
|
|
|
887 |
|
|
|
888 |
<div class="method-signature">
|
|
|
889 |
<span class="method-result">boolean</span>
|
|
|
890 |
<span class="method-name">
|
|
|
891 |
sauver
|
|
|
892 |
</span>
|
|
|
893 |
(<span class="var-type">mixed</span> <span class="var-name">$donnees</span>, [<span class="var-type">string</span> <span class="var-name">$id</span> = <span class="var-default">null</span>], [<span class="var-type">array</span> <span class="var-name">$tags</span> = <span class="var-default">array()</span>], [<span class="var-type">int</span> <span class="var-name">$duree_de_vie_specifique</span> = <span class="var-default">false</span>])
|
|
|
894 |
</div>
|
|
|
895 |
|
|
|
896 |
<ul class="parameters">
|
|
|
897 |
<li>
|
|
|
898 |
<span class="var-type">mixed</span>
|
|
|
899 |
<span class="var-name">$donnees</span><span class="var-description">: Données à mettre en cache (peut être différent d'une chaine si serialisation_auto vaut true).</span> </li>
|
|
|
900 |
<li>
|
|
|
901 |
<span class="var-type">string</span>
|
|
|
902 |
<span class="var-name">$id</span><span class="var-description">: Identifiant du cache (s'il n'est pas définit, le dernier identifiant sera utilisé).</span> </li>
|
|
|
903 |
<li>
|
|
|
904 |
<span class="var-type">array</span>
|
|
|
905 |
<span class="var-name">$tags</span><span class="var-description">: Mots-clés du cache.</span> </li>
|
|
|
906 |
<li>
|
|
|
907 |
<span class="var-type">int</span>
|
|
|
908 |
<span class="var-name">$duree_de_vie_specifique</span><span class="var-description">: Si != false, indique une durée de vie spécifique pour cet enregistrement en cache (null => durée de vie infinie)</span> </li>
|
|
|
909 |
</ul>
|
|
|
910 |
|
|
|
911 |
|
|
|
912 |
</div>
|
|
|
913 |
<a name="methodsetEmplacement" id="setEmplacement"><!-- --></a>
|
|
|
914 |
<div class="oddrow">
|
|
|
915 |
|
|
|
916 |
<div class="method-header">
|
|
|
917 |
<span class="method-title">setEmplacement</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Cache.php.html#a140">140</a></span>)
|
|
|
918 |
</div>
|
|
|
919 |
|
|
|
920 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
921 |
<p class="short-description">Permet de (re-)définir l'emplacement pour le stockage du cache.</p>
|
|
|
922 |
<p class="description"><p>En fonction du mode de stockage utilisé , l'emplacement indiqué correspondra au chemin du : <ul><li>dossier où stocker les fichiers pour le mode "fichier".</li><li>fichier de la base de données pour le mode "sqlite".</li></ul></p></p>
|
|
|
923 |
<ul class="tags">
|
|
|
924 |
<li><span class="field">access:</span> public</li>
|
|
|
925 |
</ul>
|
|
|
926 |
|
|
|
927 |
<div class="method-signature">
|
|
|
928 |
<span class="method-result">void</span>
|
|
|
929 |
<span class="method-name">
|
|
|
930 |
setEmplacement
|
|
|
931 |
</span>
|
|
|
932 |
(<span class="var-type">string</span> <span class="var-name">$emplacement</span>)
|
|
|
933 |
</div>
|
|
|
934 |
|
|
|
935 |
<ul class="parameters">
|
|
|
936 |
<li>
|
|
|
937 |
<span class="var-type">string</span>
|
|
|
938 |
<span class="var-name">$emplacement</span><span class="var-description">: chemin vers dossier (Cache::STOCKAGE_MODE_FICHIER) ou fichier base Sqlite (Cache::STOCKAGE_MODE_SQLITE)</span> </li>
|
|
|
939 |
</ul>
|
|
|
940 |
|
|
|
941 |
|
|
|
942 |
</div>
|
|
|
943 |
<a name="methodsupprimer" id="supprimer"><!-- --></a>
|
|
|
944 |
<div class="evenrow">
|
|
|
945 |
|
|
|
946 |
<div class="method-header">
|
|
|
947 |
<span class="method-title">supprimer</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Cache.php.html#a230">230</a></span>)
|
|
|
948 |
</div>
|
|
|
949 |
|
|
|
950 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
951 |
<p class="short-description">Supprime un enregistrement en cache.</p>
|
|
|
952 |
<ul class="tags">
|
|
|
953 |
<li><span class="field">return:</span> True si ok</li>
|
|
|
954 |
<li><span class="field">access:</span> public</li>
|
|
|
955 |
</ul>
|
|
|
956 |
|
|
|
957 |
<div class="method-signature">
|
|
|
958 |
<span class="method-result">boolean</span>
|
|
|
959 |
<span class="method-name">
|
|
|
960 |
supprimer
|
|
|
961 |
</span>
|
|
|
962 |
(<span class="var-type">string</span> <span class="var-name">$id</span>)
|
|
|
963 |
</div>
|
|
|
964 |
|
|
|
965 |
<ul class="parameters">
|
|
|
966 |
<li>
|
|
|
967 |
<span class="var-type">string</span>
|
|
|
968 |
<span class="var-name">$id</span><span class="var-description">: Identificant du cache à supprimer.</span> </li>
|
|
|
969 |
</ul>
|
|
|
970 |
|
|
|
971 |
|
|
|
972 |
</div>
|
|
|
973 |
<a name="methodtester" id="tester"><!-- --></a>
|
|
|
974 |
<div class="oddrow">
|
|
|
975 |
|
|
|
976 |
<div class="method-header">
|
|
|
977 |
<span class="method-title">tester</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Cache.php.html#a182">182</a></span>)
|
|
|
978 |
</div>
|
|
|
979 |
|
|
|
980 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
981 |
<p class="short-description">Test if a cache is available for the given id</p>
|
|
|
982 |
<ul class="tags">
|
|
|
983 |
<li><span class="field">return:</span> Last modified time of cache entry if it is available, false otherwise</li>
|
|
|
984 |
<li><span class="field">access:</span> public</li>
|
|
|
985 |
</ul>
|
|
|
986 |
|
|
|
987 |
<div class="method-signature">
|
|
|
988 |
<span class="method-result">int|false</span>
|
|
|
989 |
<span class="method-name">
|
|
|
990 |
tester
|
|
|
991 |
</span>
|
|
|
992 |
(<span class="var-type">string</span> <span class="var-name">$id</span>)
|
|
|
993 |
</div>
|
|
|
994 |
|
|
|
995 |
<ul class="parameters">
|
|
|
996 |
<li>
|
|
|
997 |
<span class="var-type">string</span>
|
|
|
998 |
<span class="var-name">$id</span><span class="var-description">: Cache id</span> </li>
|
|
|
999 |
</ul>
|
|
|
1000 |
|
|
|
1001 |
|
|
|
1002 |
</div>
|
|
|
1003 |
|
|
|
1004 |
</div>
|
|
|
1005 |
</div>
|
|
|
1006 |
|
|
|
1007 |
<a name="sec-consts"></a>
|
|
|
1008 |
<div class="info-box">
|
|
|
1009 |
<div class="info-box-title">Class Constants</div>
|
|
|
1010 |
<div class="nav-bar">
|
|
|
1011 |
<a href="#sec-description">Description</a> |
|
|
|
1012 |
<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
|
|
|
1013 |
|
|
|
1014 |
|
|
|
1015 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
|
|
1016 |
|
|
|
|
1017 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
1018 |
|
|
|
1019 |
</div>
|
|
|
1020 |
<div class="info-box-body">
|
|
|
1021 |
<a name="constNETTOYAGE_MODE_AVEC_LES_TAGS" id="NETTOYAGE_MODE_AVEC_LES_TAGS"><!-- --></A>
|
|
|
1022 |
<div class="evenrow">
|
|
|
1023 |
|
|
|
1024 |
<div class="const-header">
|
|
|
1025 |
<img src="../media/images/Variable.png" />
|
|
|
1026 |
<span class="const-title">
|
|
|
1027 |
<span class="const-name">NETTOYAGE_MODE_AVEC_LES_TAGS</span>
|
|
|
1028 |
= <span class="const-default"> "avecLesTags"</span>
|
|
|
1029 |
(line <span class="line-number"><a href="../__filesource/fsource_Framework__Cache.php.html#a30">30</a></span>)
|
|
|
1030 |
</span>
|
|
|
1031 |
</div>
|
|
|
1032 |
|
|
|
1033 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
1034 |
<p class="short-description">'avecLesTags' : supprime tous les enregistrements contenant tous les tags indiqués.</p>
|
|
|
1035 |
|
|
|
1036 |
|
|
|
1037 |
</div>
|
|
|
1038 |
<a name="constNETTOYAGE_MODE_AVEC_UN_TAG" id="NETTOYAGE_MODE_AVEC_UN_TAG"><!-- --></A>
|
|
|
1039 |
<div class="oddrow">
|
|
|
1040 |
|
|
|
1041 |
<div class="const-header">
|
|
|
1042 |
<img src="../media/images/Variable.png" />
|
|
|
1043 |
<span class="const-title">
|
|
|
1044 |
<span class="const-name">NETTOYAGE_MODE_AVEC_UN_TAG</span>
|
|
|
1045 |
= <span class="const-default"> "avecUnTag"</span>
|
|
|
1046 |
(line <span class="line-number"><a href="../__filesource/fsource_Framework__Cache.php.html#a34">34</a></span>)
|
|
|
1047 |
</span>
|
|
|
1048 |
</div>
|
|
|
1049 |
|
|
|
1050 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
1051 |
<p class="short-description">'avecUnTag' : supprime tous les enregistrements contenant au moins un des tags indiqués.</p>
|
|
|
1052 |
|
|
|
1053 |
|
|
|
1054 |
</div>
|
|
|
1055 |
<a name="constNETTOYAGE_MODE_EXPIRATION" id="NETTOYAGE_MODE_EXPIRATION"><!-- --></A>
|
|
|
1056 |
<div class="evenrow">
|
|
|
1057 |
|
|
|
1058 |
<div class="const-header">
|
|
|
1059 |
<img src="../media/images/Variable.png" />
|
|
|
1060 |
<span class="const-title">
|
|
|
1061 |
<span class="const-name">NETTOYAGE_MODE_EXPIRATION</span>
|
|
|
1062 |
= <span class="const-default"> "expiration"</span>
|
|
|
1063 |
(line <span class="line-number"><a href="../__filesource/fsource_Framework__Cache.php.html#a28">28</a></span>)
|
|
|
1064 |
</span>
|
|
|
1065 |
</div>
|
|
|
1066 |
|
|
|
1067 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
1068 |
<p class="short-description">'expiration' : supprime tous les enregistrements dont la date d'expériration est dépassée.</p>
|
|
|
1069 |
|
|
|
1070 |
|
|
|
1071 |
</div>
|
|
|
1072 |
<a name="constNETTOYAGE_MODE_SANS_LES_TAGS" id="NETTOYAGE_MODE_SANS_LES_TAGS"><!-- --></A>
|
|
|
1073 |
<div class="oddrow">
|
|
|
1074 |
|
|
|
1075 |
<div class="const-header">
|
|
|
1076 |
<img src="../media/images/Variable.png" />
|
|
|
1077 |
<span class="const-title">
|
|
|
1078 |
<span class="const-name">NETTOYAGE_MODE_SANS_LES_TAGS</span>
|
|
|
1079 |
= <span class="const-default"> "sansLesTags"</span>
|
|
|
1080 |
(line <span class="line-number"><a href="../__filesource/fsource_Framework__Cache.php.html#a32">32</a></span>)
|
|
|
1081 |
</span>
|
|
|
1082 |
</div>
|
|
|
1083 |
|
|
|
1084 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
1085 |
<p class="short-description">'sansLesTags' : supprime tous les enregistrements contenant aucun des tags indiqués.</p>
|
|
|
1086 |
|
|
|
1087 |
|
|
|
1088 |
</div>
|
|
|
1089 |
<a name="constNETTOYAGE_MODE_TOUS" id="NETTOYAGE_MODE_TOUS"><!-- --></A>
|
|
|
1090 |
<div class="evenrow">
|
|
|
1091 |
|
|
|
1092 |
<div class="const-header">
|
|
|
1093 |
<img src="../media/images/Variable.png" />
|
|
|
1094 |
<span class="const-title">
|
|
|
1095 |
<span class="const-name">NETTOYAGE_MODE_TOUS</span>
|
|
|
1096 |
= <span class="const-default"> "tous"</span>
|
|
|
1097 |
(line <span class="line-number"><a href="../__filesource/fsource_Framework__Cache.php.html#a26">26</a></span>)
|
|
|
1098 |
</span>
|
|
|
1099 |
</div>
|
|
|
1100 |
|
|
|
1101 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
1102 |
<p class="short-description">'tous' (par défaut) : supprime tous les enregistrements.</p>
|
|
|
1103 |
|
|
|
1104 |
|
|
|
1105 |
</div>
|
|
|
1106 |
<a name="constSTOCKAGE_MODE_FICHIER" id="STOCKAGE_MODE_FICHIER"><!-- --></A>
|
|
|
1107 |
<div class="oddrow">
|
|
|
1108 |
|
|
|
1109 |
<div class="const-header">
|
|
|
1110 |
<img src="../media/images/Variable.png" />
|
|
|
1111 |
<span class="const-title">
|
|
|
1112 |
<span class="const-name">STOCKAGE_MODE_FICHIER</span>
|
|
|
1113 |
= <span class="const-default"> "Fichier"</span>
|
|
|
1114 |
(line <span class="line-number"><a href="../__filesource/fsource_Framework__Cache.php.html#a21">21</a></span>)
|
|
|
1115 |
</span>
|
|
|
1116 |
</div>
|
|
|
1117 |
|
|
|
1118 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
1119 |
<p class="short-description">Socke les enregistrements du cache dans des fichiers textes.</p>
|
|
|
1120 |
|
|
|
1121 |
|
|
|
1122 |
</div>
|
|
|
1123 |
<a name="constSTOCKAGE_MODE_SIMPLE" id="STOCKAGE_MODE_SIMPLE"><!-- --></A>
|
|
|
1124 |
<div class="evenrow">
|
|
|
1125 |
|
|
|
1126 |
<div class="const-header">
|
|
|
1127 |
<img src="../media/images/Variable.png" />
|
|
|
1128 |
<span class="const-title">
|
|
|
1129 |
<span class="const-name">STOCKAGE_MODE_SIMPLE</span>
|
|
|
1130 |
= <span class="const-default"> "FichierSimple"</span>
|
|
|
1131 |
(line <span class="line-number"><a href="../__filesource/fsource_Framework__Cache.php.html#a19">19</a></span>)
|
|
|
1132 |
</span>
|
|
|
1133 |
</div>
|
|
|
1134 |
|
|
|
1135 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
1136 |
<p class="short-description">Socke les enregistrements du cache dans des fichiers textes de façon extremement simple.</p>
|
|
|
1137 |
|
|
|
1138 |
|
|
|
1139 |
</div>
|
|
|
1140 |
<a name="constSTOCKAGE_MODE_SQLITE" id="STOCKAGE_MODE_SQLITE"><!-- --></A>
|
|
|
1141 |
<div class="oddrow">
|
|
|
1142 |
|
|
|
1143 |
<div class="const-header">
|
|
|
1144 |
<img src="../media/images/Variable.png" />
|
|
|
1145 |
<span class="const-title">
|
|
|
1146 |
<span class="const-name">STOCKAGE_MODE_SQLITE</span>
|
|
|
1147 |
= <span class="const-default"> "Sqlite"</span>
|
|
|
1148 |
(line <span class="line-number"><a href="../__filesource/fsource_Framework__Cache.php.html#a23">23</a></span>)
|
|
|
1149 |
</span>
|
|
|
1150 |
</div>
|
|
|
1151 |
|
|
|
1152 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
1153 |
<p class="short-description">Socke les enregistrements du cache dans une base de données SQLite.</p>
|
|
|
1154 |
|
|
|
1155 |
|
|
|
1156 |
</div>
|
|
|
1157 |
|
|
|
1158 |
</div>
|
|
|
1159 |
</div>
|
|
|
1160 |
|
|
|
1161 |
<p class="notes" id="credit">
|
| 300 |
jpm |
1162 |
Documentation generated on Tue, 18 Jan 2011 15:13:04 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
|
| 297 |
jpm |
1163 |
</p>
|
|
|
1164 |
</div></body>
|
|
|
1165 |
</html>
|