Subversion Repositories Applications.framework

Rev

Rev 302 | Blame | Compare with Previous | Last modification | View Log | RSS feed

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
                <head>
                        <!-- template designed by Marco Von Ballmoos  -->
                        <title>Docs For Class CacheFichier</title>
                        <meta http-equiv='Content-Type' content='text/html; charset=UTF-8'/>
                        <link rel="stylesheet" href="../media/stylesheet.css" />
                                                <script src="../media/lib/classTree.js"></script>
                                                                                                <script language="javascript" type="text/javascript">
                                var imgPlus = new Image();
                                var imgMinus = new Image();
                                imgPlus.src = "../media/images/plus.png";
                                imgMinus.src = "../media/images/minus.png";
                                
                                function showNode(Node){
                                                        switch(navigator.family){
                                                                case 'nn4':
                                                                        // Nav 4.x code fork...
                                                        var oTable = document.layers["span" + Node];
                                                        var oImg = document.layers["img" + Node];
                                                                        break;
                                                                case 'ie4':
                                                                        // IE 4/5 code fork...
                                                        var oTable = document.all["span" + Node];
                                                        var oImg = document.all["img" + Node];
                                                                        break;
                                                                case 'gecko':
                                                                        // Standards Compliant code fork...
                                                        var oTable = document.getElementById("span" + Node);
                                                        var oImg = document.getElementById("img" + Node);
                                                                        break;
                                                        }
                                        oImg.src = imgMinus.src;
                                        oTable.style.display = "block";
                                }
                                
                                function hideNode(Node){
                                                        switch(navigator.family){
                                                                case 'nn4':
                                                                        // Nav 4.x code fork...
                                                        var oTable = document.layers["span" + Node];
                                                        var oImg = document.layers["img" + Node];
                                                                        break;
                                                                case 'ie4':
                                                                        // IE 4/5 code fork...
                                                        var oTable = document.all["span" + Node];
                                                        var oImg = document.all["img" + Node];
                                                                        break;
                                                                case 'gecko':
                                                                        // Standards Compliant code fork...
                                                        var oTable = document.getElementById("span" + Node);
                                                        var oImg = document.getElementById("img" + Node);
                                                                        break;
                                                        }
                                        oImg.src = imgPlus.src;
                                        oTable.style.display = "none";
                                }
                                
                                function nodeIsVisible(Node){
                                                        switch(navigator.family){
                                                                case 'nn4':
                                                                        // Nav 4.x code fork...
                                                        var oTable = document.layers["span" + Node];
                                                                        break;
                                                                case 'ie4':
                                                                        // IE 4/5 code fork...
                                                        var oTable = document.all["span" + Node];
                                                                        break;
                                                                case 'gecko':
                                                                        // Standards Compliant code fork...
                                                        var oTable = document.getElementById("span" + Node);
                                                                        break;
                                                        }
                                        return (oTable && oTable.style.display == "block");
                                }
                                
                                function toggleNodeVisibility(Node){
                                        if (nodeIsVisible(Node)){
                                                hideNode(Node);
                                        }else{
                                                showNode(Node);
                                        }
                                }
                        </script>
                                        </head>
                <body>
                        <div class="page-body">                 
<h2 class="class-name">Class CacheFichier</h2>

