New file |
0,0 → 1,1339 |
<!DOCTYPE html> |
<html> |
<head> |
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
<meta name="generator" content="ApiGen 2.8.0"> |
|
<title>Class Cache | TBFramework - v0.4</title> |
|
<script type="text/javascript" src="resources/combined.js?4205936287"></script> |
<script type="text/javascript" src="elementlist.js?1964084359"></script> |
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360"> |
|
</head> |
|
<body> |
<div id="left"> |
<div id="menu"> |
<a href="index.html" title="Overview"><span>Overview</span></a> |
|
|
<div id="groups"> |
<h3>Packages</h3> |
<ul> |
<li class="active"><a href="package-Framework.html">Framework</a> |
</li> |
<li><a href="package-None.html">None</a> |
</li> |
<li><a href="package-PHP.html">PHP</a> |
</li> |
<li><a href="package-Utilitaire.html">Utilitaire</a> |
</li> |
</ul> |
</div> |
|
<hr> |
|
|
<div id="elements"> |
<h3>Classes</h3> |
<ul> |
<li><a href="class-Bdd.html">Bdd</a></li> |
<li class="active"><a href="class-Cache.html">Cache</a></li> |
<li><a href="class-CacheSimple.html">CacheSimple</a></li> |
<li><a href="class-Chronometre.html">Chronometre</a></li> |
<li><a href="class-Cli.html">Cli</a></li> |
<li><a href="class-Config.html">Config</a></li> |
<li><a href="class-Controleur.html">Controleur</a></li> |
<li><a href="class-Debug.html">Debug</a></li> |
<li><a href="class-Framework.html">Framework</a></li> |
<li><a href="class-GestionnaireException.html">GestionnaireException</a></li> |
<li><a href="class-I18n.html">I18n</a></li> |
<li><a href="class-Log.html">Log</a></li> |
<li><a href="class-MonService.html">MonService</a></li> |
<li><a href="class-Registre.html">Registre</a></li> |
<li><a href="class-RestClient.html">RestClient</a></li> |
<li><a href="class-RestServeur.html">RestServeur</a></li> |
<li><a href="class-RestService.html">RestService</a></li> |
<li><a href="class-Script.html">Script</a></li> |
<li><a href="class-ServiceCacheFichier.html">ServiceCacheFichier</a></li> |
<li><a href="class-ServiceCacheSimple.html">ServiceCacheSimple</a></li> |
<li><a href="class-ServiceCacheSqlite.html">ServiceCacheSqlite</a></li> |
<li><a href="class-SquelettePhp.html">SquelettePhp</a></li> |
<li><a href="class-Url.html">Url</a></li> |
</ul> |
|
|
|
|
|
</div> |
</div> |
</div> |
|
<div id="splitter"></div> |
|
<div id="right"> |
<div id="rightInner"> |
<form id="search"> |
<input type="hidden" name="cx" value=""> |
<input type="hidden" name="ie" value="UTF-8"> |
<input type="text" name="q" class="text"> |
<input type="submit" value="Search"> |
</form> |
|
<div id="navigation"> |
<ul> |
<li> |
<a href="index.html" title="Overview"><span>Overview</span></a> |
</li> |
<li> |
<a href="package-Framework.html" title="Summary of Framework"><span>Package</span></a> |
</li> |
<li class="active"> |
<span>Class</span> </li> |
</ul> |
<ul> |
<li> |
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a> |
</li> |
<li> |
<a href="deprecated.html" title="List of deprecated elements"><span>Deprecated</span></a> |
</li> |
<li> |
<a href="todo.html" title="Todo list"><span>Todo</span></a> |
</li> |
</ul> |
<ul> |
</ul> |
</div> |
|
<div id="content" class="class"> |
<h1>Class Cache</h1> |
|
|
<div class="description"> |
|
<p>Classe Cache permettant de mettre en cache des données. Basée sur les |
principes de Zend_Cache (Copyright (c) 2005-2010, Zend Technologies USA, Inc. |
All rights reserved.)</p> |
|
</div> |
|
|
|
|
|
|
|
|
|
<div class="info"> |
|
|
|
<b>Package:</b> <a href="package-Framework.html">Framework</a><br> |
|
<b>Category:</b> |
php 5.2<br> |
<b>Copyright:</b> |
Copyright (c) 2010, Tela Botanica (<a |
href="mailto:accueil@tela-botanica.org">accueil@<!-- -->tela-botanica.org</a>)<br> |
<b>License:</b> |
<a href="http://framework.zend.com/license/new-bsd">Licence New BSD</a><br> |
<b>License:</b> |
<a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL</a><br> |
<b>License:</b> |
<a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL</a><br> |
<b>Author:</b> |
Jean-Pascal MILCENT <<a |
href="mailto:jpm@tela-botanica.org">jpm@<!-- -->tela-botanica.org</a>><br> |
<b>Version:</b> |
$Id: Cache.php 299 2011-01-18 14:03:46Z jpm $<br> |
<b>Link:</b> |
/doc/framework/<br> |
<b>Located at</b> <a href="source-class-Cache.html#3-507" title="Go to source code">framework/Cache.php</a><br> |
</div> |
|
|
|
<table class="summary" id="methods"> |
<caption>Methods summary</caption> |
<tr data-order="__construct" id="___construct"> |
|
<td class="attributes"><code> |
public |
|
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#___construct">#</a> |
<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> |
|
<div class="description short"> |
|
</div> |
|
<div class="description detailed hidden"> |
|
|
|
|
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="setEmplacement" id="_setEmplacement"> |
|
<td class="attributes"><code> |
public |
|
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_setEmplacement">#</a> |
<code><a href="source-class-Cache.html#132-146" title="Go to source code">setEmplacement</a>( <span>string <var>$emplacement</var></span> )</code> |
|
<div class="description short"> |
|
<p>Permet de (re-)définir l'emplacement pour le stockage du cache. En fonction |
du mode de stockage utilisé , l'emplacement indiqué correspondra au chemin du |
:<br /> |
- dossier où stocker les fichiers pour le mode "fichier".<br /> |
- fichier de la base de données pour le mode "sqlite".</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Permet de (re-)définir l'emplacement pour le stockage du cache. En fonction |
du mode de stockage utilisé , l'emplacement indiqué correspondra au chemin du |
: - dossier où stocker les fichiers pour le mode "fichier". - fichier de la |
base de données pour le mode "sqlite".</p> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$emplacement</var></dt> |
<dd><code>string</code><br>$emplacement chemin vers dossier (Cache::STOCKAGE_MODE_FICHIER) ou fichier base |
Sqlite (Cache::STOCKAGE_MODE_SQLITE)</dd> |
</dl></div> |
|
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="fabriquer" id="_fabriquer"> |
|
<td class="attributes"><code> |
public static |
|
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_fabriquer">#</a> |
<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> |
|
<div class="description short"> |
|
</div> |
|
<div class="description detailed hidden"> |
|
|
|
|
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="charger" id="_charger"> |
|
<td class="attributes"><code> |
public |
mixed|false |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_charger">#</a> |
<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> |
|
<div class="description short"> |
|
<p>Teste si un cache est disponible pour l'identifiant donné et (si oui) le |
retourne (false dans le cas contraire)</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Teste si un cache est disponible pour l'identifiant donné et (si oui) le |
retourne (false dans le cas contraire)</p> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$id</var></dt> |
<dd><code>string</code><br>$id Identifiant de cache.</dd> |
<dt><var>$ne_pas_tester_validiter_du_cache</var></dt> |
<dd><code>boolean</code><br>$ne_pas_tester_validiter_du_cache Si mis à true, la validité du cache n'est |
pas testée</dd> |
</dl></div> |
|
<h4>Returns</h4> |
<div class="list"> |
<code>mixed|false</code><br>Cached datas<br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="tester" id="_tester"> |
|
<td class="attributes"><code> |
public |
integer|false |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_tester">#</a> |
<code><a href="source-class-Cache.html#176-191" title="Go to source code">tester</a>( <span>string <var>$id</var></span> )</code> |
|
<div class="description short"> |
|
<p>Test if a cache is available for the given id</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Test if a cache is available for the given id</p> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$id</var></dt> |
<dd><code>string</code><br>$id Cache id</dd> |
</dl></div> |
|
<h4>Returns</h4> |
<div class="list"> |
<code>integer|false</code><br>Last modified time of cache entry if it is available, false otherwise<br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="sauver" id="_sauver"> |
|
<td class="attributes"><code> |
public |
boolean |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_sauver">#</a> |
<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> |
|
<div class="description short"> |
|
<p>Sauvegarde en cache les données passées en paramètre.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Sauvegarde en cache les données passées en paramètre.</p> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$donnees</var></dt> |
<dd><code>mixed</code><br>$donnees Données à mettre en cache (peut être différent d'une chaine si |
serialisation_auto vaut true).</dd> |
<dt><var>$id</var></dt> |
<dd><code>string</code><br>$id Identifiant du cache (s'il n'est pas définit, le dernier identifiant sera |
utilisé).</dd> |
<dt><var>$tags</var></dt> |
<dd><code>array</code><br>$tags Mots-clés du cache.</dd> |
<dt><var>$duree_de_vie_specifique</var></dt> |
<dd><code>integer</code><br>$duree_de_vie_specifique Si != false, indique une durée de vie spécifique pour |
cet enregistrement en cache (null => durée de vie infinie)</dd> |
</dl></div> |
|
<h4>Returns</h4> |
<div class="list"> |
<code>boolean</code><br>True si aucun problème n'est survenu.<br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="supprimer" id="_supprimer"> |
|
<td class="attributes"><code> |
public |
boolean |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_supprimer">#</a> |
<code><a href="source-class-Cache.html#224-238" title="Go to source code">supprimer</a>( <span>string <var>$id</var></span> )</code> |
|
<div class="description short"> |
|
<p>Supprime un enregistrement en cache.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Supprime un enregistrement en cache.</p> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$id</var></dt> |
<dd><code>string</code><br>$id Identificant du cache à supprimer.</dd> |
</dl></div> |
|
<h4>Returns</h4> |
<div class="list"> |
<code>boolean</code><br>True si ok<br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="nettoyer" id="_nettoyer"> |
|
<td class="attributes"><code> |
public |
boolean |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_nettoyer">#</a> |
<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> |
|
<div class="description short"> |
|
<p>Nettoyage des enregistrements en cache</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Nettoyage des enregistrements en cache</p> |
|
<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> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$mode</var></dt> |
<dd><code>string</code><br>$mode mode de nettoyage</dd> |
<dt><var>$tags</var></dt> |
<dd><code>array|string</code><br>$tags peut être un tableau de chaîne ou une simple chaine.</dd> |
</dl></div> |
|
<h4>Returns</h4> |
<div class="list"> |
<code>boolean</code><br>True si ok<br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="getIds" id="_getIds"> |
|
<td class="attributes"><code> |
public |
array |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_getIds">#</a> |
<code><a href="source-class-Cache.html#271-280" title="Go to source code">getIds</a>( )</code> |
|
<div class="description short"> |
|
<p>Return an array of stored cache ids</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Return an array of stored cache ids</p> |
|
|
|
|
<h4>Returns</h4> |
<div class="list"> |
<code>array</code><br>array of stored cache ids (string)<br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="getTags" id="_getTags"> |
|
<td class="attributes"><code> |
public |
array |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_getTags">#</a> |
<code><a href="source-class-Cache.html#282-289" title="Go to source code">getTags</a>( )</code> |
|
<div class="description short"> |
|
<p>Return an array of stored tags</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Return an array of stored tags</p> |
|
|
|
|
<h4>Returns</h4> |
<div class="list"> |
<code>array</code><br>array of stored tags (string)<br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="getIdsAvecLesTags" id="_getIdsAvecLesTags"> |
|
<td class="attributes"><code> |
public |
array |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_getIdsAvecLesTags">#</a> |
<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> |
|
<div class="description short"> |
|
<p>Return an array of stored cache ids which match given tags</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Return an array of stored cache ids which match given tags</p> |
|
<p>In case of multiple tags, a logical AND is made between tags</p> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$tags</var></dt> |
<dd><code>array</code><br>$tags array of tags</dd> |
</dl></div> |
|
<h4>Returns</h4> |
<div class="list"> |
<code>array</code><br>array of matching cache ids (string)<br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="getIdsSansLesTags" id="_getIdsSansLesTags"> |
|
<td class="attributes"><code> |
public |
array |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_getIdsSansLesTags">#</a> |
<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> |
|
<div class="description short"> |
|
<p>Return an array of stored cache ids which don't match given tags</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Return an array of stored cache ids which don't match given tags</p> |
|
<p>In case of multiple tags, a logical OR is made between tags</p> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$tags</var></dt> |
<dd><code>array</code><br>$tags array of tags</dd> |
</dl></div> |
|
<h4>Returns</h4> |
<div class="list"> |
<code>array</code><br>array of not matching cache ids (string)<br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="getIdsAvecUnTag" id="_getIdsAvecUnTag"> |
|
<td class="attributes"><code> |
public |
array |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_getIdsAvecUnTag">#</a> |
<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> |
|
<div class="description short"> |
|
<p>Return an array of stored cache ids which match any given tags</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Return an array of stored cache ids which match any given tags</p> |
|
<p>In case of multiple tags, a logical OR is made between tags</p> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$tags</var></dt> |
<dd><code>array</code><br>$tags array of tags</dd> |
</dl></div> |
|
<h4>Returns</h4> |
<div class="list"> |
<code>array</code><br>array of matching any cache ids (string)<br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="getPourcentageRemplissage" id="_getPourcentageRemplissage"> |
|
<td class="attributes"><code> |
public |
integer |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_getPourcentageRemplissage">#</a> |
<code><a href="source-class-Cache.html#333-340" title="Go to source code">getPourcentageRemplissage</a>( )</code> |
|
<div class="description short"> |
|
<p>Return the filling percentage of the backend storage</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Return the filling percentage of the backend storage</p> |
|
|
|
|
<h4>Returns</h4> |
<div class="list"> |
<code>integer</code><br>integer between 0 and 100<br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="getMetadonnees" id="_getMetadonnees"> |
|
<td class="attributes"><code> |
public |
array |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_getMetadonnees">#</a> |
<code><a href="source-class-Cache.html#342-356" title="Go to source code">getMetadonnees</a>( <span>string <var>$id</var></span> )</code> |
|
<div class="description short"> |
|
<p>Return an array of metadatas for the given cache id</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Return an array of metadatas for the given cache id</p> |
|
<p>The array will include these keys :</p> |
|
<ul> |
<li>expire : the expire timestamp</li> |
|
<li>tags : a string array of tags</li> |
|
<li>mtime : timestamp of last modification time</li> |
</ul> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$id</var></dt> |
<dd><code>string</code><br>$id cache id</dd> |
</dl></div> |
|
<h4>Returns</h4> |
<div class="list"> |
<code>array</code><br>array of metadatas (false if the cache id is not found)<br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="ajouterSupplementDureeDeVie" id="_ajouterSupplementDureeDeVie"> |
|
<td class="attributes"><code> |
public |
boolean |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_ajouterSupplementDureeDeVie">#</a> |
<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> |
|
<div class="description short"> |
|
<p>Give (if possible) an extra lifetime to the given cache id</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Give (if possible) an extra lifetime to the given cache id</p> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$id</var></dt> |
<dd><code>string</code><br>$id cache id</dd> |
<dt><var>$supplement_duree_de_vie</var></dt> |
<dd><code>integer</code><br>$extraLifetime</dd> |
</dl></div> |
|
<h4>Returns</h4> |
<div class="list"> |
<code>boolean</code><br>true if ok<br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="validerIdOuTag" id="_validerIdOuTag"> |
|
<td class="attributes"><code> |
protected static |
|
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_validerIdOuTag">#</a> |
<code><a href="source-class-Cache.html#456-472" title="Go to source code">validerIdOuTag</a>( <span>string <var>$chaine</var></span> )</code> |
|
<div class="description short"> |
|
<p>Valide un identifiant de cache ou un tag (securité, nom de fichiers fiables, |
préfixes réservés...)</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Valide un identifiant de cache ou un tag (securité, nom de fichiers fiables, |
préfixes réservés...)</p> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$chaine</var></dt> |
<dd><code>string</code><br>$chaine Identificant de cache ou tag</dd> |
</dl></div> |
|
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="validerTableauDeTags" id="_validerTableauDeTags"> |
|
<td class="attributes"><code> |
protected static |
|
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_validerTableauDeTags">#</a> |
<code><a href="source-class-Cache.html#474-488" title="Go to source code">validerTableauDeTags</a>( <span>array <var>$tags</var></span> )</code> |
|
<div class="description short"> |
|
<p>Valide un tableau de tags (securité, nom de fichiers fiables, préfixes |
réservés...)</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Valide un tableau de tags (securité, nom de fichiers fiables, préfixes |
réservés...)</p> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$tags</var></dt> |
<dd><code>array</code><br>$tags tableau de tags</dd> |
</dl></div> |
|
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="getTimestampExpiration" id="_getTimestampExpiration"> |
|
<td class="attributes"><code> |
public |
integer |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_getTimestampExpiration">#</a> |
<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> |
|
<div class="description short"> |
|
<p>Calcule et retourne le timestamp d'expiration</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Calcule et retourne le timestamp d'expiration</p> |
|
|
|
|
<h4>Returns</h4> |
<div class="list"> |
<code>integer</code><br>timestamp d'expiration (unix timestamp)<br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
</table> |
|
|
|
|
|
|
|
|
<table class="summary" id="constants"> |
<caption>Constants summary</caption> |
<tr data-order="STOCKAGE_MODE_SIMPLE" id="STOCKAGE_MODE_SIMPLE"> |
|
<td class="attributes"><code>string</code></td> |
<td class="name"><code> |
<a href="source-class-Cache.html#18-19" title="Go to source code"><b>STOCKAGE_MODE_SIMPLE</b></a> |
</code></td> |
<td class="value"><code><span class="php-quote">"FichierSimple"</span></code></td> |
<td class="description"><div> |
<a href="#STOCKAGE_MODE_SIMPLE" class="anchor">#</a> |
|
<div class="description short"> |
|
<p>Socke les enregistrements du cache dans des fichiers textes de façon |
extremement simple.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Socke les enregistrements du cache dans des fichiers textes de façon |
extremement simple.</p> |
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="STOCKAGE_MODE_FICHIER" id="STOCKAGE_MODE_FICHIER"> |
|
<td class="attributes"><code>string</code></td> |
<td class="name"><code> |
<a href="source-class-Cache.html#20-21" title="Go to source code"><b>STOCKAGE_MODE_FICHIER</b></a> |
</code></td> |
<td class="value"><code><span class="php-quote">"Fichier"</span></code></td> |
<td class="description"><div> |
<a href="#STOCKAGE_MODE_FICHIER" class="anchor">#</a> |
|
<div class="description short"> |
|
<p>Socke les enregistrements du cache dans des fichiers textes.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Socke les enregistrements du cache dans des fichiers textes.</p> |
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="STOCKAGE_MODE_SQLITE" id="STOCKAGE_MODE_SQLITE"> |
|
<td class="attributes"><code>string</code></td> |
<td class="name"><code> |
<a href="source-class-Cache.html#22-23" title="Go to source code"><b>STOCKAGE_MODE_SQLITE</b></a> |
</code></td> |
<td class="value"><code><span class="php-quote">"Sqlite"</span></code></td> |
<td class="description"><div> |
<a href="#STOCKAGE_MODE_SQLITE" class="anchor">#</a> |
|
<div class="description short"> |
|
<p>Socke les enregistrements du cache dans une base de données SQLite.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Socke les enregistrements du cache dans une base de données SQLite.</p> |
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="NETTOYAGE_MODE_TOUS" id="NETTOYAGE_MODE_TOUS"> |
|
<td class="attributes"><code>string</code></td> |
<td class="name"><code> |
<a href="source-class-Cache.html#25-26" title="Go to source code"><b>NETTOYAGE_MODE_TOUS</b></a> |
</code></td> |
<td class="value"><code><span class="php-quote">"tous"</span></code></td> |
<td class="description"><div> |
<a href="#NETTOYAGE_MODE_TOUS" class="anchor">#</a> |
|
<div class="description short"> |
|
<p>'tous' (par défaut) : supprime tous les enregistrements.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>'tous' (par défaut) : supprime tous les enregistrements.</p> |
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="NETTOYAGE_MODE_EXPIRATION" id="NETTOYAGE_MODE_EXPIRATION"> |
|
<td class="attributes"><code>string</code></td> |
<td class="name"><code> |
<a href="source-class-Cache.html#27-28" title="Go to source code"><b>NETTOYAGE_MODE_EXPIRATION</b></a> |
</code></td> |
<td class="value"><code><span class="php-quote">"expiration"</span></code></td> |
<td class="description"><div> |
<a href="#NETTOYAGE_MODE_EXPIRATION" class="anchor">#</a> |
|
<div class="description short"> |
|
<p>'expiration' : supprime tous les enregistrements dont la date d'expériration |
est dépassée.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>'expiration' : supprime tous les enregistrements dont la date d'expériration |
est dépassée.</p> |
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="NETTOYAGE_MODE_AVEC_LES_TAGS" id="NETTOYAGE_MODE_AVEC_LES_TAGS"> |
|
<td class="attributes"><code>string</code></td> |
<td class="name"><code> |
<a href="source-class-Cache.html#29-30" title="Go to source code"><b>NETTOYAGE_MODE_AVEC_LES_TAGS</b></a> |
</code></td> |
<td class="value"><code><span class="php-quote">"avecLesTags"</span></code></td> |
<td class="description"><div> |
<a href="#NETTOYAGE_MODE_AVEC_LES_TAGS" class="anchor">#</a> |
|
<div class="description short"> |
|
<p>'avecLesTags' : supprime tous les enregistrements contenant tous les tags |
indiqués.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>'avecLesTags' : supprime tous les enregistrements contenant tous les tags |
indiqués.</p> |
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="NETTOYAGE_MODE_SANS_LES_TAGS" id="NETTOYAGE_MODE_SANS_LES_TAGS"> |
|
<td class="attributes"><code>string</code></td> |
<td class="name"><code> |
<a href="source-class-Cache.html#31-32" title="Go to source code"><b>NETTOYAGE_MODE_SANS_LES_TAGS</b></a> |
</code></td> |
<td class="value"><code><span class="php-quote">"sansLesTags"</span></code></td> |
<td class="description"><div> |
<a href="#NETTOYAGE_MODE_SANS_LES_TAGS" class="anchor">#</a> |
|
<div class="description short"> |
|
<p>'sansLesTags' : supprime tous les enregistrements contenant aucun des tags |
indiqués.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>'sansLesTags' : supprime tous les enregistrements contenant aucun des tags |
indiqués.</p> |
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="NETTOYAGE_MODE_AVEC_UN_TAG" id="NETTOYAGE_MODE_AVEC_UN_TAG"> |
|
<td class="attributes"><code>string</code></td> |
<td class="name"><code> |
<a href="source-class-Cache.html#33-34" title="Go to source code"><b>NETTOYAGE_MODE_AVEC_UN_TAG</b></a> |
</code></td> |
<td class="value"><code><span class="php-quote">"avecUnTag"</span></code></td> |
<td class="description"><div> |
<a href="#NETTOYAGE_MODE_AVEC_UN_TAG" class="anchor">#</a> |
|
<div class="description short"> |
|
<p>'avecUnTag' : supprime tous les enregistrements contenant au moins un des |
tags indiqués.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>'avecUnTag' : supprime tous les enregistrements contenant au moins un des |
tags indiqués.</p> |
|
|
</div> |
</div></td> |
</tr> |
</table> |
|
|
|
|
<table class="summary" id="properties"> |
<caption>Properties summary</caption> |
<tr data-order="options" id="$options"> |
<td class="attributes"><code> |
protected |
array |
</code></td> |
|
<td class="name"> |
<a href="source-class-Cache.html#43-94" title="Go to source code"><var>$options</var></a> |
</td> |
<td class="value"><code><span class="php-keyword1">array</span>( |
<span class="php-quote">'stockage_mode'</span> => self::STOCKAGE_MODE_FICHIER, |
<span class="php-quote">'stockage_chemin'</span> => <span class="php-keyword1">null</span>, |
<span class="php-quote">'controle_ecriture'</span> => <span class="php-keyword1">true</span>, |
<span class="php-quote">'mise_en_cache'</span> => <span class="php-keyword1">true</span>, |
<span class="php-quote">'cache_id_prefixe'</span> => <span class="php-keyword1">null</span>, |
<span class="php-quote">'serialisation_auto'</span> => <span class="php-keyword1">false</span>, |
<span class="php-quote">'nettoyage_auto'</span> => <span class="php-num">10</span>, |
<span class="php-quote">'duree_de_vie'</span> => <span class="php-num">3600</span>, |
)</code></td> |
<td class="description"><div> |
<a href="#$options" class="anchor">#</a> |
|
<div class="description short"> |
|
<p>Les options disponibles pour le cache :</p> |
|
<h1>> (string) stockage_mode :</h1> |
|
<p>Indique le mode de stockage du cache à utiliser parmis :</p> |
|
<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> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Les options disponibles pour le cache :</p> |
|
<h2>> (string) stockage_mode :</h2> |
|
<p>Indique le mode de stockage du cache à utiliser parmis :</p> |
|
<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> |
|
<h2>> (string) stockage_chemin :</h2> |
|
<p>Chemin vers :</p> |
|
<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> |
|
<h2>> (boolean) controle_ecriture :</h2> |
|
<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> |
|
<p>Le controle d'écriture peut détecter la corruption de fichier mais ce n'est |
pas un système de controle parfait.</p> |
|
<h2>> (boolean) mise_en_cache :</h2> |
|
<ul> |
<li>Active / Désactive la mise en cache</li> |
</ul> |
|
<p>(peut être très utile pour le débogage des scripts utilisant le cache</p> |
|
<h1>> (string) cache_id_prefixe :</h1> |
|
<ul> |
<li>préfixe pour les identifiant de cache ( = espace de nom)</li> |
</ul> |
|
<h2>> (boolean) serialisation_auto :</h2> |
|
<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> |
|
<h2>> (int) nettoyage_auto :</h2> |
|
<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) quand un nouveau fichier de cache est écrit : 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</li> |
</ul> |
|
<h2>> (int) duree_de_vie :</h2> |
|
<ul> |
<li>Durée de vie du cache (en secondes)</li> |
|
<li>Si null, le cache est valide indéfiniment.</li> |
</ul> |
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="stockage" id="$stockage"> |
<td class="attributes"><code> |
protected |
mixed |
</code></td> |
|
<td class="name"> |
<a href="source-class-Cache.html#96" title="Go to source code"><var>$stockage</var></a> |
</td> |
<td class="value"><code><span class="php-keyword1">null</span></code></td> |
<td class="description"><div> |
<a href="#$stockage" class="anchor">#</a> |
|
<div class="description short"> |
|
</div> |
|
<div class="description detailed hidden"> |
|
|
</div> |
</div></td> |
</tr> |
</table> |
|
|
|
|
|
|
</div> |
|
<div id="footer"> |
TBFramework - v0.4 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a> |
</div> |
</div> |
</div> |
</body> |
</html> |