Rev 302 | Go to most recent revision | 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>File Source for CacheSimple.php</title>
<meta http-equiv='Content-Type' content='text/html; charset=UTF-8'/>
<link rel="stylesheet" href="../media/stylesheet.css" />
</head>
<body>
<h1>Source for file CacheSimple.php</h1>
<p>Documentation is available at <a href="../Framework/_CacheSimple.php.html">CacheSimple.php</a></p>
<div class="src-code">
<div class="src-code"><ol><li><div class="src-line"><a name="a1"></a><span class="src-php"><?php</span></div></li>
<li><div class="src-line"><a name="a2"></a><span class="src-comm">// declare(encoding='UTF-8');</span></div></li>
<li><div class="src-line"><a name="a3"></a><span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a4"></a><span class="src-doc"> * Classe Cache permettant de mettre en cache des données de façon extremement simple.</span></div></li>
<li><div class="src-line"><a name="a5"></a><span class="src-doc"> * Le cache est stocker dans des fichiers textes.</span></div></li>
<li><div class="src-line"><a name="a6"></a><span class="src-doc"> * Le contrôle de la durée de vie du cache se fait avec la fonction PHP filemtime.</span></div></li>
<li><div class="src-line"><a name="a7"></a><span class="src-doc"> * 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></div></li>
<li><div class="src-line"><a name="a8"></a><span class="src-doc"> * des fichiers de cache est modifiée en conséquence.</span></div></li>
<li><div class="src-line"><a name="a9"></a><span class="src-doc"> * 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></div></li>
<li><div class="src-line"><a name="a10"></a><span class="src-doc"> * </span></div></li>
<li><div class="src-line"><a name="a11"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@category</span><span class="src-doc"> php 5.2</span></div></li>
<li><div class="src-line"><a name="a12"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@package</span><span class="src-doc"> Framework</span></div></li>
<li><div class="src-line"><a name="a13"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@author</span><span class="src-doc"> Jean-Pascal MILCENT <jpm@tela-botanica.org></span></div></li>
<li><div class="src-line"><a name="a14"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@author</span><span class="src-doc"> Aurélien PERONNET <aurelien@tela-botanica.org></span></div></li>
<li><div class="src-line"><a name="a15"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@copyright</span><span class="src-doc"> Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</span></div></li>
<li><div class="src-line"><a name="a16"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@license</span><span class="src-doc"> http://framework.zend.com/license/new-bsd Licence New BSD</span></div></li>
<li><div class="src-line"><a name="a17"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@license</span><span class="src-doc"> http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL</span></div></li>
<li><div class="src-line"><a name="a18"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@license</span><span class="src-doc"> http://www.gnu.org/licenses/gpl.html Licence GNU-GPL</span></div></li>
<li><div class="src-line"><a name="a19"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@version</span><span class="src-doc"> $Id: CacheSimple.php 299 2011-01-18 14:03:46Z jpm $</span></div></li>
<li><div class="src-line"><a name="a20"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@link</span><span class="src-doc"> /doc/framework/</span></div></li>
<li><div class="src-line"><a name="a21"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a22"></a><span class="src-key">class </span><a href="../Framework/CacheSimple.html">CacheSimple</a> <span class="src-sym">{</span></div></li>
<li><div class="src-line"><a name="a23"></a> </div></li>
<li><div class="src-line"><a name="a24"></a> <span class="src-key">private </span><span class="src-var">$mise_en_cache </span>= <span class="src-id">null</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a25"></a> <span class="src-key">private </span><span class="src-var">$stockage_chemin </span>= <span class="src-id">null</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a26"></a> <span class="src-key">private </span><span class="src-var">$duree_de_vie </span>= <span class="src-id">null</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a27"></a> </div></li>
<li><div class="src-line"><a name="a28"></a> <span class="src-key">private </span><span class="src-var">$options </span>= <span class="src-key">array</span><span class="src-sym">(</span></div></li>
<li><div class="src-line"><a name="a29"></a> <span class="src-str">'mise_en_cache' </span>=> <span class="src-str">'true'</span><span class="src-sym">,</span></div></li>
<li><div class="src-line"><a name="a30"></a> <span class="src-str">'stockage_chemin' </span>=> <span class="src-str">'Fichier::getDossierTmp()'</span><span class="src-sym">,</span></div></li>
<li><div class="src-line"><a name="a31"></a> <span class="src-str">'duree_de_vie' </span>=> <span class="src-str">'3600*24'</span></div></li>
<li><div class="src-line"><a name="a32"></a> <span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a33"></a> </div></li>
<li><div class="src-line"><a name="a34"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Framework/CacheSimple.html#method__construct">__construct</a><span class="src-sym">(</span><span class="src-var">$options </span>= <span class="src-key">array</span><span class="src-sym">(</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
<li><div class="src-line"><a name="a35"></a> <a href="http://www.php.net/extract">extract</a><span class="src-sym">(</span><span class="src-var">$options</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a36"></a> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">mise_en_cache </span>= <a href="http://www.php.net/is_bool">is_bool</a><span class="src-sym">(</span><span class="src-var">$mise_en_cache</span><span class="src-sym">) </span>? <span class="src-var">$mise_en_cache </span>: <span class="src-id">true</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a37"></a> </div></li>
<li><div class="src-line"><a name="a38"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">mise_en_cache</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
<li><div class="src-line"><a name="a39"></a> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">stockage_chemin </span>= isset<span class="src-sym">(</span><span class="src-var">$stockage_chemin</span><span class="src-sym">) </span>? <a href="http://www.php.net/realpath">realpath</a><span class="src-sym">(</span><span class="src-var">$stockage_chemin</span><span class="src-sym">) </span>: <span class="src-id"><a href="../Utilitaire/Fichier.html">Fichier</a></span><span class="src-sym">::</span><a href="../Utilitaire/Fichier.html#methodgetDossierTmp">getDossierTmp</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a40"></a> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">duree_de_vie </span>= isset<span class="src-sym">(</span><span class="src-var">$duree_de_vie</span><span class="src-sym">) </span>? <span class="src-var">$duree_de_vie </span>: <span class="src-num">3600</span>*<span class="src-num">24</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a41"></a> <span class="src-sym">}</span></div></li>
<li><div class="src-line"><a name="a42"></a> <span class="src-sym">}</span></div></li>
<li><div class="src-line"><a name="a43"></a> </div></li>
<li><div class="src-line"><a name="a44"></a> <span class="src-key">private </span><span class="src-key">function </span><span class="src-id">initialiserOptionsParConfig</span><span class="src-sym">(</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
<li><div class="src-line"><a name="a45"></a> <span class="src-key">while </span><span class="src-sym">(</span>list<span class="src-sym">(</span><span class="src-var">$nom</span><span class="src-sym">, </span><span class="src-var">$valeur</span><span class="src-sym">) </span>= <a href="http://www.php.net/each">each</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">options</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
<li><div class="src-line"><a name="a46"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-id"><a href="../Framework/Config.html">Config</a></span><span class="src-sym">::</span><a href="../Framework/Config.html#methodexiste">existe</a><span class="src-sym">(</span><span class="src-var">$nom</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
<li><div class="src-line"><a name="a47"></a> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">$nom </span>= <span class="src-id"><a href="../Framework/Config.html">Config</a></span><span class="src-sym">::</span><a href="../Framework/Config.html#methodget">get</a><span class="src-sym">(</span><span class="src-var">$nom</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a48"></a> <span class="src-sym">}</span></div></li>
<li><div class="src-line"><a name="a49"></a> <span class="src-sym">}</span></div></li>
<li><div class="src-line"><a name="a50"></a> <span class="src-sym">}</span></div></li>
<li><div class="src-line"><a name="a51"></a> </div></li>
<li><div class="src-line"><a name="a52"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a53"></a><span class="src-doc"> * Teste si le cache est disponible pour l'id donné et (si oui) le retourne (sinon renvoie false)</span></div></li>
<li><div class="src-line"><a name="a54"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a55"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc"> </span><span class="src-doc-type">string </span><span class="src-doc"> </span><span class="src-doc-var">$id </span><span class="src-doc">l'identifiant du Cache.</span></div></li>
<li><div class="src-line"><a name="a56"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string</span><span class="src-doc">|</span><span class="src-doc-type">false</span><span class="src-doc">les données en cache.</span></div></li>
<li><div class="src-line"><a name="a57"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a58"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Framework/CacheSimple.html#methodcharger">charger</a><span class="src-sym">(</span><span class="src-var">$id</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
<li><div class="src-line"><a name="a59"></a> <span class="src-var">$contenu </span>= <span class="src-id">false</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a60"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">mise_en_cache</span><span class="src-sym">) </span><span class="src-sym">{ </span></div></li>
<li><div class="src-line"><a name="a61"></a> <span class="src-var">$chemin_fichier_cache </span>= <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">stockage_chemin</span>.<span class="src-id">DS</span>.<span class="src-var">$id</span>.<span class="src-str">'.txt'</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a62"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/file_exists">file_exists</a><span class="src-sym">(</span><span class="src-var">$chemin_fichier_cache </span><span class="src-sym">) </span>&& <span class="src-sym">(</span><a href="http://www.php.net/time">time</a><span class="src-sym">(</span><span class="src-sym">) </span>- <span class="src-sym">@</span><a href="http://www.php.net/filemtime">filemtime</a><span class="src-sym">(</span><span class="src-var">$chemin_fichier_cache</span><span class="src-sym">) </span>< <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">duree_de_vie</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
<li><div class="src-line"><a name="a63"></a> <span class="src-var">$contenu </span>= <a href="http://www.php.net/file_get_contents">file_get_contents</a><span class="src-sym">(</span><span class="src-var">$chemin_fichier_cache</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a64"></a> <span class="src-sym">}</span></div></li>
<li><div class="src-line"><a name="a65"></a> <span class="src-sym">}</span></div></li>
<li><div class="src-line"><a name="a66"></a> <span class="src-key">return </span><span class="src-var">$contenu</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a67"></a> <span class="src-sym">}</span></div></li>
<li><div class="src-line"><a name="a68"></a> </div></li>
<li><div class="src-line"><a name="a69"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a70"></a><span class="src-doc"> * Sauvegarde la chaine de données dans un fichier texte.</span></div></li>
<li><div class="src-line"><a name="a71"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a72"></a><span class="src-doc"> * Note : $contenu est toujours de type "string". C'est à vous de gérer la sérialisation.</span></div></li>
<li><div class="src-line"><a name="a73"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a74"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc"> </span><span class="src-doc-type">string </span><span class="src-doc-var">$contenu </span><span class="src-doc">les données à mettre en cache.</span></div></li>
<li><div class="src-line"><a name="a75"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc"> </span><span class="src-doc-type">string </span><span class="src-doc-var">$id </span><span class="src-doc"> l'identifiant du Cache.</span></div></li>
<li><div class="src-line"><a name="a76"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">boolean </span><span class="src-doc">true si aucun problème</span></div></li>
<li><div class="src-line"><a name="a77"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a78"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Framework/CacheSimple.html#methodsauver">sauver</a><span class="src-sym">(</span><span class="src-var">$contenu</span><span class="src-sym">, </span><span class="src-var">$id</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
<li><div class="src-line"><a name="a79"></a> <span class="src-var">$ok </span>= <span class="src-id">false</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a80"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">mise_en_cache</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
<li><div class="src-line"><a name="a81"></a> <span class="src-var">$chemin_fichier_cache </span>= <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">stockage_chemin</span>.<span class="src-id">DS</span>.<span class="src-var">$id</span>.<span class="src-str">'.txt'</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a82"></a> </div></li>
<li><div class="src-line"><a name="a83"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><a href="http://www.php.net/file_exists">file_exists</a><span class="src-sym">(</span><span class="src-var">$chemin_fichier_cache</span><span class="src-sym">) </span>|| <span class="src-sym">(</span><a href="http://www.php.net/time">time</a><span class="src-sym">(</span><span class="src-sym">) </span>- <span class="src-sym">@</span><a href="http://www.php.net/filemtime">filemtime</a><span class="src-sym">(</span><span class="src-var">$chemin_fichier_cache</span><span class="src-sym">) </span>> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">duree_de_vie</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
<li><div class="src-line"><a name="a84"></a> <span class="src-var">$fh </span>= <a href="http://www.php.net/fopen">fopen</a><span class="src-sym">(</span><span class="src-var">$chemin_fichier_cache</span><span class="src-sym">,</span><span class="src-str">'w+'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a85"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$fh</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
<li><div class="src-line"><a name="a86"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/fwrite">fwrite</a><span class="src-sym">(</span><span class="src-var">$fh</span><span class="src-sym">, </span><span class="src-var">$contenu</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
<li><div class="src-line"><a name="a87"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/fclose">fclose</a><span class="src-sym">(</span><span class="src-var">$fh</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
<li><div class="src-line"><a name="a88"></a> <span class="src-var">$ok </span>= <span class="src-id">true</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a89"></a> <span class="src-sym">}</span></div></li>
<li><div class="src-line"><a name="a90"></a> <span class="src-sym">}</span></div></li>
<li><div class="src-line"><a name="a91"></a> <span class="src-comm">// Voir #ZF-4422 pour la raison de l'utilisation de octdec()</span></div></li>
<li><div class="src-line"><a name="a92"></a> <span class="src-sym">@</span><a href="http://www.php.net/chmod">chmod</a><span class="src-sym">(</span><span class="src-var">$chemin_fichier_cache</span><span class="src-sym">, </span><a href="http://www.php.net/octdec">octdec</a><span class="src-sym">(</span><span class="src-str">'0777'</span><span class="src-sym">))</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a93"></a> <span class="src-sym">}</span></div></li>
<li><div class="src-line"><a name="a94"></a> <span class="src-sym">}</span></div></li>
<li><div class="src-line"><a name="a95"></a> <span class="src-sym">}</span></div></li>
<li><div class="src-line"><a name="a96"></a> <span class="src-key">return </span><span class="src-var">$ok</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a97"></a> <span class="src-sym">}</span></div></li>
<li><div class="src-line"><a name="a98"></a><span class="src-sym">}</span></div></li>
<li><div class="src-line"><a name="a99"></a><span class="src-php">?></span></div></li>
</ol></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>
</body>
</html>