<a name="sec-description"></a>
<div class="info-box">
        <div class="info-box-title">Description</div>
        <div class="nav-bar">
                                        <span class="disabled">Description</span> |
                                                                                                        <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
                                                |                                                                                       <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
                                                
                                        </div>
        <div class="info-box-body">
                        <!-- ========== Info from phpDoc block ========= -->
                <p class="notes">
                        Located in <a class="field" href="_CacheFichier.php.html">/CacheFichier.php</a> (line <span class="field"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a2">2</a></span>)
                </p>
                
                                
                <pre></pre>
        
                        </div>
</div>



        <a name="sec-var-summary"></a>
        <div class="info-box">
                <div class="info-box-title">Variable Summary</span></div>
                <div class="nav-bar">
                        <a href="#sec-description">Description</a> |
                                                <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
                                                        | 
                                                                        <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
                                                        
                                                                </div>
                <div class="info-box-body">
                        <div class="var-summary">
                                                                                                                                                                                                                                                                <div class="var-title">
                                        <span class="var-type">array</span>
                                        <a href="#$metadonnees" title="details" class="var-name">$metadonnees</a>
                                </div>
                                                                                                                                <div class="var-title">
                                        <span class="var-type">array</span>
                                        <a href="#$options" title="details" class="var-name">$options</a>
                                </div>
                                                                                        </div>
                </div>
        </div>

        <a name="sec-method-summary"></a>
        <div class="info-box">
                <div class="info-box-title">Method Summary</span></div>
                <div class="nav-bar">
                        <a href="#sec-description">Description</a> |
                                                                                                                                                <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
                                 
                                |
                                                <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
                </div>
                <div class="info-box-body">                     
                        <div class="method-summary">
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">void</span>
                                                                                <a href="#__construct" title="details" class="method-name">__construct</a>
                                                                                        ([<span class="var-type"></span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">array()</span>], <span class="var-type"><a href="../Framework/Cache.html">Cache</a></span>&nbsp;<span class="var-name">$cache</span>)
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">boolean</span>
                                                                                <a href="#ajouterSupplementDureeDeVie" title="details" class="method-name">ajouterSupplementDureeDeVie</a>
                                                                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$supplement_duree_de_vie</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$extraLifetime</span>)
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">void</span>
                                                                                <a href="#analyserCache" title="details" class="method-name">analyserCache</a>
                                                                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$dossier</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$mode</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$tags</span> = <span class="var-default">array()</span>])
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">string|false</span>
                                                                                <a href="#charger" title="details" class="method-name">charger</a>
                                                                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$ne_pas_tester_validiter_du_cache</span> = <span class="var-default">false</span>], <span class="var-type">boolean</span>&nbsp;<span class="var-name">$doNotTestCacheValidity</span>)
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">array|false</span>
                                                                                <a href="#chargerMetadonnees" title="details" class="method-name">chargerMetadonnees</a>
                                                                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">boolean</span>
                                                                                <a href="#etreFichierMeta" title="details" class="method-name">etreFichierMeta</a>
                                                                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$fichier_nom</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$fileName</span>)
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">string</span>
                                                                                <a href="#genererCleSecu" title="details" class="method-name">genererCleSecu</a>
                                                                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$donnees</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$type_de_controle</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$data</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$controlType</span>)
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">string</span>
                                                                                <a href="#getChemin" title="details" class="method-name">getChemin</a>
                                                                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$decoupage</span> = <span class="var-default">false</span>])
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">string</span>
                                                                                <a href="#getContenuFichier" title="details" class="method-name">getContenuFichier</a>
                                                                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$fichier</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>)
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">string</span>
                                                                                <a href="#getFichierNom" title="details" class="method-name">getFichierNom</a>
                                                                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">array</span>
                                                                                <a href="#getIds" title="details" class="method-name">getIds</a>
                                                                                ()
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">array</span>
                                                                                <a href="#getIdsAvecLesTags" title="details" class="method-name">getIdsAvecLesTags</a>
                                                                                        ([<span class="var-type">array</span>&nbsp;<span class="var-name">$tags</span> = <span class="var-default">array()</span>])
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">array</span>
                                                                                <a href="#getIdsAvecUnTag" title="details" class="method-name">getIdsAvecUnTag</a>
                                                                                        ([<span class="var-type">array</span>&nbsp;<span class="var-name">$tags</span> = <span class="var-default">array()</span>])
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">array</span>
                                                                                <a href="#getIdsSansLesTags" title="details" class="method-name">getIdsSansLesTags</a>
                                                                                        ([<span class="var-type">array</span>&nbsp;<span class="var-name">$tags</span> = <span class="var-default">array()</span>])
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">array</span>
                                                                                <a href="#getMetadonnees" title="details" class="method-name">getMetadonnees</a>
                                                                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">array|false</span>
                                                                                <a href="#getMetadonneesFichier" title="details" class="method-name">getMetadonneesFichier</a>
                                                                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">string</span>
                                                                                <a href="#getNomFichierMeta" title="details" class="method-name">getNomFichierMeta</a>
                                                                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">int</span>
                                                                                <a href="#getPourcentageRemplissage" title="details" class="method-name">getPourcentageRemplissage</a>
                                                                                ()
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">array</span>
                                                                                <a href="#getTags" title="details" class="method-name">getTags</a>
                                                                                ()
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">boolean</span>
                                                                                <a href="#lancerMkdirEtChmodRecursif" title="details" class="method-name">lancerMkdirEtChmodRecursif</a>
                                                                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">boolean</span>
                                                                                <a href="#nettoyer" title="details" class="method-name">nettoyer</a>
                                                                                        ([<span class="var-type">string</span>&nbsp;<span class="var-name">$mode</span> = <span class="var-default">Cache::NETTOYAGE_MODE_TOUS</span>], [<span class="var-type">tags</span>&nbsp;<span class="var-name">$tags</span> = <span class="var-default">array()</span>])
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">boolean</span>
                                                                                <a href="#nettoyerFichiers" title="details" class="method-name">nettoyerFichiers</a>
                                                                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$dossier</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$mode</span> = <span class="var-default">Cache::NETTOYAGE_MODE_TOUS</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$tags</span> = <span class="var-default">array()</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$dir</span>)
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">void</span>
                                                                                <a href="#nettoyerMetadonnees" title="details" class="method-name">nettoyerMetadonnees</a>
                                                                                ()
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">boolean</span>
                                                                                <a href="#sauver" title="details" class="method-name">sauver</a>
                                                                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$donnees</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$tags</span> = <span class="var-default">array()</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$duree_vie_specifique</span> = <span class="var-default">false</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$data</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$specificLifetime</span>)
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">boolean</span>
                                                                                <a href="#sauverMetadonnees" title="details" class="method-name">sauverMetadonnees</a>
                                                                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$metadonnees</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$metadatas</span>)
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">boolean</span>
                                                                                <a href="#setContenuFichier" title="details" class="method-name">setContenuFichier</a>
                                                                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$fichier</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$chaine</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$string</span>)
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">void</span>
                                                                                <a href="#setEmplacement" title="details" class="method-name">setEmplacement</a>
                                                                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$emplacement</span>)
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">boolean</span>
                                                                                <a href="#setMetadonnees" title="details" class="method-name">setMetadonnees</a>
                                                                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$metadonnees</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$sauvegarde</span> = <span class="var-default">true</span>], <span class="var-type">array</span>&nbsp;<span class="var-name">$metadatas</span>, <span class="var-type">boolean</span>&nbsp;<span class="var-name">$save</span>)
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">boolean</span>
                                                                                <a href="#supprimer" title="details" class="method-name">supprimer</a>
                                                                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">boolean</span>
                                                                                <a href="#supprimerFichier" title="details" class="method-name">supprimerFichier</a>
                                                                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$fichier</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>)
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">boolean</span>
                                                                                <a href="#supprimerMetadonnees" title="details" class="method-name">supprimerMetadonnees</a>
                                                                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">mixed</span>
                                                                                <a href="#tester" title="details" class="method-name">tester</a>
                                                                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">boolean|mixed</span>
                                                                                <a href="#testerExistenceCache" title="details" class="method-name">testerExistenceCache</a>
                                                                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$ne_pas_tester_validiter_du_cache</span>, <span class="var-type">boolean</span>&nbsp;<span class="var-name">$doNotTestCacheValidity</span>)
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">string</span>
                                                                                <a href="#transformaterIdEnNomFichier" title="details" class="method-name">transformaterIdEnNomFichier</a>
                                                                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
                                                                        </div>
                                                                                                                
                                <div class="method-definition">
                                                                                        <span class="method-result">string</span>
                                                                                <a href="#transformerNomFichierEnId" title="details" class="method-name">transformerNomFichierEnId</a>
                                                                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$nom_de_fichier</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$fileName</span>)
                                                                        </div>
                                                                                        </div>
                </div>
        </div>          

        <a name="sec-vars"></a>
        <div class="info-box">
                <div class="info-box-title">Variables</div>
                <div class="nav-bar">
                        <a href="#sec-description">Description</a> |
                                                                                <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
                                                
                        
                                                                                | 
                                                                        <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
                                                        
                                        </div>
                <div class="info-box-body">
                        
