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 CacheSimple</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 CacheSimple</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-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
                                                
                                        </div>
        <div class="info-box-body">
                        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Classe Cache permettant de mettre en cache des données de façon extremement simple.</p>
<p class="description"><p>Le cache est stocker dans des fichiers textes.  Le contrôle de la durée de vie du cache se fait avec la fonction PHP filemtime.  Si la durée de vie du cache est modifiée dans le constructeur ou le fichier de config, alors la durée de vie de l'ensemble  des fichiers de cache est modifiée en conséquence.  Les clés pour le tableau des options et les valeurs par défaut sont indiquées dans l'attribut options de la classe.</p></p>
        <ul class="tags">
                                <li><span class="field">author:</span> Aurélien PERONNET &lt;<a href="mailto:aurelien@tela-botanica.org">aurelien@tela-botanica.org</a>&gt;</li>
                                <li><span class="field">author:</span> Jean-Pascal MILCENT &lt;<a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a>&gt;</li>
                                <li><span class="field">version:</span> $Id: CacheSimple.php 299 2011-01-18 14:03:46Z jpm $</li>
                                <li><span class="field">copyright:</span> Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</li>
                                <li><span class="field">link:</span> /doc/framework/</li>
                                <li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL</a></li>
                                <li><span class="field">license:</span> <a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL</a></li>
                                <li><span class="field">license:</span> <a href="http://framework.zend.com/license/new-bsd">Licence New BSD</a></li>
                        </ul>
                <p class="notes">
                        Located in <a class="field" href="_CacheSimple.php.html">/CacheSimple.php</a> (line <span class="field"><a href="../__filesource/fsource_Framework__CacheSimple.php.html#a22">22</a></span>)
                </p>
                
                                
                <pre></pre>
        
                        </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> |
                                                                                                <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">CacheSimple</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>])
                                                                        </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>)
                                                                        </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">string</span>&nbsp;<span class="var-name">$contenu</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
                                                                        </div>
                                                                                        </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-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="oddrow">
        
        <div class="method-header">
                <span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSimple.php.html#a34">34</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">CacheSimple</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>])
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type"></span>
                                <span class="var-name">$options</span>                  </li>
                                </ul>
                
                        
        </div>
<a name="methodcharger" id="charger"><!-- --></a>
<div class="evenrow">
        
        <div class="method-header">
                <span class="method-title">charger</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSimple.php.html#a58">58</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Teste si le cache est disponible pour l'id donné et (si oui) le retourne (sinon renvoie false)</p>
        <ul class="tags">
                                <li><span class="field">return:</span> les données en cache.</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>)
                        </div>
        
                        <ul class="parameters">
                                        <li>
                                <span class="var-type">string</span>
                                <span class="var-name">$id</span><span class="var-description">: l'identifiant du Cache.</span>                 </li>
                                </ul>
                
                        
        </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__CacheSimple.php.html#a78">78</a></span>)
        </div> 
        
        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sauvegarde la chaine de données dans un fichier texte.</p>
<p class="description"><p>Note : $contenu est toujours de type &quot;string&quot;. C'est à vous de gérer la sérialisation.</p></p>
        <ul class="tags">
                                <li><span class="field">return:</span> true si aucun problème</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">string</span>&nbsp;<span class="var-name">$contenu</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">$contenu</span><span class="var-description">: les données à mettre en cache.</span>                   </li>
                                        <li>
                                <span class="var-type">string</span>
                                <span class="var-name">$id</span><span class="var-description">: l'identifiant du Cache.</span>                 </li>
                                </ul>
                
                        
        </div>
                                                
                </div>
        </div>


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