Subversion Repositories Applications.framework

Rev

Rev 464 | Details | Compare with Previous | Last modification | View Log | RSS feed

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