<a name="var$metadonnees" id="$metadonnees"><!-- --></A>
<div class="evenrow">

        <div class="var-header">
                <span class="var-title">
                        <span class="var-type">array</span>
                        <span class="var-name">$metadonnees</span>
                         = <span class="var-default">array()</span>                     (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a69">69</a></span>)
                </span>
        </div>

        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Array of metadatas (each item is an associative array)</p>
        <ul class="tags">
                                <li><span class="field">access:</span> protected</li>
                        </ul>
        
        
                
                

</div>
<a name="var$options" id="$options"><!-- --></A>
<div class="oddrow">

        <div class="var-header">
                <span class="var-title">
                        <span class="var-type">array</span>
                        <span class="var-name">$options</span>
                         = <span class="var-default">array(<br />               'stockage_chemin' =&gt; null,<br />             'fichier_verrou' =&gt; true,<br />              'controle_lecture' =&gt; true,<br />            'controle_lecture_type' =&gt; 'crc32',<br />            'dossier_niveau' =&gt; 0,<br />         'dossier_umask' =&gt; 0700,<br />               'fichier_prefixe' =&gt; 'tbf',<br />            'fichier_umask' =&gt; 0600,<br />               'metadonnees_max_taille' =&gt; 100<br />        )</span>                        (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a52">52</a></span>)
                </span>
        </div>

        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Options disponibles</p>
<p class="description"><p>====&gt; (string) stockage_chemin :  Chemin vers  le dossier devant contenir l'arborescence du cache.</p><p>=====&gt; (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>=====&gt; (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>=====&gt; (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>  =====&gt; (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 &quot;pas de sous-dossier pour le cache&quot;,</li><li>signifie &quot;un niveau de sous-dossier&quot;,</li><li>signifie &quot;deux niveaux&quot; ...</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>  =====&gt; (int) dossier_umask : <ul><li>Umask pour les sous-dossiers de l'arborescence du cache.</li></ul>  =====&gt; (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>=====&gt; (int) fichier_umask : <ul><li>Umask pour les fichiers de cache</li></ul>  =====&gt; (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></p>
        <ul class="tags">
                                <li><span class="field">var:</span> options disponibles</li>
                                <li><span class="field">access:</span> protected</li>
                        </ul>
        
        
                
                

</div>
                                                
                </div>
        </div>
        
        <a name="sec-methods"></a>
        <div class="info-box">
                <div class="info-box-title">Methods</div>
                <div class="nav-bar">
                        <a href="#sec-description">Description</a> |
                                                                                                                        <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
                                                                                                                                        <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
                                                
                </div>
                <div class="info-box-body">
                        <A NAME='method_detail'></A>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
        
        <div class="method-header">
                <span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a80">80</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor</p>
        <ul class="tags">
                                <li><span class="field">throws:</span> Zend_Cache_Exception</li>
                                <li><span class="field">access:</span> public</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">void</span>
                <span class="method-name">
                        __construct
                </span>
                                        ([<span class="var-type"></span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">array()</span>], <span class="var-type"><a href="../Framework/Cache.html">Cache</a></span>&nbsp;<span class="var-name">$cache</span>)
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type">array</span>
                                <span class="var-name">$options</span><span class="var-description">: associative array of options</span>                       </li>
                                        <li>
                                <span class="var-type"><a href="../Framework/Cache.html">Cache</a></span>
                                <span class="var-name">$cache</span>                    </li>
                                </ul>
                
                        
        </div>
<a name="methodajouterSupplementDureeDeVie" id="ajouterSupplementDureeDeVie"><!-- --></a>
<div class="oddrow">
        
        <div class="method-header">
                <span class="method-title">ajouterSupplementDureeDeVie</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a366">366</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Give (if possible) an extra lifetime to the given cache id</p>
        <ul class="tags">
                                <li><span class="field">return:</span> true if ok</li>
                                <li><span class="field">access:</span> public</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">boolean</span>
                <span class="method-name">
                        ajouterSupplementDureeDeVie
                </span>
                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$supplement_duree_de_vie</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$extraLifetime</span>)
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type">string</span>
                                <span class="var-name">$id</span><span class="var-description">: cache id</span>                        </li>
                                        <li>
                                <span class="var-type">int</span>
                                <span class="var-name">$extraLifetime</span>                    </li>
                                        <li>
                                <span class="var-type"></span>
                                <span class="var-name">$supplement_duree_de_vie</span>                  </li>
                                </ul>
                
                        
        </div>
<a name="methodanalyserCache" id="analyserCache"><!-- --></a>
<div class="evenrow">
        
        <div class="method-header">
                <span class="method-title">analyserCache</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a628">628</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        <ul class="tags">
                                <li><span class="field">access:</span> protected</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">void</span>
                <span class="method-name">
                        analyserCache
                </span>
                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$dossier</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$mode</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$tags</span> = <span class="var-default">array()</span>])
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type"></span>
                                <span class="var-name">$dossier</span>                  </li>
                                        <li>
                                <span class="var-type"></span>
                                <span class="var-name">$mode</span>                     </li>
                                        <li>
                                <span class="var-type"></span>
                                <span class="var-name">$tags</span>                     </li>
                                </ul>
                
                        
        </div>
<a name="methodcharger" id="charger"><!-- --></a>
<div class="oddrow">
        
        <div class="method-header">
                <span class="method-title">charger</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a141">141</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Test if a cache is available for the given id and (if yes) return it (false else)</p>
        <ul class="tags">
                                <li><span class="field">return:</span> cached datas</li>
                                <li><span class="field">access:</span> public</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">string|false</span>
                <span class="method-name">
                        charger
                </span>
                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$ne_pas_tester_validiter_du_cache</span> = <span class="var-default">false</span>], <span class="var-type">boolean</span>&nbsp;<span class="var-name">$doNotTestCacheValidity</span>)
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type">string</span>
                                <span class="var-name">$id</span><span class="var-description">: cache id</span>                        </li>
                                        <li>
                                <span class="var-type">boolean</span>
                                <span class="var-name">$doNotTestCacheValidity</span><span class="var-description">: if set to true, the cache validity won't be tested</span>                  </li>
                                        <li>
                                <span class="var-type"></span>
                                <span class="var-name">$ne_pas_tester_validiter_du_cache</span>                 </li>
                                </ul>
                
                        
        </div>
<a name="methodchargerMetadonnees" id="chargerMetadonnees"><!-- --></a>
<div class="evenrow">
        
        <div class="method-header">
                <span class="method-title">chargerMetadonnees</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a455">455</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Load metadatas from disk</p>
        <ul class="tags">
                                <li><span class="field">return:</span> Metadatas associative array</li>
                                <li><span class="field">access:</span> protected</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">array|false</span>
                <span class="method-name">
                        chargerMetadonnees
                </span>
                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type">string</span>
                                <span class="var-name">$id</span><span class="var-description">: Cache id</span>                        </li>
                                </ul>
                
                        
        </div>
<a name="methodetreFichierMeta" id="etreFichierMeta"><!-- --></a>
<div class="oddrow">
        
        <div class="method-header">
                <span class="method-title">etreFichierMeta</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a494">494</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Check if the given filename is a metadatas one</p>
        <ul class="tags">
                                <li><span class="field">return:</span> True if it's a metadatas one</li>
                                <li><span class="field">access:</span> protected</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">boolean</span>
                <span class="method-name">
                        etreFichierMeta
                </span>
                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$fichier_nom</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$fileName</span>)
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type">string</span>
                                <span class="var-name">$fileName</span><span class="var-description">: File name</span>                 </li>
                                        <li>
                                <span class="var-type"></span>
                                <span class="var-name">$fichier_nom</span>                      </li>
                                </ul>
                
                        
        </div>
