Rev 302 | Blame | Compare with Previous | Last modification | View Log | RSS feed
<html><head><title>Docs For Class Cache</title><meta http-equiv='Content-Type' content='text/html; charset=UTF-8'/><link rel="stylesheet" type="text/css" href="../media/style.css"></head><body><table border="0" cellspacing="0" cellpadding="0" height="48" width="100%"><tr><td class="header_top">Framework</td></tr><tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr><tr><td class="header_menu">[ <a href="../classtrees_Framework.html" class="menu">class tree: Framework</a> ][ <a href="../elementindex_Framework.html" class="menu">index: Framework</a> ][ <a href="../elementindex.html" class="menu">all elements</a> ]</td></tr><tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr></table><table width="100%" border="0" cellpadding="0" cellspacing="0"><tr valign="top"><td width="200" class="menu"><div id="todolist"><p><a href="../todolist.html">Todo List</a></p></div><b>Packages:</b><br /><a href="../li_Framework.html">Framework</a><br /><a href="../li_Utilitaire.html">Utilitaire</a><br /><a href="../li_Zend_OpenId.html">Zend_OpenId</a><br /><br /><br /><b>Files:</b><br /><div class="package"><a href="../Framework/_Bdd.php.html"> Bdd.php</a><br><a href="../Framework/_Cache.php.html"> Cache.php</a><br><a href="../Framework/_CacheFichier.php.html"> CacheFichier.php</a><br><a href="../Framework/_CacheSimple.php.html"> CacheSimple.php</a><br><a href="../Framework/_CacheSqlite.php.html"> CacheSqlite.php</a><br><a href="../Framework/_Chronometre.php.html"> Chronometre.php</a><br><a href="../Framework/_Cli.php.html"> Cli.php</a><br><a href="../Framework/_Config.php.html"> Config.php</a><br><a href="../Framework/_Controleur.php.html"> Controleur.php</a><br><a href="../Framework/_Debug.php.html"> Debug.php</a><br><a href="../Framework/_utilitaires---DiffieHellmanUtil.php.html"> DiffieHellmanUtil.php</a><br><a href="../Framework/_Framework.php.html"> Framework.php</a><br><a href="../Framework/_GestionnaireException.php.html"> GestionnaireException.php</a><br><a href="../Framework/_I18n.php.html"> I18n.php</a><br><a href="../Framework/_Log.php.html"> Log.php</a><br><a href="../Framework/_OpenIdClient.php.html"> OpenIdClient.php</a><br><a href="../Framework/_Registre.php.html"> Registre.php</a><br><a href="../Framework/_RestClient.php.html"> RestClient.php</a><br><a href="../Framework/_RestServeur.php.html"> RestServeur.php</a><br><a href="../Framework/_RestService.php.html"> RestService.php</a><br><a href="../Framework/_Script.php.html"> Script.php</a><br><a href="../Framework/_SquelettePhp.php.html"> SquelettePhp.php</a><br><a href="../Framework/_Url.php.html"> Url.php</a><br></div><br /><b>Classes:</b><br /><div class="package"><a href="../Framework/Bdd.html">Bdd</a><br /><a href="../Framework/Cache.html">Cache</a><br /><a href="../Framework/CacheFichier.html">CacheFichier</a><br /><a href="../Framework/CacheSimple.html">CacheSimple</a><br /><a href="../Framework/CacheSqlite.html">CacheSqlite</a><br /><a href="../Framework/Chronometre.html">Chronometre</a><br /><a href="../Framework/Cli.html">Cli</a><br /><a href="../Framework/Config.html">Config</a><br /><a href="../Framework/Controleur.html">Controleur</a><br /><a href="../Framework/Debug.html">Debug</a><br /><a href="../Framework/DiffieHellmanUtil.html">DiffieHellmanUtil</a><br /><a href="../Framework/Framework.html">Framework</a><br /><a href="../Framework/GestionnaireException.html">GestionnaireException</a><br /><a href="../Framework/I18n.html">I18n</a><br /><a href="../Framework/Log.html">Log</a><br /><a href="../Framework/OpenIdClient.html">OpenIdClient</a><br /><a href="../Framework/Registre.html">Registre</a><br /><a href="../Framework/RestClient.html">RestClient</a><br /><a href="../Framework/RestServeur.html">RestServeur</a><br /><a href="../Framework/RestService.html">RestService</a><br /><a href="../Framework/Script.html">Script</a><br /><a href="../Framework/SquelettePhp.html">SquelettePhp</a><br /><a href="../Framework/Url.html">Url</a><br /></div></td><td><table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top"><h1>Class: Cache</h1>Source Location: /Cache.php<br /><br /><table width="100%" border="0"><tr><td valign="top"><h3><a href="#class_details">Class Overview</a></h3><pre></pre><br /><div class="description">Classe Cache permettant de mettre en cache des données.</div><br /><br /><h4>Author(s):</h4><ul><li>Jean-Pascal MILCENT <<a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a>></li></ul><h4>Version:</h4><ul><li>$Id: Cache.php 299 2011-01-18 14:03:46Z jpm $</li></ul><h4>Copyright:</h4><ul><li>Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</li></ul></td><td valign="top"><h3><a href="#class_vars">Variables</a></h3><ul><li><a href="../Framework/Cache.html#var$options">$options</a></li><li><a href="../Framework/Cache.html#var$stockage">$stockage</a></li></ul></td><td valign="top"><h3><a href="#class_consts">Constants</a></h3><ul><li><a href="../Framework/Cache.html#constNETTOYAGE_MODE_AVEC_LES_TAGS">NETTOYAGE_MODE_AVEC_LES_TAGS</a></li><li><a href="../Framework/Cache.html#constNETTOYAGE_MODE_AVEC_UN_TAG">NETTOYAGE_MODE_AVEC_UN_TAG</a></li><li><a href="../Framework/Cache.html#constNETTOYAGE_MODE_EXPIRATION">NETTOYAGE_MODE_EXPIRATION</a></li><li><a href="../Framework/Cache.html#constNETTOYAGE_MODE_SANS_LES_TAGS">NETTOYAGE_MODE_SANS_LES_TAGS</a></li><li><a href="../Framework/Cache.html#constNETTOYAGE_MODE_TOUS">NETTOYAGE_MODE_TOUS</a></li><li><a href="../Framework/Cache.html#constSTOCKAGE_MODE_FICHIER">STOCKAGE_MODE_FICHIER</a></li><li><a href="../Framework/Cache.html#constSTOCKAGE_MODE_SIMPLE">STOCKAGE_MODE_SIMPLE</a></li><li><a href="../Framework/Cache.html#constSTOCKAGE_MODE_SQLITE">STOCKAGE_MODE_SQLITE</a></li></ul></td><td valign="top"><h3><a href="#class_methods">Methods</a></h3><ul><li><a href="../Framework/Cache.html#method__construct">__construct</a></li><li><a href="../Framework/Cache.html#methodajouterSupplementDureeDeVie">ajouterSupplementDureeDeVie</a></li><li><a href="../Framework/Cache.html#methodcharger">charger</a></li><li><a href="../Framework/Cache.html#methodfabriquer">fabriquer</a></li><li><a href="../Framework/Cache.html#methodgetIds">getIds</a></li><li><a href="../Framework/Cache.html#methodgetIdsAvecLesTags">getIdsAvecLesTags</a></li><li><a href="../Framework/Cache.html#methodgetIdsAvecUnTag">getIdsAvecUnTag</a></li><li><a href="../Framework/Cache.html#methodgetIdsSansLesTags">getIdsSansLesTags</a></li><li><a href="../Framework/Cache.html#methodgetMetadonnees">getMetadonnees</a></li><li><a href="../Framework/Cache.html#methodgetPourcentageRemplissage">getPourcentageRemplissage</a></li><li><a href="../Framework/Cache.html#methodgetTags">getTags</a></li><li><a href="../Framework/Cache.html#methodgetTimestampExpiration">getTimestampExpiration</a></li><li><a href="../Framework/Cache.html#methodnettoyer">nettoyer</a></li><li><a href="../Framework/Cache.html#methodsauver">sauver</a></li><li><a href="../Framework/Cache.html#methodsetEmplacement">setEmplacement</a></li><li><a href="../Framework/Cache.html#methodsupprimer">supprimer</a></li><li><a href="../Framework/Cache.html#methodtester">tester</a></li><li><a href="../Framework/Cache.html#methodvaliderIdOuTag">validerIdOuTag</a></li><li><a href="../Framework/Cache.html#methodvaliderTableauDeTags">validerTableauDeTags</a></li></ul></td></tr></table><hr /><table width="100%" border="0"><tr></tr></table><hr /><a name="class_details"></a><h3>Class Details</h3><div class="tags">[line <a href="../__filesource/fsource_Framework__Cache.php.html#a17">17</a>]<br />Classe Cache permettant de mettre en cache des données.<br /><br /><p>Basée sur les principes de Zend_Cache (Copyright (c) 2005-2010, Zend Technologies USA, Inc. All rights reserved.)</p><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>author:</b> </td><td>Jean-Pascal MILCENT <<a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a>></td></tr><tr><td><b>version:</b> </td><td>$Id: Cache.php 299 2011-01-18 14:03:46Z jpm $</td></tr><tr><td><b>copyright:</b> </td><td>Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</td></tr><tr><td><b>link:</b> </td><td>/doc/framework/</td></tr><tr><td><b>license:</b> </td><td><a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL</a></td></tr><tr><td><b>license:</b> </td><td><a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL</a></td></tr><tr><td><b>license:</b> </td><td><a href="http://framework.zend.com/license/new-bsd">Licence New BSD</a></td></tr></table></div></div><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /><hr /><a name="class_vars"></a><h3>Class Variables</h3><div class="tags"><a name="var$options"></a><p></p><h4>$options = <span class="value">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></h4><p>[line <a href="../__filesource/fsource_Framework__Cache.php.html#a85">85</a>]</p>Les options disponibles pour le cache :<br /><br /><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)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><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>var:</b> </td><td>les options disponibles pour le cache .</td></tr><tr><td><b>access:</b> </td><td>protected</td></tr></table></div><br /><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>Type:</b> </td><td>array</td></tr></table></div><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /><a name="var$stockage"></a><p></p><h4>$stockage = <span class="value"> null</span></h4><p>[line <a href="../__filesource/fsource_Framework__Cache.php.html#a96">96</a>]</p><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>access:</b> </td><td>protected</td></tr></table></div><br /><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>Type:</b> </td><td>mixed</td></tr></table></div><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /></div><br /><hr /><a name="class_methods"></a><h3>Class Methods</h3><div class="tags"><hr /><a name="methodfabriquer"></a><h3>static method fabriquer <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Cache.php.html#a148">148</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>static void fabriquer($mode, [$options = array()])</code></td></tr></table></td></tr></table><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>access:</b> </td><td>public</td></tr></table></div><br /><br /><h4>Parameters:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td class="type"> </td><td><b>$mode</b> </td><td></td></tr><tr><td class="type"> </td><td><b>$options</b> </td><td></td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodvaliderIdOuTag"></a><h3>static method validerIdOuTag <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Cache.php.html#a462">462</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>static void validerIdOuTag(string$chaine)</code></td></tr></table></td></tr></table><br />Valide un identifiant de cache ou un tag (securité, nom de fichiers fiables, préfixes réservés...)<br /><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>access:</b> </td><td>protected</td></tr></table></div><br /><br /><h4>Parameters:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td class="type">string </td><td><b>$chaine</b> </td><td>Identificant de cache ou tag</td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodvaliderTableauDeTags"></a><h3>static method validerTableauDeTags <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Cache.php.html#a480">480</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>static void validerTableauDeTags(array$tags)</code></td></tr></table></td></tr></table><br />Valide un tableau de tags (securité, nom de fichiers fiables, préfixes réservés...)<br /><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>access:</b> </td><td>protected</td></tr></table></div><br /><br /><h4>Parameters:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td class="type">array </td><td><b>$tags</b> </td><td>tableau de tags</td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="method__construct"></a><h3>constructor __construct <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Cache.php.html#a98">98</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>Cache __construct([$options = array()], [$options_stockage = array()])</code></td></tr></table></td></tr></table><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>access:</b> </td><td>public</td></tr></table></div><br /><br /><h4>Parameters:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td class="type"> </td><td><b>$options</b> </td><td></td></tr><tr><td class="type"> </td><td><b>$options_stockage</b> </td><td></td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodajouterSupplementDureeDeVie"></a><h3>method ajouterSupplementDureeDeVie <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Cache.php.html#a365">365</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>boolean ajouterSupplementDureeDeVie(string$id,$supplement_duree_de_vie, int$extraLifetime)</code></td></tr></table></td></tr></table><br />Give (if possible) an extra lifetime to the given cache id<br /><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>return:</b> </td><td>true if ok</td></tr><tr><td><b>access:</b> </td><td>public</td></tr></table></div><br /><br /><h4>Parameters:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td class="type">string </td><td><b>$id</b> </td><td>cache id</td></tr><tr><td class="type">int </td><td><b>$extraLifetime</b> </td><td></td></tr><tr><td class="type"> </td><td><b>$supplement_duree_de_vie</b> </td><td></td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodcharger"></a><h3>method charger <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Cache.php.html#a164">164</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>mixed|false charger(string$id, [boolean$ne_pas_tester_validiter_du_cache = false])</code></td></tr></table></td></tr></table><br />Teste si un cache est disponible pour l'identifiant donné et (si oui) le retourne (false dans le cas contraire)<br /><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>return:</b> </td><td>Cached datas</td></tr><tr><td><b>access:</b> </td><td>public</td></tr></table></div><br /><br /><h4>Parameters:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td class="type">string </td><td><b>$id</b> </td><td>Identifiant de cache.</td></tr><tr><td class="type">boolean </td><td><b>$ne_pas_tester_validiter_du_cache</b> </td><td>Si mis à true, la validité du cache n'est pas testée</td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodgetIds"></a><h3>method getIds <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Cache.php.html#a276">276</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>array getIds()</code></td></tr></table></td></tr></table><br />Return an array of stored cache ids<br /><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>return:</b> </td><td>array of stored cache ids (string)</td></tr><tr><td><b>access:</b> </td><td>public</td></tr></table></div><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodgetIdsAvecLesTags"></a><h3>method getIdsAvecLesTags <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Cache.php.html#a299">299</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>array getIdsAvecLesTags([array$tags = array()])</code></td></tr></table></td></tr></table><br />Return an array of stored cache ids which match given tags<br /><br /><p>In case of multiple tags, a logical AND is made between tags</p><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>return:</b> </td><td>array of matching cache ids (string)</td></tr><tr><td><b>access:</b> </td><td>public</td></tr></table></div><br /><br /><h4>Parameters:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td class="type">array </td><td><b>$tags</b> </td><td>array of tags</td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodgetIdsAvecUnTag"></a><h3>method getIdsAvecUnTag <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Cache.php.html#a327">327</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>array getIdsAvecUnTag([array$tags = array()])</code></td></tr></table></td></tr></table><br />Return an array of stored cache ids which match any given tags<br /><br /><p>In case of multiple tags, a logical OR is made between tags</p><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>return:</b> </td><td>array of matching any cache ids (string)</td></tr><tr><td><b>access:</b> </td><td>public</td></tr></table></div><br /><br /><h4>Parameters:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td class="type">array </td><td><b>$tags</b> </td><td>array of tags</td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodgetIdsSansLesTags"></a><h3>method getIdsSansLesTags <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Cache.php.html#a313">313</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>array getIdsSansLesTags([array$tags = array()])</code></td></tr></table></td></tr></table><br />Return an array of stored cache ids which don't match given tags<br /><br /><p>In case of multiple tags, a logical OR is made between tags</p><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>return:</b> </td><td>array of not matching cache ids (string)</td></tr><tr><td><b>access:</b> </td><td>public</td></tr></table></div><br /><br /><h4>Parameters:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td class="type">array </td><td><b>$tags</b> </td><td>array of tags</td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodgetMetadonnees"></a><h3>method getMetadonnees <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Cache.php.html#a353">353</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>array getMetadonnees(string$id)</code></td></tr></table></td></tr></table><br />Return an array of metadatas for the given cache id<br /><br /><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><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>return:</b> </td><td>array of metadatas (false if the cache id is not found)</td></tr><tr><td><b>access:</b> </td><td>public</td></tr></table></div><br /><br /><h4>Parameters:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td class="type">string </td><td><b>$id</b> </td><td>cache id</td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodgetPourcentageRemplissage"></a><h3>method getPourcentageRemplissage <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Cache.php.html#a338">338</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>int getPourcentageRemplissage()</code></td></tr></table></td></tr></table><br />Return the filling percentage of the backend storage<br /><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>return:</b> </td><td>integer between 0 and 100</td></tr><tr><td><b>access:</b> </td><td>public</td></tr></table></div><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodgetTags"></a><h3>method getTags <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Cache.php.html#a287">287</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>array getTags()</code></td></tr></table></td></tr></table><br />Return an array of stored tags<br /><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>return:</b> </td><td>array of stored tags (string)</td></tr><tr><td><b>access:</b> </td><td>public</td></tr></table></div><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodgetTimestampExpiration"></a><h3>method getTimestampExpiration <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Cache.php.html#a495">495</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>int getTimestampExpiration($duree_de_vie)</code></td></tr></table></td></tr></table><br />Calcule et retourne le timestamp d'expiration<br /><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>return:</b> </td><td>timestamp d'expiration (unix timestamp)</td></tr><tr><td><b>access:</b> </td><td>public</td></tr></table></div><br /><br /><h4>Parameters:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td class="type"> </td><td><b>$duree_de_vie</b> </td><td></td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodnettoyer"></a><h3>method nettoyer <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Cache.php.html#a254">254</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>boolean nettoyer([string$mode = self::NETTOYAGE_MODE_TOUS], [array|string$tags = array()])</code></td></tr></table></td></tr></table><br />Nettoyage des enregistrements en cache<br /><br /><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><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>return:</b> </td><td>True si ok</td></tr><tr><td><b>access:</b> </td><td>public</td></tr></table></div><br /><br /><h4>Parameters:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td class="type">string </td><td><b>$mode</b> </td><td>mode de nettoyage</td></tr><tr><td class="type">array|string </td><td><b>$tags</b> </td><td>peut être un tableau de chaîne ou une simple chaine.</td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodsauver"></a><h3>method sauver <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Cache.php.html#a202">202</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>boolean sauver(mixed$donnees, [string$id = null], [array$tags = array()], [int$duree_de_vie_specifique = false])</code></td></tr></table></td></tr></table><br />Sauvegarde en cache les données passées en paramètre.<br /><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>return:</b> </td><td>True si aucun problème n'est survenu.</td></tr><tr><td><b>access:</b> </td><td>public</td></tr></table></div><br /><br /><h4>Parameters:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td class="type">mixed </td><td><b>$donnees</b> </td><td>Données à mettre en cache (peut être différent d'une chaine si serialisation_auto vaut true).</td></tr><tr><td class="type">string </td><td><b>$id</b> </td><td>Identifiant du cache (s'il n'est pas définit, le dernier identifiant sera utilisé).</td></tr><tr><td class="type">array </td><td><b>$tags</b> </td><td>Mots-clés du cache.</td></tr><tr><td class="type">int </td><td><b>$duree_de_vie_specifique</b> </td><td>Si != false, indique une durée de vie spécifique pour cet enregistrement en cache (null => durée de vie infinie)</td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodsetEmplacement"></a><h3>method setEmplacement <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Cache.php.html#a140">140</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>void setEmplacement(string$emplacement)</code></td></tr></table></td></tr></table><br />Permet de (re-)définir l'emplacement pour le stockage du cache.<br /><br /><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><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>access:</b> </td><td>public</td></tr></table></div><br /><br /><h4>Parameters:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td class="type">string </td><td><b>$emplacement</b> </td><td>chemin vers dossier (Cache::STOCKAGE_MODE_FICHIER) ou fichier base Sqlite (Cache::STOCKAGE_MODE_SQLITE)</td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodsupprimer"></a><h3>method supprimer <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Cache.php.html#a230">230</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>boolean supprimer(string$id)</code></td></tr></table></td></tr></table><br />Supprime un enregistrement en cache.<br /><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>return:</b> </td><td>True si ok</td></tr><tr><td><b>access:</b> </td><td>public</td></tr></table></div><br /><br /><h4>Parameters:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td class="type">string </td><td><b>$id</b> </td><td>Identificant du cache à supprimer.</td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodtester"></a><h3>method tester <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Cache.php.html#a182">182</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>int|false tester(string$id)</code></td></tr></table></td></tr></table><br />Test if a cache is available for the given id<br /><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>return:</b> </td><td>Last modified time of cache entry if it is available, false otherwise</td></tr><tr><td><b>access:</b> </td><td>public</td></tr></table></div><br /><br /><h4>Parameters:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td class="type">string </td><td><b>$id</b> </td><td>Cache id</td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div></div><br /><hr /><a name="class_consts"></a><h3>Class Constants</h3><div class="tags"><a name="constNETTOYAGE_MODE_AVEC_LES_TAGS"></a><p></p><h4>NETTOYAGE_MODE_AVEC_LES_TAGS = <span class="value"> "avecLesTags"</span></h4><p>[line <a href="../__filesource/fsource_Framework__Cache.php.html#a30">30</a>]</p>'avecLesTags' : supprime tous les enregistrements contenant tous les tags indiqués.<br /><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /><a name="constNETTOYAGE_MODE_AVEC_UN_TAG"></a><p></p><h4>NETTOYAGE_MODE_AVEC_UN_TAG = <span class="value"> "avecUnTag"</span></h4><p>[line <a href="../__filesource/fsource_Framework__Cache.php.html#a34">34</a>]</p>'avecUnTag' : supprime tous les enregistrements contenant au moins un des tags indiqués.<br /><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /><a name="constNETTOYAGE_MODE_EXPIRATION"></a><p></p><h4>NETTOYAGE_MODE_EXPIRATION = <span class="value"> "expiration"</span></h4><p>[line <a href="../__filesource/fsource_Framework__Cache.php.html#a28">28</a>]</p>'expiration' : supprime tous les enregistrements dont la date d'expériration est dépassée.<br /><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /><a name="constNETTOYAGE_MODE_SANS_LES_TAGS"></a><p></p><h4>NETTOYAGE_MODE_SANS_LES_TAGS = <span class="value"> "sansLesTags"</span></h4><p>[line <a href="../__filesource/fsource_Framework__Cache.php.html#a32">32</a>]</p>'sansLesTags' : supprime tous les enregistrements contenant aucun des tags indiqués.<br /><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /><a name="constNETTOYAGE_MODE_TOUS"></a><p></p><h4>NETTOYAGE_MODE_TOUS = <span class="value"> "tous"</span></h4><p>[line <a href="../__filesource/fsource_Framework__Cache.php.html#a26">26</a>]</p>'tous' (par défaut) : supprime tous les enregistrements.<br /><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /><a name="constSTOCKAGE_MODE_FICHIER"></a><p></p><h4>STOCKAGE_MODE_FICHIER = <span class="value"> "Fichier"</span></h4><p>[line <a href="../__filesource/fsource_Framework__Cache.php.html#a21">21</a>]</p>Socke les enregistrements du cache dans des fichiers textes.<br /><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /><a name="constSTOCKAGE_MODE_SIMPLE"></a><p></p><h4>STOCKAGE_MODE_SIMPLE = <span class="value"> "FichierSimple"</span></h4><p>[line <a href="../__filesource/fsource_Framework__Cache.php.html#a19">19</a>]</p>Socke les enregistrements du cache dans des fichiers textes de façon extremement simple.<br /><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /><a name="constSTOCKAGE_MODE_SQLITE"></a><p></p><h4>STOCKAGE_MODE_SQLITE = <span class="value"> "Sqlite"</span></h4><p>[line <a href="../__filesource/fsource_Framework__Cache.php.html#a23">23</a>]</p>Socke les enregistrements du cache dans une base de données SQLite.<br /><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /></div><br /><div class="credit"><hr />Documentation generated on Tue, 18 Jan 2011 15:31:07 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.3</a></div></td></tr></table></td></tr></table></body></html>