Rev 464 | Blame | Compare with Previous | Last modification | View Log | RSS feed
<!DOCTYPE html><html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="generator" content="ApiGen 2.8.0"><meta name="robots" content="noindex"><title>File CacheSimple.php</title><script type="text/javascript" src="resources/combined.js?4205936287"></script><script type="text/javascript" src="elementlist.js?4111837732"></script><link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360"></head><body><div id="left"><div id="menu"><a href="index.html" title="Overview"><span>Overview</span></a><div id="groups"><h3>Packages</h3><ul><li class="active"><a href="package-Framework.html">Framework</a></li><li><a href="package-None.html">None</a></li><li><a href="package-PHP.html">PHP</a></li><li><a href="package-Utilitaire.html">Utilitaire</a></li></ul></div><hr><div id="elements"><h3>Classes</h3><ul><li><a href="class-Bdd.html">Bdd</a></li><li><a href="class-Cache.html">Cache</a></li><li class="active"><a href="class-CacheSimple.html">CacheSimple</a></li><li><a href="class-Chronometre.html">Chronometre</a></li><li><a href="class-Cli.html">Cli</a></li><li><a href="class-Config.html">Config</a></li><li><a href="class-Controleur.html">Controleur</a></li><li><a href="class-Debug.html">Debug</a></li><li><a href="class-Framework.html">Framework</a></li><li><a href="class-GestionnaireException.html">GestionnaireException</a></li><li><a href="class-I18n.html">I18n</a></li><li><a href="class-Log.html">Log</a></li><li><a href="class-Registre.html">Registre</a></li><li><a href="class-RestClient.html">RestClient</a></li><li><a href="class-RestServeur.html">RestServeur</a></li><li><a href="class-RestService.html">RestService</a></li><li><a href="class-Script.html">Script</a></li><li><a href="class-SquelettePhp.html">SquelettePhp</a></li><li><a href="class-Url.html">Url</a></li></ul></div></div></div><div id="splitter"></div><div id="right"><div id="rightInner"><form id="search"><input type="hidden" name="cx" value=""><input type="hidden" name="ie" value="UTF-8"><input type="text" name="q" class="text"><input type="submit" value="Search"></form><div id="navigation"><ul><li><a href="index.html" title="Overview"><span>Overview</span></a></li><li><a href="package-Framework.html" title="Summary of Framework"><span>Package</span></a></li><li><a href="class-CacheSimple.html" title="Summary of CacheSimple"><span>Class</span></a></li></ul><ul><li><a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a></li><li><a href="deprecated.html" title="List of deprecated elements"><span>Deprecated</span></a></li><li><a href="todo.html" title="Todo list"><span>Todo</span></a></li></ul><ul></ul></div><pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span></span><span id="2" class="l"><a class="l" href="#2"> 2: </a><span class="php-comment">// declare(encoding='UTF-8');</span></span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-comment">/**</span></span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-comment"> * Classe Cache permettant de mettre en cache des données de façon extremement simple.</span></span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment"> * Le cache est stocker dans des fichiers textes.</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> * Le contrôle de la durée de vie du cache se fait avec la fonction PHP filemtime.</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * 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</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> * des fichiers de cache est modifiée en conséquence.</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> * Les clés pour le tableau des options et les valeurs par défaut sont indiquées dans l'attribut options de la classe.</span></span><span id="10" class="l"><a class="l" href="#10"> 10: </a><span class="php-comment"> *</span></span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment"> * @category php 5.2</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * @package Framework</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> * @author Jean-Pascal MILCENT <jpm@tela-botanica.org></span></span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-comment"> * @author Aurélien PERONNET <aurelien@tela-botanica.org></span></span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-comment"> * @copyright Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</span></span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment"> * @license http://framework.zend.com/license/new-bsd Licence New BSD</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * @license http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> * @license http://www.gnu.org/licenses/gpl.html Licence GNU-GPL</span></span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-comment"> * @version $Id: CacheSimple.php 445 2013-10-24 17:08:14Z raphael $</span></span><span id="20" class="l"><a class="l" href="#20"> 20: </a><span class="php-comment"> * @link /doc/framework/</span></span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment"> */</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment">// TODO : voir ce qui est le plus pratique : error_log ou le gestionnaire de bogue du framework</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-keyword1">class</span> <a id="CacheSimple" href="#CacheSimple">CacheSimple</a> {</span><span id="24" class="l"><a class="l" href="#24"> 24: </a></span><span id="25" class="l"><a class="l" href="#25"> 25: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$mise_en_cache" href="#$mise_en_cache">$mise_en_cache</a></span> = <span class="php-keyword1">null</span>;</span><span id="26" class="l"><a class="l" href="#26"> 26: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$stockage_chemin" href="#$stockage_chemin">$stockage_chemin</a></span> = <span class="php-keyword1">null</span>;</span><span id="27" class="l"><a class="l" href="#27"> 27: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$duree_de_vie" href="#$duree_de_vie">$duree_de_vie</a></span> = <span class="php-keyword1">null</span>;</span><span id="28" class="l"><a class="l" href="#28"> 28: </a></span><span id="29" class="l"><a class="l" href="#29"> 29: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$options" href="#$options">$options</a></span> = <span class="php-keyword1">array</span>(</span><span id="30" class="l"><a class="l" href="#30"> 30: </a> <span class="php-quote">'mise_en_cache'</span> => <span class="php-quote">'true'</span>,</span><span id="31" class="l"><a class="l" href="#31"> 31: </a> <span class="php-quote">'stockage_chemin'</span> => <span class="php-quote">'Fichier::getDossierTmp()'</span>,</span><span id="32" class="l"><a class="l" href="#32"> 32: </a> <span class="php-quote">'duree_de_vie'</span> => <span class="php-quote">'3600*24'</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a> );</span><span id="34" class="l"><a class="l" href="#34"> 34: </a></span><span id="35" class="l"><a class="l" href="#35"> 35: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___construct" href="#___construct">__construct</a>(<span class="php-var">$options</span> = <span class="php-keyword1">array</span>()) {</span><span id="36" class="l"><a class="l" href="#36"> 36: </a> <span class="php-keyword2">extract</span>(<span class="php-var">$options</span>);</span><span id="37" class="l"><a class="l" href="#37"> 37: </a> <span class="php-var">$this</span>->mise_en_cache = <span class="php-keyword2">is_bool</span>(<span class="php-var">$mise_en_cache</span>) ? <span class="php-var">$mise_en_cache</span> : <span class="php-var">$mise_en_cache</span> == <span class="php-quote">''</span> ? <span class="php-keyword1">false</span> : <span class="php-keyword1">true</span>;</span><span id="38" class="l"><a class="l" href="#38"> 38: </a></span><span id="39" class="l"><a class="l" href="#39"> 39: </a> <span class="php-keyword1">if</span> (<span class="php-var">$this</span>->mise_en_cache) {</span><span id="40" class="l"><a class="l" href="#40"> 40: </a> <span class="php-var">$this</span>->stockage_chemin = <span class="php-keyword1">isset</span>(<span class="php-var">$stockage_chemin</span>) ? <span class="php-keyword2">realpath</span>(<span class="php-var">$stockage_chemin</span>) : Fichier::getDossierTmp();</span><span id="41" class="l"><a class="l" href="#41"> 41: </a> <span class="php-keyword1">if</span> (!<span class="php-keyword2">realpath</span>(<span class="php-var">$stockage_chemin</span>)) {</span><span id="42" class="l"><a class="l" href="#42"> 42: </a> <span class="php-keyword2">error_log</span>(<span class="php-keyword2">sprintf</span>(<span class="php-quote">"%s: Attention, %s invalide: creation [%s]"</span>,</span><span id="43" class="l"><a class="l" href="#43"> 43: </a> __FILE__,</span><span id="44" class="l"><a class="l" href="#44"> 44: </a> <span class="php-var">$stockage_chemin</span>,</span><span id="45" class="l"><a class="l" href="#45"> 45: </a> @<span class="php-var">$_SERVER</span>[<span class="php-quote">'REQUEST_URI'</span>]));</span><span id="46" class="l"><a class="l" href="#46"> 46: </a> <span class="php-keyword2">mkdir</span>(<span class="php-var">$stockage_chemin</span>, <span class="php-num">0755</span>, <span class="php-keyword1">TRUE</span>);</span><span id="47" class="l"><a class="l" href="#47"> 47: </a> }</span><span id="48" class="l"><a class="l" href="#48"> 48: </a> <span class="php-keyword1">if</span> (!<span class="php-keyword2">realpath</span>(<span class="php-var">$stockage_chemin</span>)) {</span><span id="49" class="l"><a class="l" href="#49"> 49: </a> <span class="php-keyword2">error_log</span>(<span class="php-keyword2">sprintf</span>(<span class="php-quote">"%s: Attention, realpath(%s) invalide [%s]"</span>,</span><span id="50" class="l"><a class="l" href="#50"> 50: </a> __FILE__,</span><span id="51" class="l"><a class="l" href="#51"> 51: </a> <span class="php-var">$stockage_chemin</span>,</span><span id="52" class="l"><a class="l" href="#52"> 52: </a> @<span class="php-var">$_SERVER</span>[<span class="php-quote">'REQUEST_URI'</span>]));</span><span id="53" class="l"><a class="l" href="#53"> 53: </a> } <span class="php-keyword1">else</span> <span class="php-keyword1">if</span>(!<span class="php-keyword2">is_writable</span>(<span class="php-keyword2">realpath</span>(<span class="php-var">$stockage_chemin</span>))) {</span><span id="54" class="l"><a class="l" href="#54"> 54: </a> <span class="php-keyword2">error_log</span>(<span class="php-keyword2">sprintf</span>(<span class="php-quote">"%s: Attention, realpath(%s) non-inscriptible [%s]"</span>,</span><span id="55" class="l"><a class="l" href="#55"> 55: </a> __FILE__,</span><span id="56" class="l"><a class="l" href="#56"> 56: </a> <span class="php-keyword2">realpath</span>(<span class="php-var">$stockage_chemin</span>),</span><span id="57" class="l"><a class="l" href="#57"> 57: </a> @<span class="php-var">$_SERVER</span>[<span class="php-quote">'REQUEST_URI'</span>]));</span><span id="58" class="l"><a class="l" href="#58"> 58: </a> } <span class="php-keyword1">else</span> {</span><span id="59" class="l"><a class="l" href="#59"> 59: </a> <span class="php-var">$this</span>->duree_de_vie = <span class="php-keyword1">isset</span>(<span class="php-var">$duree_de_vie</span>) ? <span class="php-var">$duree_de_vie</span> : <span class="php-num">3600</span>*<span class="php-num">24</span>;</span><span id="60" class="l"><a class="l" href="#60"> 60: </a> }</span><span id="61" class="l"><a class="l" href="#61"> 61: </a> }</span><span id="62" class="l"><a class="l" href="#62"> 62: </a> }</span><span id="63" class="l"><a class="l" href="#63"> 63: </a></span><span id="64" class="l"><a class="l" href="#64"> 64: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">function</span> <a id="_initialiserOptionsParConfig" href="#_initialiserOptionsParConfig">initialiserOptionsParConfig</a>() {</span><span id="65" class="l"><a class="l" href="#65"> 65: </a> <span class="php-keyword1">while</span> (<span class="php-keyword1">list</span>(<span class="php-var">$nom</span>, <span class="php-var">$valeur</span>) = <span class="php-keyword2">each</span>(<span class="php-var">$this</span>->options)) {</span><span id="66" class="l"><a class="l" href="#66"> 66: </a> <span class="php-keyword1">if</span> (Config::existe(<span class="php-var">$nom</span>)) {</span><span id="67" class="l"><a class="l" href="#67"> 67: </a> <span class="php-var">$this</span>-><span class="php-var">$nom</span> = Config::get(<span class="php-var">$nom</span>);</span><span id="68" class="l"><a class="l" href="#68"> 68: </a> }</span><span id="69" class="l"><a class="l" href="#69"> 69: </a> }</span><span id="70" class="l"><a class="l" href="#70"> 70: </a> }</span><span id="71" class="l"><a class="l" href="#71"> 71: </a></span><span id="72" class="l"><a class="l" href="#72"> 72: </a> <span class="php-comment">/**</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> * Teste si le cache est disponible pour l'id donné et (si oui) le retourne (sinon renvoie false)</span></span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-comment"> *</span></span><span id="75" class="l"><a class="l" href="#75"> 75: </a><span class="php-comment"> * @param string $id l'identifiant du Cache.</span></span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment"> * @return string|false les données en cache.</span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment"> */</span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_charger" href="#_charger">charger</a>(<span class="php-var">$id</span>) {</span><span id="79" class="l"><a class="l" href="#79"> 79: </a> <span class="php-var">$contenu</span> = <span class="php-keyword1">false</span>;</span><span id="80" class="l"><a class="l" href="#80"> 80: </a> <span class="php-keyword1">if</span> (<span class="php-var">$this</span>->mise_en_cache) {</span><span id="81" class="l"><a class="l" href="#81"> 81: </a> <span class="php-var">$chemin_fichier_cache</span> = <span class="php-var">$this</span>->stockage_chemin.DS.<span class="php-var">$id</span>.<span class="php-quote">'.txt'</span>;</span><span id="82" class="l"><a class="l" href="#82"> 82: </a> <span class="php-keyword1">if</span> (<span class="php-keyword2">file_exists</span>(<span class="php-var">$chemin_fichier_cache</span> ) && (<span class="php-keyword2">time</span>() - @<span class="php-keyword2">filemtime</span>(<span class="php-var">$chemin_fichier_cache</span>) < <span class="php-var">$this</span>->duree_de_vie)) {</span><span id="83" class="l"><a class="l" href="#83"> 83: </a> <span class="php-var">$contenu</span> = <span class="php-keyword2">file_get_contents</span>(<span class="php-var">$chemin_fichier_cache</span>);</span><span id="84" class="l"><a class="l" href="#84"> 84: </a> }</span><span id="85" class="l"><a class="l" href="#85"> 85: </a> }</span><span id="86" class="l"><a class="l" href="#86"> 86: </a> <span class="php-keyword1">return</span> <span class="php-var">$contenu</span>;</span><span id="87" class="l"><a class="l" href="#87"> 87: </a> }</span><span id="88" class="l"><a class="l" href="#88"> 88: </a></span><span id="89" class="l"><a class="l" href="#89"> 89: </a> <span class="php-comment">/**</span></span><span id="90" class="l"><a class="l" href="#90"> 90: </a><span class="php-comment"> * Sauvegarde la chaine de données dans un fichier texte.</span></span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment"> *</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * Note : $contenu est toujours de type "string". C'est à vous de gérer la sérialisation.</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> *</span></span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-comment"> * @param string $contenu les données à mettre en cache.</span></span><span id="95" class="l"><a class="l" href="#95"> 95: </a><span class="php-comment"> * @param string $id l'identifiant du Cache.</span></span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment"> * @return boolean true si aucun problème</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> */</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_sauver" href="#_sauver">sauver</a>(<span class="php-var">$contenu</span>, <span class="php-var">$id</span>) {</span><span id="99" class="l"><a class="l" href="#99"> 99: </a> <span class="php-keyword1">if</span> (! <span class="php-var">$this</span>->mise_en_cache) <span class="php-keyword1">return</span> <span class="php-keyword1">FALSE</span>;</span><span id="100" class="l"><a class="l" href="#100">100: </a></span><span id="101" class="l"><a class="l" href="#101">101: </a> <span class="php-var">$ok</span> = <span class="php-keyword1">false</span>;</span><span id="102" class="l"><a class="l" href="#102">102: </a> <span class="php-var">$chemin_fichier_cache</span> = <span class="php-var">$this</span>->stockage_chemin.DS.<span class="php-var">$id</span>.<span class="php-quote">'.txt'</span>;</span><span id="103" class="l"><a class="l" href="#103">103: </a> <span class="php-keyword1">if</span> (!<span class="php-keyword2">file_exists</span>(<span class="php-var">$chemin_fichier_cache</span>) || (<span class="php-keyword2">time</span>() - @<span class="php-keyword2">filemtime</span>(<span class="php-var">$chemin_fichier_cache</span>) > <span class="php-var">$this</span>->duree_de_vie)) {</span><span id="104" class="l"><a class="l" href="#104">104: </a> <span class="php-var">$dossier_fichier_cache</span> = <span class="php-keyword2">dirname</span>(<span class="php-var">$chemin_fichier_cache</span>);</span><span id="105" class="l"><a class="l" href="#105">105: </a> <span class="php-keyword1">if</span> (!<span class="php-keyword2">is_dir</span>(<span class="php-var">$dossier_fichier_cache</span>))</span><span id="106" class="l"><a class="l" href="#106">106: </a> {</span><span id="107" class="l"><a class="l" href="#107">107: </a> <span class="php-keyword2">mkdir</span>(<span class="php-var">$dossier_fichier_cache</span>, <span class="php-num">0755</span>, <span class="php-keyword1">true</span>);</span><span id="108" class="l"><a class="l" href="#108">108: </a> }</span><span id="109" class="l"><a class="l" href="#109">109: </a></span><span id="110" class="l"><a class="l" href="#110">110: </a> <span class="php-var">$fh</span> = <span class="php-keyword2">fopen</span>(<span class="php-var">$chemin_fichier_cache</span>,<span class="php-quote">'w+'</span>);</span><span id="111" class="l"><a class="l" href="#111">111: </a> <span class="php-keyword1">if</span> (<span class="php-var">$fh</span>) {</span><span id="112" class="l"><a class="l" href="#112">112: </a> <span class="php-keyword1">if</span> (<span class="php-keyword2">fwrite</span>(<span class="php-var">$fh</span>, <span class="php-var">$contenu</span>)) {</span><span id="113" class="l"><a class="l" href="#113">113: </a> <span class="php-keyword1">if</span> (<span class="php-keyword2">fclose</span>(<span class="php-var">$fh</span>)) {</span><span id="114" class="l"><a class="l" href="#114">114: </a> <span class="php-keyword2">error_log</span>(<span class="php-keyword2">sprintf</span>(<span class="php-quote">"%s: caching \"%s\" [%s]"</span>, __FILE__, <span class="php-var">$chemin_fichier_cache</span>, @<span class="php-var">$_SERVER</span>[<span class="php-quote">'REQUEST_URI'</span>]));</span><span id="115" class="l"><a class="l" href="#115">115: </a></span><span id="116" class="l"><a class="l" href="#116">116: </a> <span class="php-var">$ok</span> = <span class="php-keyword1">true</span>;</span><span id="117" class="l"><a class="l" href="#117">117: </a> }</span><span id="118" class="l"><a class="l" href="#118">118: </a> }</span><span id="119" class="l"><a class="l" href="#119">119: </a> <span class="php-comment">// Voir #ZF-4422 pour la raison de l'utilisation de octdec()</span></span><span id="120" class="l"><a class="l" href="#120">120: </a> @<span class="php-keyword2">chmod</span>(<span class="php-var">$chemin_fichier_cache</span>, <span class="php-keyword2">octdec</span>(<span class="php-quote">'0777'</span>));</span><span id="121" class="l"><a class="l" href="#121">121: </a> }</span><span id="122" class="l"><a class="l" href="#122">122: </a> }</span><span id="123" class="l"><a class="l" href="#123">123: </a> <span class="php-keyword1">if</span>(!<span class="php-var">$ok</span>) <span class="php-keyword2">error_log</span>(<span class="php-keyword2">sprintf</span>(<span class="php-quote">"%s: ERROR trying to cache \"%s\" [%s]"</span>, __FILE__, <span class="php-var">$chemin_fichier_cache</span>, @<span class="php-var">$_SERVER</span>[<span class="php-quote">'REQUEST_URI'</span>]));</span><span id="124" class="l"><a class="l" href="#124">124: </a> <span class="php-keyword1">return</span> <span class="php-var">$ok</span>;</span><span id="125" class="l"><a class="l" href="#125">125: </a> }</span><span id="126" class="l"><a class="l" href="#126">126: </a>}</span><span id="127" class="l"><a class="l" href="#127">127: </a></span></code></pre><div id="footer">API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a></div></div></div></body></html>