<a name="methodgenererCleSecu" id="genererCleSecu"><!-- --></a>
<div class="evenrow">
        
        <div class="method-header">
                <span class="method-title">genererCleSecu</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a719">719</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Make a control key with the string containing datas</p>
        <ul class="tags">
                                <li><span class="field">return:</span> Control key</li>
                                <li><span class="field">throws:</span> Zend_Cache_Exception</li>
                                <li><span class="field">access:</span> protected</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">string</span>
                <span class="method-name">
                        genererCleSecu
                </span>
                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$donnees</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$type_de_controle</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$data</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$controlType</span>)
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type">string</span>
                                <span class="var-name">$data</span><span class="var-description">: Data</span>                  </li>
                                        <li>
                                <span class="var-type">string</span>
                                <span class="var-name">$controlType</span><span class="var-description">: Type of control 'md5', 'crc32' or 'strlen'</span>                     </li>
                                        <li>
                                <span class="var-type"></span>
                                <span class="var-name">$donnees</span>                  </li>
                                        <li>
                                <span class="var-type"></span>
                                <span class="var-name">$type_de_controle</span>                 </li>
                                </ul>
                
                        
        </div>
<a name="methodgetChemin" id="getChemin"><!-- --></a>
<div class="oddrow">
        
        <div class="method-header">
                <span class="method-title">getChemin</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a765">765</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the complete directory path of a filename (including hashedDirectoryStructure)</p>
        <ul class="tags">
                                <li><span class="field">return:</span> Complete directory path</li>
                                <li><span class="field">access:</span> protected</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">string</span>
                <span class="method-name">
                        getChemin
                </span>
                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$decoupage</span> = <span class="var-default">false</span>])
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type">string</span>
                                <span class="var-name">$id</span><span class="var-description">: Cache id</span>                        </li>
                                        <li>
                                <span class="var-type">boolean</span>
                                <span class="var-name">$decoupage</span><span class="var-description">: if true, returns array of directory parts instead of single string</span>                       </li>
                                </ul>
                
                        
        </div>
<a name="methodgetContenuFichier" id="getContenuFichier"><!-- --></a>
<div class="evenrow">
        
        <div class="method-header">
                <span class="method-title">getContenuFichier</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a822">822</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the file content of the given file</p>
        <ul class="tags">
                                <li><span class="field">return:</span> File content (or false if problem)</li>
                                <li><span class="field">access:</span> protected</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">string</span>
                <span class="method-name">
                        getContenuFichier
                </span>
                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$fichier</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>)
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type">string</span>
                                <span class="var-name">$file</span><span class="var-description">: File complete path</span>                    </li>
                                        <li>
                                <span class="var-type"></span>
                                <span class="var-name">$fichier</span>                  </li>
                                </ul>
                
                        
        </div>
