| New file |
|---|
| 0,0 → 1,1823 |
|---|
| <html> |
| <head> |
| <title>Docs For Class CacheFichier</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: CacheFichier</h1> |
| Source Location: /CacheFichier.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"></div><br /><br /> |
| |
| |
| |
| |
| |
| |
| |
| </td> |
| |
| <td valign="top"> |
| <h3><a href="#class_vars">Variables</a></h3> |
| <ul> |
| <li><a href="../Framework/CacheFichier.html#var$metadonnees">$metadonnees</a></li> |
| <li><a href="../Framework/CacheFichier.html#var$options">$options</a></li> |
| </ul> |
| </td> |
| |
| |
| <td valign="top"> |
| <h3><a href="#class_methods">Methods</a></h3> |
| <ul> |
| <li><a href="../Framework/CacheFichier.html#method__construct">__construct</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodajouterSupplementDureeDeVie">ajouterSupplementDureeDeVie</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodanalyserCache">analyserCache</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodcharger">charger</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodchargerMetadonnees">chargerMetadonnees</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodetreFichierMeta">etreFichierMeta</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodgenererCleSecu">genererCleSecu</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodgetChemin">getChemin</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodgetContenuFichier">getContenuFichier</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodgetFichierNom">getFichierNom</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodgetIds">getIds</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodgetIdsAvecLesTags">getIdsAvecLesTags</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodgetIdsAvecUnTag">getIdsAvecUnTag</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodgetIdsSansLesTags">getIdsSansLesTags</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodgetMetadonnees">getMetadonnees</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodgetMetadonneesFichier">getMetadonneesFichier</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodgetNomFichierMeta">getNomFichierMeta</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodgetPourcentageRemplissage">getPourcentageRemplissage</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodgetTags">getTags</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodlancerMkdirEtChmodRecursif">lancerMkdirEtChmodRecursif</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodnettoyer">nettoyer</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodnettoyerFichiers">nettoyerFichiers</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodnettoyerMetadonnees">nettoyerMetadonnees</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodsauver">sauver</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodsauverMetadonnees">sauverMetadonnees</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodsetContenuFichier">setContenuFichier</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodsetEmplacement">setEmplacement</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodsetMetadonnees">setMetadonnees</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodsupprimer">supprimer</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodsupprimerFichier">supprimerFichier</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodsupprimerMetadonnees">supprimerMetadonnees</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodtester">tester</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodtesterExistenceCache">testerExistenceCache</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodtransformaterIdEnNomFichier">transformaterIdEnNomFichier</a></li> |
| <li><a href="../Framework/CacheFichier.html#methodtransformerNomFichierEnId">transformerNomFichierEnId</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__CacheFichier.php.html#a2">2</a>]<br /> |
| </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$metadonnees"></a> |
| <p></p> |
| <h4>$metadonnees = <span class="value">array()</span></h4> |
| <p>[line <a href="../__filesource/fsource_Framework__CacheFichier.php.html#a69">69</a>]</p> |
| Array of metadatas (each item is an associative array)<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 /> |
| <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$options"></a> |
| <p></p> |
| <h4>$options = <span class="value">array(<br> |
| 'stockage_chemin' => null,<br> |
| 'fichier_verrou' => true,<br> |
| 'controle_lecture' => true,<br> |
| 'controle_lecture_type' => 'crc32',<br> |
| 'dossier_niveau' => 0,<br> |
| 'dossier_umask' => 0700,<br> |
| 'fichier_prefixe' => 'tbf',<br> |
| 'fichier_umask' => 0600,<br> |
| 'metadonnees_max_taille' => 100<br> |
| )</span></h4> |
| <p>[line <a href="../__filesource/fsource_Framework__CacheFichier.php.html#a52">52</a>]</p> |
| Options disponibles<br /><br /><p>====> (string) stockage_chemin : Chemin vers le dossier devant contenir l'arborescence du cache.</p><p>=====> (boolean) fichier_verrou : <ul><li>Active / Désactive le verrouillage des fichiers</li><li>Peut éviter la corruption du cache dans de mauvaises circonstances, mais cela ne fonctionne pas sur des serveur</li></ul> multithread et sur les systèmes de fichiers NFS par exemple.</p><p>=====> (boolean) controle_lecture : <ul><li>Activer / désactiver le contrôle de lecture</li><li>S'il est activé, une clé de contrôle est ajoutée dans le fichier de cache et cette clé est comparée avec celle calculée</li></ul> après la lecture.</p><p>=====> (string) controle_lecture_type : Type de contrôle de lecture (seulement si le contrôle de lecture est activé). Les valeurs disponibles sont: <ul><li>«md5» pour un contrôle md5 (le meilleur mais le plus lent)</li><li>«crc32» pour un contrôle de hachage crc32 (un peu moins sécurisé, mais plus rapide, un meilleur choix)</li><li>«adler32» pour un contrôle de hachage adler32 (excellent choix aussi, plus rapide que crc32)</li><li>«strlen» pour un test de longueur uniquement (le plus rapide)</li></ul> =====> (int) dossier_niveau : <ul><li>Permet de réglez le nombre de niveau de sous-dossier que contiendra l'arborescence des dossiers du cache.</li></ul><ol><li>signifie "pas de sous-dossier pour le cache",</li><li>signifie "un niveau de sous-dossier",</li><li>signifie "deux niveaux" ...</li></ol> Cette option peut accélérer le cache seulement lorsque vous avez plusieurs centaines de fichiers de cache. Seuls des tests spécifiques peuvent vous aider à choisir la meilleure valeur possible pour vous. <ol><li>ou 2 peut être est un bon début.</li></ol> =====> (int) dossier_umask : <ul><li>Umask pour les sous-dossiers de l'arborescence du cache.</li></ul> =====> (string) fichier_prefixe : <ul><li>préfixe pour les fichiers du cache</li><li>ATTENTION : faite vraiment attention avec cette option, car une valeur trop générique dans le dossier cache du système</li></ul> (comme /tmp) peut provoquer des catastrophes lors du nettoyage du cache.</p><p>=====> (int) fichier_umask : <ul><li>Umask pour les fichiers de cache</li></ul> =====> (int) metadonnees_max_taille : <ul><li>taille maximum pour le tableau de métadonnées du cache (ne changer pas cette valeur sauf si vous savez ce que vous faite)</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>options disponibles</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 /> |
| </div><br /> |
| |
| <hr /> |
| <a name="class_methods"></a> |
| <h3>Class Methods</h3> |
| <div class="tags"> |
| |
| <hr /> |
| <a name="method__construct"></a> |
| <h3>constructor __construct <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheFichier.php.html#a80">80</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 __construct( |
| [ |
| $options = array()], <a href="../Framework/Cache.html">Cache</a> |
| $cache)</code> |
| </td></tr></table> |
| </td></tr></table><br /> |
| |
| Constructor<br /><br /><br /><br /> |
| <h4>Tags:</h4> |
| <div class="tags"> |
| <table border="0" cellspacing="0" cellpadding="0"> |
| <tr> |
| <td><b>throws:</b> </td><td>Zend_Cache_Exception</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>$options</b> </td> |
| <td>associative array of options</td> |
| </tr> |
| <tr> |
| <td class="type"><a href="../Framework/Cache.html">Cache</a> </td> |
| <td><b>$cache</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__CacheFichier.php.html#a366">366</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="methodanalyserCache"></a> |
| <h3>method analyserCache <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheFichier.php.html#a628">628</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 analyserCache( |
| |
| $dossier, |
| $mode, [ |
| $tags = 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>protected</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>$dossier</b> </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> </td> |
| <td><b>$mode</b> </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> </td> |
| <td><b>$tags</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__CacheFichier.php.html#a141">141</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>string|false charger( |
| string |
| $id, [ |
| $ne_pas_tester_validiter_du_cache = false], boolean |
| $doNotTestCacheValidity)</code> |
| </td></tr></table> |
| </td></tr></table><br /> |
| |
| Test if a cache is available for the given id and (if yes) return it (false else)<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>cache id</td> |
| </tr> |
| <tr> |
| <td class="type">boolean </td> |
| <td><b>$doNotTestCacheValidity</b> </td> |
| <td>if set to true, the cache validity won't be tested</td> |
| </tr> |
| <tr> |
| <td class="type"> </td> |
| <td><b>$ne_pas_tester_validiter_du_cache</b> </td> |
| <td></td> |
| </tr> |
| </table> |
| </div><br /> |
| <div class="top">[ <a href="#top">Top</a> ]</div> |
| </div> |
| <hr /> |
| <a name="methodchargerMetadonnees"></a> |
| <h3>method chargerMetadonnees <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheFichier.php.html#a455">455</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|false chargerMetadonnees( |
| string |
| $id)</code> |
| </td></tr></table> |
| </td></tr></table><br /> |
| |
| Load metadatas from disk<br /><br /><br /><br /> |
| <h4>Tags:</h4> |
| <div class="tags"> |
| <table border="0" cellspacing="0" cellpadding="0"> |
| <tr> |
| <td><b>return:</b> </td><td>Metadatas associative array</td> |
| </tr> |
| <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>$id</b> </td> |
| <td>Cache id</td> |
| </tr> |
| </table> |
| </div><br /> |
| <div class="top">[ <a href="#top">Top</a> ]</div> |
| </div> |
| <hr /> |
| <a name="methodetreFichierMeta"></a> |
| <h3>method etreFichierMeta <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheFichier.php.html#a494">494</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 etreFichierMeta( |
| |
| $fichier_nom, string |
| $fileName)</code> |
| </td></tr></table> |
| </td></tr></table><br /> |
| |
| Check if the given filename is a metadatas one<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 it's a metadatas one</td> |
| </tr> |
| <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>$fileName</b> </td> |
| <td>File name</td> |
| </tr> |
| <tr> |
| <td class="type"> </td> |
| <td><b>$fichier_nom</b> </td> |
| <td></td> |
| </tr> |
| </table> |
| </div><br /> |
| <div class="top">[ <a href="#top">Top</a> ]</div> |
| </div> |
| <hr /> |
| <a name="methodgenererCleSecu"></a> |
| <h3>method genererCleSecu <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheFichier.php.html#a719">719</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>string genererCleSecu( |
| |
| $donnees, |
| $type_de_controle, string |
| $data, string |
| $controlType)</code> |
| </td></tr></table> |
| </td></tr></table><br /> |
| |
| Make a control key with the string containing datas<br /><br /><br /><br /> |
| <h4>Tags:</h4> |
| <div class="tags"> |
| <table border="0" cellspacing="0" cellpadding="0"> |
| <tr> |
| <td><b>return:</b> </td><td>Control key</td> |
| </tr> |
| <tr> |
| <td><b>throws:</b> </td><td>Zend_Cache_Exception</td> |
| </tr> |
| <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>$data</b> </td> |
| <td>Data</td> |
| </tr> |
| <tr> |
| <td class="type">string </td> |
| <td><b>$controlType</b> </td> |
| <td>Type of control 'md5', 'crc32' or 'strlen'</td> |
| </tr> |
| <tr> |
| <td class="type"> </td> |
| <td><b>$donnees</b> </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> </td> |
| <td><b>$type_de_controle</b> </td> |
| <td></td> |
| </tr> |
| </table> |
| </div><br /> |
| <div class="top">[ <a href="#top">Top</a> ]</div> |
| </div> |
| <hr /> |
| <a name="methodgetChemin"></a> |
| <h3>method getChemin <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheFichier.php.html#a765">765</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>string getChemin( |
| string |
| $id, [boolean |
| $decoupage = false])</code> |
| </td></tr></table> |
| </td></tr></table><br /> |
| |
| Return the complete directory path of a filename (including hashedDirectoryStructure)<br /><br /><br /><br /> |
| <h4>Tags:</h4> |
| <div class="tags"> |
| <table border="0" cellspacing="0" cellpadding="0"> |
| <tr> |
| <td><b>return:</b> </td><td>Complete directory path</td> |
| </tr> |
| <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>$id</b> </td> |
| <td>Cache id</td> |
| </tr> |
| <tr> |
| <td class="type">boolean </td> |
| <td><b>$decoupage</b> </td> |
| <td>if true, returns array of directory parts instead of single string</td> |
| </tr> |
| </table> |
| </div><br /> |
| <div class="top">[ <a href="#top">Top</a> ]</div> |
| </div> |
| <hr /> |
| <a name="methodgetContenuFichier"></a> |
| <h3>method getContenuFichier <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheFichier.php.html#a822">822</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>string getContenuFichier( |
| |
| $fichier, string |
| $file)</code> |
| </td></tr></table> |
| </td></tr></table><br /> |
| |
| Return the file content of the given file<br /><br /><br /><br /> |
| <h4>Tags:</h4> |
| <div class="tags"> |
| <table border="0" cellspacing="0" cellpadding="0"> |
| <tr> |
| <td><b>return:</b> </td><td>File content (or false if problem)</td> |
| </tr> |
| <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>$file</b> </td> |
| <td>File complete path</td> |
| </tr> |
| <tr> |
| <td class="type"> </td> |
| <td><b>$fichier</b> </td> |
| <td></td> |
| </tr> |
| </table> |
| </div><br /> |
| <div class="top">[ <a href="#top">Top</a> ]</div> |
| </div> |
| <hr /> |
| <a name="methodgetFichierNom"></a> |
| <h3>method getFichierNom <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheFichier.php.html#a752">752</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>string getFichierNom( |
| string |
| $id)</code> |
| </td></tr></table> |
| </td></tr></table><br /> |
| |
| Make and return a file name (with path)<br /><br /><br /><br /> |
| <h4>Tags:</h4> |
| <div class="tags"> |
| <table border="0" cellspacing="0" cellpadding="0"> |
| <tr> |
| <td><b>return:</b> </td><td>File name (with path)</td> |
| </tr> |
| <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>$id</b> </td> |
| <td>Cache id</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__CacheFichier.php.html#a264">264</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__CacheFichier.php.html#a285">285</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__CacheFichier.php.html#a309">309</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 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 any 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="methodgetIdsSansLesTags"></a> |
| <h3>method getIdsSansLesTags <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheFichier.php.html#a297">297</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__CacheFichier.php.html#a343">343</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 must 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="methodgetMetadonneesFichier"></a> |
| <h3>method getMetadonneesFichier <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheFichier.php.html#a390">390</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|false getMetadonneesFichier( |
| string |
| $id)</code> |
| </td></tr></table> |
| </td></tr></table><br /> |
| |
| Get a metadatas record<br /><br /><br /><br /> |
| <h4>Tags:</h4> |
| <div class="tags"> |
| <table border="0" cellspacing="0" cellpadding="0"> |
| <tr> |
| <td><b>return:</b> </td><td>Associative array of metadatas</td> |
| </tr> |
| <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>$id</b> </td> |
| <td>Cache id</td> |
| </tr> |
| </table> |
| </div><br /> |
| <div class="top">[ <a href="#top">Top</a> ]</div> |
| </div> |
| <hr /> |
| <a name="methodgetNomFichierMeta"></a> |
| <h3>method getNomFichierMeta <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheFichier.php.html#a482">482</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>string getNomFichierMeta( |
| string |
| $id)</code> |
| </td></tr></table> |
| </td></tr></table><br /> |
| |
| Make and return a file name (with path) for metadatas<br /><br /><br /><br /> |
| <h4>Tags:</h4> |
| <div class="tags"> |
| <table border="0" cellspacing="0" cellpadding="0"> |
| <tr> |
| <td><b>return:</b> </td><td>Metadatas file name (with path)</td> |
| </tr> |
| <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>$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__CacheFichier.php.html#a319">319</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>throws:</b> </td><td>Zend_Cache_Exception</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__CacheFichier.php.html#a273">273</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="methodlancerMkdirEtChmodRecursif"></a> |
| <h3>method lancerMkdirEtChmodRecursif <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheFichier.php.html#a785">785</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 lancerMkdirEtChmodRecursif( |
| string |
| $id)</code> |
| </td></tr></table> |
| </td></tr></table><br /> |
| |
| Make the directory strucuture 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>true</td> |
| </tr> |
| <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>$id</b> </td> |
| <td>cache id</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__CacheFichier.php.html#a253">253</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 = Cache::NETTOYAGE_MODE_TOUS], [tags |
| $tags = array()])</code> |
| </td></tr></table> |
| </td></tr></table><br /> |
| |
| Clean some cache records<br /><br /><p>Available modes are : 'all' (default) => remove all cache entries ($tags is not used) 'old' => remove too old cache entries ($tags is not used) 'matchingTag' => remove cache entries matching all given tags ($tags can be an array of strings or a single string) 'notMatchingTag' => remove cache entries not matching one of the given tags ($tags can be an array of strings or a single string) 'matchingAnyTag' => remove cache entries matching any given tags ($tags can be an array of strings or a single string)</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 if no problem</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>clean mode</td> |
| </tr> |
| <tr> |
| <td class="type">tags </td> |
| <td><b>$tags</b> </td> |
| <td>array $tags array of tags</td> |
| </tr> |
| </table> |
| </div><br /> |
| <div class="top">[ <a href="#top">Top</a> ]</div> |
| </div> |
| <hr /> |
| <a name="methodnettoyerFichiers"></a> |
| <h3>method nettoyerFichiers <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheFichier.php.html#a537">537</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 nettoyerFichiers( |
| |
| $dossier, [string |
| $mode = Cache::NETTOYAGE_MODE_TOUS], [array |
| $tags = array()], string |
| $dir)</code> |
| </td></tr></table> |
| </td></tr></table><br /> |
| |
| Clean some cache records (protected method used for recursive stuff)<br /><br /><p>Available modes are : Zend_Cache::CLEANING_MODE_ALL (default) => remove all cache entries ($tags is not used) Zend_Cache::CLEANING_MODE_OLD => remove too old cache entries ($tags is not used) Zend_Cache::CLEANING_MODE_MATCHING_TAG => remove cache entries matching all given tags ($tags can be an array of strings or a single string) Zend_Cache::CLEANING_MODE_NOT_MATCHING_TAG => remove cache entries not {matching one of the given tags} ($tags can be an array of strings or a single string) Zend_Cache::CLEANING_MODE_MATCHING_ANY_TAG => remove cache entries matching any given tags ($tags can be an array of strings or a single string)</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 if no problem</td> |
| </tr> |
| <tr> |
| <td><b>throws:</b> </td><td>Zend_Cache_Exception</td> |
| </tr> |
| <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>$dir</b> </td> |
| <td>Directory to clean</td> |
| </tr> |
| <tr> |
| <td class="type">string </td> |
| <td><b>$mode</b> </td> |
| <td>Clean mode</td> |
| </tr> |
| <tr> |
| <td class="type">array </td> |
| <td><b>$tags</b> </td> |
| <td>Array of tags</td> |
| </tr> |
| <tr> |
| <td class="type"> </td> |
| <td><b>$dossier</b> </td> |
| <td></td> |
| </tr> |
| </table> |
| </div><br /> |
| <div class="top">[ <a href="#top">Top</a> ]</div> |
| </div> |
| <hr /> |
| <a name="methodnettoyerMetadonnees"></a> |
| <h3>method nettoyerMetadonnees <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheFichier.php.html#a445">445</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 nettoyerMetadonnees( |
| )</code> |
| </td></tr></table> |
| </td></tr></table><br /> |
| |
| Clear the metadatas array<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 /> |
| |
| |
| <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__CacheFichier.php.html#a184">184</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( |
| |
| $donnees, string |
| $id, [array |
| $tags = array()], [ |
| $duree_vie_specifique = false], string |
| $data, int |
| $specificLifetime)</code> |
| </td></tr></table> |
| </td></tr></table><br /> |
| |
| Save some string datas into a cache record<br /><br /><p>Note : $data is always "string" (serialization is done by the core not by the backend)</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 if no problem</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>$data</b> </td> |
| <td>Datas to cache</td> |
| </tr> |
| <tr> |
| <td class="type">string </td> |
| <td><b>$id</b> </td> |
| <td>Cache id</td> |
| </tr> |
| <tr> |
| <td class="type">array </td> |
| <td><b>$tags</b> </td> |
| <td>Array of strings, the cache record will be tagged by each string entry</td> |
| </tr> |
| <tr> |
| <td class="type">int </td> |
| <td><b>$specificLifetime</b> </td> |
| <td>If != false, set a specific lifetime for this cache record (null => infinite lifetime)</td> |
| </tr> |
| <tr> |
| <td class="type"> </td> |
| <td><b>$donnees</b> </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> </td> |
| <td><b>$duree_vie_specifique</b> </td> |
| <td></td> |
| </tr> |
| </table> |
| </div><br /> |
| <div class="top">[ <a href="#top">Top</a> ]</div> |
| </div> |
| <hr /> |
| <a name="methodsauverMetadonnees"></a> |
| <h3>method sauverMetadonnees <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheFichier.php.html#a470">470</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 sauverMetadonnees( |
| string |
| $id, |
| $metadonnees, array |
| $metadatas)</code> |
| </td></tr></table> |
| </td></tr></table><br /> |
| |
| Save metadatas to disk<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 no problem</td> |
| </tr> |
| <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>$id</b> </td> |
| <td>Cache id</td> |
| </tr> |
| <tr> |
| <td class="type">array </td> |
| <td><b>$metadatas</b> </td> |
| <td>Associative array</td> |
| </tr> |
| <tr> |
| <td class="type"> </td> |
| <td><b>$metadonnees</b> </td> |
| <td></td> |
| </tr> |
| </table> |
| </div><br /> |
| <div class="top">[ <a href="#top">Top</a> ]</div> |
| </div> |
| <hr /> |
| <a name="methodsetContenuFichier"></a> |
| <h3>method setContenuFichier <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheFichier.php.html#a843">843</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 setContenuFichier( |
| |
| $fichier, |
| $chaine, string |
| $file, string |
| $string)</code> |
| </td></tr></table> |
| </td></tr></table><br /> |
| |
| Put the given string into the given file<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 no problem</td> |
| </tr> |
| <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>$file</b> </td> |
| <td>File complete path</td> |
| </tr> |
| <tr> |
| <td class="type">string </td> |
| <td><b>$string</b> </td> |
| <td>String to put in file</td> |
| </tr> |
| <tr> |
| <td class="type"> </td> |
| <td><b>$fichier</b> </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> </td> |
| <td><b>$chaine</b> </td> |
| <td></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__CacheFichier.php.html#a123">123</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( |
| |
| $emplacement)</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>$emplacement</b> </td> |
| <td></td> |
| </tr> |
| </table> |
| </div><br /> |
| <div class="top">[ <a href="#top">Top</a> ]</div> |
| </div> |
| <hr /> |
| <a name="methodsetMetadonnees"></a> |
| <h3>method setMetadonnees <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheFichier.php.html#a410">410</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 setMetadonnees( |
| string |
| $id, |
| $metadonnees, [ |
| $sauvegarde = true], array |
| $metadatas, boolean |
| $save)</code> |
| </td></tr></table> |
| </td></tr></table><br /> |
| |
| Set a metadatas record<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 no problem</td> |
| </tr> |
| <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>$id</b> </td> |
| <td>Cache id</td> |
| </tr> |
| <tr> |
| <td class="type">array </td> |
| <td><b>$metadatas</b> </td> |
| <td>Associative array of metadatas</td> |
| </tr> |
| <tr> |
| <td class="type">boolean </td> |
| <td><b>$save</b> </td> |
| <td>optional pass false to disable saving to file</td> |
| </tr> |
| <tr> |
| <td class="type"> </td> |
| <td><b>$metadonnees</b> </td> |
| <td></td> |
| </tr> |
| <tr> |
| <td class="type"> </td> |
| <td><b>$sauvegarde</b> </td> |
| <td></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__CacheFichier.php.html#a229">229</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 /> |
| |
| Remove a cache record<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 no problem</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="methodsupprimerFichier"></a> |
| <h3>method supprimerFichier <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheFichier.php.html#a508">508</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 supprimerFichier( |
| |
| $fichier, string |
| $file)</code> |
| </td></tr></table> |
| </td></tr></table><br /> |
| |
| Remove a file<br /><br /><p>If we can't remove the file (because of locks or any problem), we will touch the file to invalidate it</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 if ok</td> |
| </tr> |
| <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>$file</b> </td> |
| <td>Complete file path</td> |
| </tr> |
| <tr> |
| <td class="type"> </td> |
| <td><b>$fichier</b> </td> |
| <td></td> |
| </tr> |
| </table> |
| </div><br /> |
| <div class="top">[ <a href="#top">Top</a> ]</div> |
| </div> |
| <hr /> |
| <a name="methodsupprimerMetadonnees"></a> |
| <h3>method supprimerMetadonnees <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheFichier.php.html#a432">432</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 supprimerMetadonnees( |
| string |
| $id)</code> |
| </td></tr></table> |
| </td></tr></table><br /> |
| |
| Drop a metadata record<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 no problem</td> |
| </tr> |
| <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>$id</b> </td> |
| <td>Cache id</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__CacheFichier.php.html#a167">167</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 tester( |
| string |
| $id)</code> |
| </td></tr></table> |
| </td></tr></table><br /> |
| |
| Teste si un enregistrement en cache est disponible ou pas (pour l'id passé 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>false (le cache n'est pas disponible) ou timestamp (int) "de dernière modification" de l'enregistrement en cache</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> |
| </table> |
| </div><br /> |
| <div class="top">[ <a href="#top">Top</a> ]</div> |
| </div> |
| <hr /> |
| <a name="methodtesterExistenceCache"></a> |
| <h3>method testerExistenceCache <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheFichier.php.html#a806">806</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|mixed testerExistenceCache( |
| string |
| $id, |
| $ne_pas_tester_validiter_du_cache, boolean |
| $doNotTestCacheValidity)</code> |
| </td></tr></table> |
| </td></tr></table><br /> |
| |
| Test if the given cache id is available (and still valid as a cache record)<br /><br /><br /><br /> |
| <h4>Tags:</h4> |
| <div class="tags"> |
| <table border="0" cellspacing="0" cellpadding="0"> |
| <tr> |
| <td><b>return:</b> </td><td>false (a cache is not available) or "last modified" timestamp (int) of the available cache record</td> |
| </tr> |
| <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>$id</b> </td> |
| <td>Cache id</td> |
| </tr> |
| <tr> |
| <td class="type">boolean </td> |
| <td><b>$doNotTestCacheValidity</b> </td> |
| <td>If set to true, the cache validity won't be tested</td> |
| </tr> |
| <tr> |
| <td class="type"> </td> |
| <td><b>$ne_pas_tester_validiter_du_cache</b> </td> |
| <td></td> |
| </tr> |
| </table> |
| </div><br /> |
| <div class="top">[ <a href="#top">Top</a> ]</div> |
| </div> |
| <hr /> |
| <a name="methodtransformaterIdEnNomFichier"></a> |
| <h3>method transformaterIdEnNomFichier <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheFichier.php.html#a740">740</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>string transformaterIdEnNomFichier( |
| string |
| $id)</code> |
| </td></tr></table> |
| </td></tr></table><br /> |
| |
| Transform a cache id into a file name and return it<br /><br /><br /><br /> |
| <h4>Tags:</h4> |
| <div class="tags"> |
| <table border="0" cellspacing="0" cellpadding="0"> |
| <tr> |
| <td><b>return:</b> </td><td>File name</td> |
| </tr> |
| <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>$id</b> </td> |
| <td>Cache id</td> |
| </tr> |
| </table> |
| </div><br /> |
| <div class="top">[ <a href="#top">Top</a> ]</div> |
| </div> |
| <hr /> |
| <a name="methodtransformerNomFichierEnId"></a> |
| <h3>method transformerNomFichierEnId <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheFichier.php.html#a866">866</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>string transformerNomFichierEnId( |
| |
| $nom_de_fichier, string |
| $fileName)</code> |
| </td></tr></table> |
| </td></tr></table><br /> |
| |
| Transform a file name into cache id and return it<br /><br /><br /><br /> |
| <h4>Tags:</h4> |
| <div class="tags"> |
| <table border="0" cellspacing="0" cellpadding="0"> |
| <tr> |
| <td><b>return:</b> </td><td>Cache id</td> |
| </tr> |
| <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>$fileName</b> </td> |
| <td>File name</td> |
| </tr> |
| <tr> |
| <td class="type"> </td> |
| <td><b>$nom_de_fichier</b> </td> |
| <td></td> |
| </tr> |
| </table> |
| </div><br /> |
| <div class="top">[ <a href="#top">Top</a> ]</div> |
| </div> |
| </div><br /> |
| |
| |
| <div class="credit"> |
| <hr /> |
| Documentation generated on Tue, 18 Jan 2011 15:31:09 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.3</a> |
| </div> |
| </td></tr></table> |
| </td> |
| </tr> |
| </table> |
| |
| </body> |
| </html> |