Subversion Repositories Applications.framework

Rev

Rev 418 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
291 jpm 1
<?php
2
// declare(encoding='UTF-8');
3
/**
4
 * Classe Cache permettant de mettre en cache des données de façon extremement simple.
5
 * Le cache est stocker dans des fichiers textes.
6
 * Le contrôle de la durée de vie du cache se fait avec la fonction PHP filemtime.
7
 * 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
8
 * des fichiers de cache est modifiée en conséquence.
9
 * Les clés pour le tableau des options et les valeurs par défaut sont indiquées dans l'attribut options de la classe.
435 jpm 10
 *
291 jpm 11
 * @category	php 5.2
12
 * @package	Framework
13
 * @author		Jean-Pascal MILCENT <jpm@tela-botanica.org>
435 jpm 14
 * @author		Aurélien PERONNET <aurelien@tela-botanica.org>
291 jpm 15
 * @copyright	Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)
16
 * @license	http://framework.zend.com/license/new-bsd Licence New BSD
17
 * @license	http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL
18
 * @license	http://www.gnu.org/licenses/gpl.html Licence GNU-GPL
19
 * @version	$Id: CacheSimple.php 435 2013-09-04 14:29:43Z jpm $
20
 * @link		/doc/framework/
21
 */
435 jpm 22
// TODO : voir ce qui est le plus pratique : error_log ou le gestionnaire de bogue du framework
291 jpm 23
class CacheSimple {
435 jpm 24
 
291 jpm 25
	private $mise_en_cache = null;
26
	private $stockage_chemin = null;
27
	private $duree_de_vie = null;
435 jpm 28
 
291 jpm 29
	private $options = array(
30
		'mise_en_cache' => 'true',
31
		'stockage_chemin' => 'Fichier::getDossierTmp()',
32
		'duree_de_vie' => '3600*24'
33
	);
435 jpm 34
 
291 jpm 35
	public function __construct($options = array()) {
36
		extract($options);
37
		$this->mise_en_cache = is_bool($mise_en_cache) ? $mise_en_cache : true;
435 jpm 38
 
291 jpm 39
		if ($this->mise_en_cache) {
40
			$this->stockage_chemin = isset($stockage_chemin) ? realpath($stockage_chemin) : Fichier::getDossierTmp();
435 jpm 41
			if (!realpath($stockage_chemin)) {
42
				error_log(sprintf("%s: Attention, %s invalide: creation [%s]",
43
					__FILE__,
44
					$stockage_chemin,
45
					$_SERVER['REQUEST_URI']));
46
				mkdir($stockage_chemin, 0755, TRUE);
47
			}
48
			if (!realpath($stockage_chemin)) {
49
				error_log(sprintf("%s: Attention, realpath(%s) invalide [%s]",
50
					__FILE__,
51
					$stockage_chemin,
52
					$_SERVER['REQUEST_URI']));
53
			} else if(!is_writable(realpath($stockage_chemin))) {
54
				error_log(sprintf("%s: Attention, realpath(%s) non-inscriptible [%s]",
55
					__FILE__,
56
					realpath($stockage_chemin),
57
					$_SERVER['REQUEST_URI']));
58
			} else {
59
				$this->duree_de_vie = isset($duree_de_vie) ? $duree_de_vie : 3600*24;
60
			}
291 jpm 61
		}
62
	}
435 jpm 63
 
291 jpm 64
	private function initialiserOptionsParConfig() {
65
		while (list($nom, $valeur) = each($this->options)) {
66
			if (Config::existe($nom)) {
67
				$this->$nom = Config::get($nom);
68
			}
69
		}
70
	}
435 jpm 71
 
291 jpm 72
	/**
73
	 * Teste si le cache est disponible pour l'id donné et (si oui) le retourne (sinon renvoie false)
74
	 *
75
	 * @param  string  $id l'identifiant du Cache.
76
	 * @return string|false les données en cache.
77
	 */
78
	public function charger($id) {
79
		$contenu = false;
435 jpm 80
		if ($this->mise_en_cache) {
291 jpm 81
			$chemin_fichier_cache = $this->stockage_chemin.DS.$id.'.txt';
82
			if (file_exists($chemin_fichier_cache ) && (time() - @filemtime($chemin_fichier_cache) < $this->duree_de_vie)) {
83
				$contenu = file_get_contents($chemin_fichier_cache);
84
			}
85
		}
86
		return $contenu;
87
	}
435 jpm 88
 
291 jpm 89
	/**
90
	 * Sauvegarde la chaine de données dans un fichier texte.
91
	 *
92
	 * Note : $contenu est toujours de type "string". C'est à vous de gérer la sérialisation.
93
	 *
94
	 * @param  string $contenu les données à mettre en cache.
95
	 * @param  string $id	l'identifiant du Cache.
96
	 * @return boolean true si aucun problème
97
	 */
98
	public function sauver($contenu, $id) {
99
		$ok = false;
100
		if ($this->mise_en_cache) {
101
			$chemin_fichier_cache = $this->stockage_chemin.DS.$id.'.txt';
102
			if (!file_exists($chemin_fichier_cache) || (time() - @filemtime($chemin_fichier_cache) > $this->duree_de_vie)) {
418 aurelien 103
				$dossier_fichier_cache = dirname($chemin_fichier_cache);
104
				if (!is_dir($dossier_fichier_cache))
105
				{
106
					mkdir($dossier_fichier_cache, 0755, true);
107
				}
435 jpm 108
 
291 jpm 109
				$fh = fopen($chemin_fichier_cache,'w+');
110
				if ($fh) {
111
					if (fwrite($fh, $contenu)) {
112
						if (fclose($fh)) {
113
							$ok = true;
114
						}
115
					}
116
					// Voir #ZF-4422 pour la raison de l'utilisation de octdec()
117
					@chmod($chemin_fichier_cache,  octdec('0777'));
118
				}
119
			}
120
		}
121
		return $ok;
122
	}
123
}
124
?>