<a name="methodgetFichierNom" id="getFichierNom"><!-- --></a>
<div class="oddrow">
        
        <div class="method-header">
                <span class="method-title">getFichierNom</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a752">752</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Make and return a file name (with path)</p>
        <ul class="tags">
                                <li><span class="field">return:</span> File name (with path)</li>
                                <li><span class="field">access:</span> protected</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">string</span>
                <span class="method-name">
                        getFichierNom
                </span>
                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type">string</span>
                                <span class="var-name">$id</span><span class="var-description">: Cache id</span>                        </li>
                                </ul>
                
                        
        </div>
<a name="methodgetIds" id="getIds"><!-- --></a>
<div class="evenrow">
        
        <div class="method-header">
                <span class="method-title">getIds</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a264">264</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return an array of stored cache ids</p>
        <ul class="tags">
                                <li><span class="field">return:</span> array of stored cache ids (string)</li>
                                <li><span class="field">access:</span> public</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">array</span>
                <span class="method-name">
                        getIds
                </span>
                                ()
                        </div>
        
                
                        
        </div>
<a name="methodgetIdsAvecLesTags" id="getIdsAvecLesTags"><!-- --></a>
<div class="oddrow">
        
        <div class="method-header">
                <span class="method-title">getIdsAvecLesTags</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a285">285</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return an array of stored cache ids which match given tags</p>
<p class="description"><p>In case of multiple tags, a logical AND is made between tags</p></p>
        <ul class="tags">
                                <li><span class="field">return:</span> array of matching cache ids (string)</li>
                                <li><span class="field">access:</span> public</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">array</span>
                <span class="method-name">
                        getIdsAvecLesTags
                </span>
                                        ([<span class="var-type">array</span>&nbsp;<span class="var-name">$tags</span> = <span class="var-default">array()</span>])
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type">array</span>
                                <span class="var-name">$tags</span><span class="var-description">: array of tags</span>                 </li>
                                </ul>
                
                        
        </div>
<a name="methodgetIdsAvecUnTag" id="getIdsAvecUnTag"><!-- --></a>
<div class="evenrow">
        
        <div class="method-header">
                <span class="method-title">getIdsAvecUnTag</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a309">309</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return an array of stored cache ids which match any given tags</p>
<p class="description"><p>In case of multiple tags, a logical AND is made between tags</p></p>
        <ul class="tags">
                                <li><span class="field">return:</span> array of any matching cache ids (string)</li>
                                <li><span class="field">access:</span> public</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">array</span>
                <span class="method-name">
                        getIdsAvecUnTag
                </span>
                                        ([<span class="var-type">array</span>&nbsp;<span class="var-name">$tags</span> = <span class="var-default">array()</span>])
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type">array</span>
                                <span class="var-name">$tags</span><span class="var-description">: array of tags</span>                 </li>
                                </ul>
                
                        
        </div>
<a name="methodgetIdsSansLesTags" id="getIdsSansLesTags"><!-- --></a>
<div class="oddrow">
        
        <div class="method-header">
                <span class="method-title">getIdsSansLesTags</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a297">297</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return an array of stored cache ids which don't match given tags</p>
<p class="description"><p>In case of multiple tags, a logical OR is made between tags</p></p>
        <ul class="tags">
                                <li><span class="field">return:</span> array of not matching cache ids (string)</li>
                                <li><span class="field">access:</span> public</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">array</span>
                <span class="method-name">
                        getIdsSansLesTags
                </span>
                                        ([<span class="var-type">array</span>&nbsp;<span class="var-name">$tags</span> = <span class="var-default">array()</span>])
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type">array</span>
                                <span class="var-name">$tags</span><span class="var-description">: array of tags</span>                 </li>
                                </ul>
                
                        
        </div>
<a name="methodgetMetadonnees" id="getMetadonnees"><!-- --></a>
<div class="evenrow">
        
        <div class="method-header">
                <span class="method-title">getMetadonnees</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a343">343</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return an array of metadatas for the given cache id</p>
<p class="description"><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></p>
        <ul class="tags">
                                <li><span class="field">return:</span> array of metadatas (false if the cache id is not found)</li>
                                <li><span class="field">access:</span> public</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">array</span>
                <span class="method-name">
                        getMetadonnees
                </span>
                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type">string</span>
                                <span class="var-name">$id</span><span class="var-description">: cache id</span>                        </li>
                                </ul>
                
                        
        </div>
<a name="methodgetMetadonneesFichier" id="getMetadonneesFichier"><!-- --></a>
<div class="oddrow">
        
        <div class="method-header">
                <span class="method-title">getMetadonneesFichier</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a390">390</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get a metadatas record</p>
        <ul class="tags">
                                <li><span class="field">return:</span> Associative array of metadatas</li>
                                <li><span class="field">access:</span> protected</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">array|false</span>
                <span class="method-name">
                        getMetadonneesFichier
                </span>
                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type">string</span>
                                <span class="var-name">$id</span><span class="var-description">: Cache id</span>                        </li>
                                </ul>
                
                        
        </div>
<a name="methodgetNomFichierMeta" id="getNomFichierMeta"><!-- --></a>
<div class="evenrow">
        
        <div class="method-header">
                <span class="method-title">getNomFichierMeta</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a482">482</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Make and return a file name (with path) for metadatas</p>
        <ul class="tags">
                                <li><span class="field">return:</span> Metadatas file name (with path)</li>
                                <li><span class="field">access:</span> protected</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">string</span>
                <span class="method-name">
                        getNomFichierMeta
                </span>
                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type">string</span>
                                <span class="var-name">$id</span><span class="var-description">: Cache id</span>                        </li>
                                </ul>
                
                        
        </div>
<a name="methodgetPourcentageRemplissage" id="getPourcentageRemplissage"><!-- --></a>
<div class="oddrow">
        
        <div class="method-header">
                <span class="method-title">getPourcentageRemplissage</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a319">319</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the filling percentage of the backend storage</p>
        <ul class="tags">
                                <li><span class="field">return:</span> integer between 0 and 100</li>
                                <li><span class="field">throws:</span> Zend_Cache_Exception</li>
                                <li><span class="field">access:</span> public</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">int</span>
                <span class="method-name">
                        getPourcentageRemplissage
                </span>
                                ()
                        </div>
        
                
                        
        </div>
<a name="methodgetTags" id="getTags"><!-- --></a>
<div class="evenrow">
        
        <div class="method-header">
                <span class="method-title">getTags</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a273">273</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return an array of stored tags</p>
        <ul class="tags">
                                <li><span class="field">return:</span> array of stored tags (string)</li>
                                <li><span class="field">access:</span> public</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">array</span>
                <span class="method-name">
                        getTags
                </span>
                                ()
                        </div>
        
                
                        
        </div>
<a name="methodlancerMkdirEtChmodRecursif" id="lancerMkdirEtChmodRecursif"><!-- --></a>
<div class="oddrow">
        
        <div class="method-header">
                <span class="method-title">lancerMkdirEtChmodRecursif</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a785">785</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Make the directory strucuture for the given id</p>
        <ul class="tags">
                                <li><span class="field">return:</span> true</li>
                                <li><span class="field">access:</span> protected</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">boolean</span>
                <span class="method-name">
                        lancerMkdirEtChmodRecursif
                </span>
                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type">string</span>
                                <span class="var-name">$id</span><span class="var-description">: cache id</span>                        </li>
                                </ul>
                
                        
        </div>
<a name="methodnettoyer" id="nettoyer"><!-- --></a>
<div class="evenrow">
        
        <div class="method-header">
                <span class="method-title">nettoyer</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a253">253</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Clean some cache records</p>
<p class="description"><p>Available modes are :  'all' (default)  =&gt; remove all cache entries ($tags is not used)  'old'                     =&gt; remove too old cache entries ($tags is not used)  'matchingTag'   =&gt; remove cache entries matching all given tags                                       ($tags can be an array of strings or a single string)  'notMatchingTag' =&gt; remove cache entries not matching one of the given tags                                   ($tags can be an array of strings or a single string)  'matchingAnyTag' =&gt; remove cache entries matching any given tags                                      ($tags can be an array of strings or a single string)</p></p>
        <ul class="tags">
                                <li><span class="field">return:</span> true if no problem</li>
                                <li><span class="field">access:</span> public</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">boolean</span>
                <span class="method-name">
                        nettoyer
                </span>
                                        ([<span class="var-type">string</span>&nbsp;<span class="var-name">$mode</span> = <span class="var-default">Cache::NETTOYAGE_MODE_TOUS</span>], [<span class="var-type">tags</span>&nbsp;<span class="var-name">$tags</span> = <span class="var-default">array()</span>])
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type">string</span>
                                <span class="var-name">$mode</span><span class="var-description">: clean mode</span>                    </li>
                                        <li>
                                <span class="var-type">tags</span>
                                <span class="var-name">$tags</span><span class="var-description">: array $tags array of tags</span>                     </li>
                                </ul>
                
                        
        </div>
<a name="methodnettoyerFichiers" id="nettoyerFichiers"><!-- --></a>
<div class="oddrow">
        
        <div class="method-header">
                <span class="method-title">nettoyerFichiers</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a537">537</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Clean some cache records (protected method used for recursive stuff)</p>
<p class="description"><p>Available modes are :  Zend_Cache::CLEANING_MODE_ALL (default)        =&gt; remove all cache entries ($tags is not used)  Zend_Cache::CLEANING_MODE_OLD                         =&gt; remove too old cache entries ($tags is not used)  Zend_Cache::CLEANING_MODE_MATCHING_TAG         =&gt; 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 =&gt; 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 =&gt; remove cache entries matching any given tags                                                                                            ($tags can be an array of strings or a single string)</p></p>
        <ul class="tags">
                                <li><span class="field">return:</span> True if no problem</li>
                                <li><span class="field">throws:</span> Zend_Cache_Exception</li>
                                <li><span class="field">access:</span> protected</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">boolean</span>
                <span class="method-name">
                        nettoyerFichiers
                </span>
                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$dossier</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$mode</span> = <span class="var-default">Cache::NETTOYAGE_MODE_TOUS</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$tags</span> = <span class="var-default">array()</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$dir</span>)
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type">string</span>
                                <span class="var-name">$dir</span><span class="var-description">: Directory to clean</span>                     </li>
                                        <li>
                                <span class="var-type">string</span>
                                <span class="var-name">$mode</span><span class="var-description">: Clean mode</span>                    </li>
                                        <li>
                                <span class="var-type">array</span>
                                <span class="var-name">$tags</span><span class="var-description">: Array of tags</span>                 </li>
                                        <li>
                                <span class="var-type"></span>
                                <span class="var-name">$dossier</span>                  </li>
                                </ul>
                
                        
        </div>
<a name="methodnettoyerMetadonnees" id="nettoyerMetadonnees"><!-- --></a>
<div class="evenrow">
        
        <div class="method-header">
                <span class="method-title">nettoyerMetadonnees</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a445">445</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Clear the metadatas array</p>
        <ul class="tags">
                                <li><span class="field">access:</span> protected</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">void</span>
                <span class="method-name">
                        nettoyerMetadonnees
                </span>
                                ()
                        </div>
        
                
                        
        </div>
<a name="methodsauver" id="sauver"><!-- --></a>
<div class="oddrow">
        
        <div class="method-header">
                <span class="method-title">sauver</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a184">184</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Save some string datas into a cache record</p>
<p class="description"><p>Note : $data is always &quot;string&quot; (serialization is done by the  core not by the backend)</p></p>
        <ul class="tags">
                                <li><span class="field">return:</span> true if no problem</li>
                                <li><span class="field">access:</span> public</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">boolean</span>
                <span class="method-name">
                        sauver
                </span>
                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$donnees</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$tags</span> = <span class="var-default">array()</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$duree_vie_specifique</span> = <span class="var-default">false</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$data</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$specificLifetime</span>)
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type">string</span>
                                <span class="var-name">$data</span><span class="var-description">: Datas to cache</span>                        </li>
                                        <li>
                                <span class="var-type">string</span>
                                <span class="var-name">$id</span><span class="var-description">: Cache id</span>                        </li>
                                        <li>
                                <span class="var-type">array</span>
                                <span class="var-name">$tags</span><span class="var-description">: Array of strings, the cache record will be tagged by each string entry</span>                        </li>
                                        <li>
                                <span class="var-type">int</span>
                                <span class="var-name">$specificLifetime</span><span class="var-description">: If != false, set a specific lifetime for this cache record (null =&gt; infinite lifetime)</span>                 </li>
                                        <li>
                                <span class="var-type"></span>
                                <span class="var-name">$donnees</span>                  </li>
                                        <li>
                                <span class="var-type"></span>
                                <span class="var-name">$duree_vie_specifique</span>                     </li>
                                </ul>
                
                        
        </div>
<a name="methodsauverMetadonnees" id="sauverMetadonnees"><!-- --></a>
<div class="evenrow">
        
        <div class="method-header">
                <span class="method-title">sauverMetadonnees</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a470">470</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Save metadatas to disk</p>
        <ul class="tags">
                                <li><span class="field">return:</span> True if no problem</li>
                                <li><span class="field">access:</span> protected</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">boolean</span>
                <span class="method-name">
                        sauverMetadonnees
                </span>
                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$metadonnees</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$metadatas</span>)
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type">string</span>
                                <span class="var-name">$id</span><span class="var-description">: Cache id</span>                        </li>
                                        <li>
                                <span class="var-type">array</span>
                                <span class="var-name">$metadatas</span><span class="var-description">: Associative array</span>                        </li>
                                        <li>
                                <span class="var-type"></span>
                                <span class="var-name">$metadonnees</span>                      </li>
                                </ul>
                
                        
        </div>
<a name="methodsetContenuFichier" id="setContenuFichier"><!-- --></a>
<div class="oddrow">
        
        <div class="method-header">
                <span class="method-title">setContenuFichier</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a843">843</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Put the given string into the given file</p>
        <ul class="tags">
                                <li><span class="field">return:</span> true if no problem</li>
                                <li><span class="field">access:</span> protected</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">boolean</span>
                <span class="method-name">
                        setContenuFichier
                </span>
                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$fichier</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$chaine</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$string</span>)
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type">string</span>
                                <span class="var-name">$file</span><span class="var-description">: File complete path</span>                    </li>
                                        <li>
                                <span class="var-type">string</span>
                                <span class="var-name">$string</span><span class="var-description">: String to put in file</span>                       </li>
                                        <li>
                                <span class="var-type"></span>
                                <span class="var-name">$fichier</span>                  </li>
                                        <li>
                                <span class="var-type"></span>
                                <span class="var-name">$chaine</span>                   </li>
                                </ul>
                
                        
        </div>
<a name="methodsetEmplacement" id="setEmplacement"><!-- --></a>
<div class="evenrow">
        
        <div class="method-header">
                <span class="method-title">setEmplacement</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a123">123</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
        <ul class="tags">
                                <li><span class="field">access:</span> public</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">void</span>
                <span class="method-name">
                        setEmplacement
                </span>
                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$emplacement</span>)
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type"></span>
                                <span class="var-name">$emplacement</span>                      </li>
                                </ul>
                
                        
        </div>
<a name="methodsetMetadonnees" id="setMetadonnees"><!-- --></a>
<div class="oddrow">
        
        <div class="method-header">
                <span class="method-title">setMetadonnees</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a410">410</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set a metadatas record</p>
        <ul class="tags">
                                <li><span class="field">return:</span> True if no problem</li>
                                <li><span class="field">access:</span> protected</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">boolean</span>
                <span class="method-name">
                        setMetadonnees
                </span>
                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$metadonnees</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$sauvegarde</span> = <span class="var-default">true</span>], <span class="var-type">array</span>&nbsp;<span class="var-name">$metadatas</span>, <span class="var-type">boolean</span>&nbsp;<span class="var-name">$save</span>)
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type">string</span>
                                <span class="var-name">$id</span><span class="var-description">: Cache id</span>                        </li>
                                        <li>
                                <span class="var-type">array</span>
                                <span class="var-name">$metadatas</span><span class="var-description">: Associative array of metadatas</span>                   </li>
                                        <li>
                                <span class="var-type">boolean</span>
                                <span class="var-name">$save</span><span class="var-description">: optional pass false to disable saving to file</span>                 </li>
                                        <li>
                                <span class="var-type"></span>
                                <span class="var-name">$metadonnees</span>                      </li>
                                        <li>
                                <span class="var-type"></span>
                                <span class="var-name">$sauvegarde</span>                       </li>
                                </ul>
                
                        
        </div>
<a name="methodsupprimer" id="supprimer"><!-- --></a>
<div class="evenrow">
        
        <div class="method-header">
                <span class="method-title">supprimer</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a229">229</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Remove a cache record</p>
        <ul class="tags">
                                <li><span class="field">return:</span> true if no problem</li>
                                <li><span class="field">access:</span> public</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">boolean</span>
                <span class="method-name">
                        supprimer
                </span>
                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type">string</span>
                                <span class="var-name">$id</span><span class="var-description">: cache id</span>                        </li>
                                </ul>
                
                        
        </div>
<a name="methodsupprimerFichier" id="supprimerFichier"><!-- --></a>
<div class="oddrow">
        
        <div class="method-header">
                <span class="method-title">supprimerFichier</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a508">508</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Remove a file</p>
<p class="description"><p>If we can't remove the file (because of locks or any problem), we will touch  the file to invalidate it</p></p>
        <ul class="tags">
                                <li><span class="field">return:</span> True if ok</li>
                                <li><span class="field">access:</span> protected</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">boolean</span>
                <span class="method-name">
                        supprimerFichier
                </span>
                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$fichier</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>)
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type">string</span>
                                <span class="var-name">$file</span><span class="var-description">: Complete file path</span>                    </li>
                                        <li>
                                <span class="var-type"></span>
                                <span class="var-name">$fichier</span>                  </li>
                                </ul>
                
                        
        </div>
<a name="methodsupprimerMetadonnees" id="supprimerMetadonnees"><!-- --></a>
<div class="evenrow">
        
        <div class="method-header">
                <span class="method-title">supprimerMetadonnees</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a432">432</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Drop a metadata record</p>
        <ul class="tags">
                                <li><span class="field">return:</span> True if no problem</li>
                                <li><span class="field">access:</span> protected</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">boolean</span>
                <span class="method-name">
                        supprimerMetadonnees
                </span>
                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type">string</span>
                                <span class="var-name">$id</span><span class="var-description">: Cache id</span>                        </li>
                                </ul>
                
                        
        </div>
<a name="methodtester" id="tester"><!-- --></a>
<div class="oddrow">
        
        <div class="method-header">
                <span class="method-title">tester</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a167">167</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Teste si un enregistrement en cache est disponible ou pas (pour l'id passé en paramètre).</p>
        <ul class="tags">
                                <li><span class="field">return:</span> false (le cache n'est pas disponible) ou timestamp (int) &quot;de dernière modification&quot; de l'enregistrement en cache</li>
                                <li><span class="field">access:</span> public</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">mixed</span>
                <span class="method-name">
                        tester
                </span>
                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type">string</span>
                                <span class="var-name">$id</span><span class="var-description">: identifiant de cache.</span>                   </li>
                                </ul>
                
                        
        </div>
<a name="methodtesterExistenceCache" id="testerExistenceCache"><!-- --></a>
<div class="evenrow">
        
        <div class="method-header">
                <span class="method-title">testerExistenceCache</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a806">806</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Test if the given cache id is available (and still valid as a cache record)</p>
        <ul class="tags">
                                <li><span class="field">return:</span> false (a cache is not available) or &quot;last modified&quot; timestamp (int) of the available cache record</li>
                                <li><span class="field">access:</span> protected</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">boolean|mixed</span>
                <span class="method-name">
                        testerExistenceCache
                </span>
                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$ne_pas_tester_validiter_du_cache</span>, <span class="var-type">boolean</span>&nbsp;<span class="var-name">$doNotTestCacheValidity</span>)
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type">string</span>
                                <span class="var-name">$id</span><span class="var-description">: Cache id</span>                        </li>
                                        <li>
                                <span class="var-type">boolean</span>
                                <span class="var-name">$doNotTestCacheValidity</span><span class="var-description">: If set to true, the cache validity won't be tested</span>                  </li>
                                        <li>
                                <span class="var-type"></span>
                                <span class="var-name">$ne_pas_tester_validiter_du_cache</span>                 </li>
                                </ul>
                
                        
        </div>
<a name="methodtransformaterIdEnNomFichier" id="transformaterIdEnNomFichier"><!-- --></a>
<div class="oddrow">
        
        <div class="method-header">
                <span class="method-title">transformaterIdEnNomFichier</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a740">740</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Transform a cache id into a file name and return it</p>
        <ul class="tags">
                                <li><span class="field">return:</span> File name</li>
                                <li><span class="field">access:</span> protected</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">string</span>
                <span class="method-name">
                        transformaterIdEnNomFichier
                </span>
                                        (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type">string</span>
                                <span class="var-name">$id</span><span class="var-description">: Cache id</span>                        </li>
                                </ul>
                
                        
        </div>
<a name="methodtransformerNomFichierEnId" id="transformerNomFichierEnId"><!-- --></a>
<div class="evenrow">
        
        <div class="method-header">
                <span class="method-title">transformerNomFichierEnId</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheFichier.php.html#a866">866</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Transform a file name into cache id and return it</p>
        <ul class="tags">
                                <li><span class="field">return:</span> Cache id</li>
                                <li><span class="field">access:</span> protected</li>
                        </ul>
        
        <div class="method-signature">
                <span class="method-result">string</span>
                <span class="method-name">
                        transformerNomFichierEnId
                </span>
                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$nom_de_fichier</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$fileName</span>)
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type">string</span>
                                <span class="var-name">$fileName</span><span class="var-description">: File name</span>                 </li>
                                        <li>
                                <span class="var-type"></span>
                                <span class="var-name">$nom_de_fichier</span>                   </li>
                                </ul>
                
                        
        </div>
                                                
                </div>
        </div>


        <p class="notes" id="credit">
                Documentation generated on Tue, 18 Jan 2011 15:30:41 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
        </p>
        </div></body>
</html>