Subversion Repositories Applications.framework

Rev

Rev 203 | Rev 241 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
80 jpm 1 
<?php
105 aurelien 2 
// declare(encoding='UTF-8');
80 jpm 3 
/**
4 
 * Config permet de charger automatiquement les fichiers ini du Framework et de l'application.
105 aurelien 5 
 * Elle offre l'accès en lecture seule aux paramètres de config.
80 jpm 6 
 * C'est une Singleton.
239 jpm 7 
 * Si vous avez besoin de modifier dynamiquement des paramètres de configuration, utiliser le @see Registe, il est fait pour ça.
8 
 *
186 jpm 9 
 * @category	PHP 5.2
10 
 * @package		Framework
11 
 * @author		Jean-Pascal MILCENT <jpm@tela-botanica.org>
12 
 * @copyright	Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)
13 
 * @license		http://www.gnu.org/licenses/gpl.html Licence GNU-GPL-v3
14 
 * @license		http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL-v2
15 
 * @version		SVN : $Id: Config.php 239 2010-11-25 18:04:00Z jpm $
16 
 * @link		/doc/framework/
80 jpm 17 
 */
18 
 
19 
class Config {
98 jpm 20 
 
129 aurelien 21 
	/**
22 
	 * instance de la classe pointant sur elle même (pour le pattern singleton)
23 
	 */
80 jpm 24 
	private static $instance = null;
129 aurelien 25 
 
26 
	/**
27 
	 * paramètres de configuration
28 
	 */
80 jpm 29 
	private static $parametres = array();
98 jpm 30 
 
129 aurelien 31 
	/**
32 
	 * Constructeur vide
33 
	 */
80 jpm 34 
	private function __construct() {
105 aurelien 35 
		// Définition de paramètres avant chargement du config.ini
80 jpm 36 
		self::$parametres = array(
89 jpm 37 
			'fw_fichier_config' => 'config%s.ini',
91 jpm 38 
			'fw_chemin' => dirname(__FILE__).DS
80 jpm 39 
			);
98 jpm 40 
 
41 
		// Chargement du fichier config.ini du Framework
139 jpm 42 
		$existe = self::parserFichierIni(self::$parametres['fw_chemin'].sprintf(self::$parametres['fw_fichier_config'], ''));
43 
		if ($existe === false) {
44 
			trigger_error("Veuillez configurer le Framework en renommant le fichier config.defaut.ini en config.ini.", E_USER_ERROR);
45 
		}
98 jpm 46 
 
105 aurelien 47 
		// Chargement du fichier config.ini par défaut de l'application
98 jpm 48 
		$chemin_config_defaut_appli = self::$parametres['chemin_configurations'].sprintf(self::$parametres['fw_fichier_config'], '');
49 
		self::parserFichierIni($chemin_config_defaut_appli);
122 aurelien 50 
 
98 jpm 51 
		// Chargement des fichiers config.ini contextuels
109 jpm 52 
		if (PHP_SAPI == 'cli') {// mode console
53 
			foreach ($_SERVER['argv'] as $cle => $valeur) {
54 
				if ($valeur == '-contexte') {
55 
					chargerFichierContexte($_SERVER['argv'][($cle+1)]);
56 
					break;
57 
				}
58 
			}
59 
		} else {// mode web
60 
			// Pour Papyrus
61 
			if (defined('PAP_VERSION')) {
134 aurelien 62 
				self::chargerFichierContexte('papyrus');
109 jpm 63 
			}
64 
			// Via le fichie .ini par défaut de l'appli
117 jp_milcent 65 
			if (Config::existeValeur('info.contexte', self::$parametres)) {
134 aurelien 66 
				self::chargerFichierContexte(Config::get('info.contexte'));
109 jpm 67 
			}
122 aurelien 68 
 
109 jpm 69 
			// Chargement du contexte présent dans le GET
70 
			if (isset($_GET['contexte'])) {
198 jpm 71 
				$_GET['contexte'] = strip_tags($_GET['contexte']);
134 aurelien 72 
				self::chargerFichierContexte($_GET['contexte']);
109 jpm 73 
			}
122 aurelien 74 
 
109 jpm 75 
			// Chargement du contexte présent dans le POST
76 
			if (isset($_POST['contexte'])) {
198 jpm 77 
				$_POST['contexte'] = strip_tags($_POST['contexte']);
134 aurelien 78 
				self::chargerFichierContexte($_POST['contexte']);
109 jpm 79 
			}
89 jpm 80 
		}
80 jpm 81 
	}
82 
 
129 aurelien 83 
	/**
84 
	 * Charge le fichier de config correspondant au contexte
85 
	 * @param string $contexte le contexte
86 
	 */
109 jpm 87 
	private static function chargerFichierContexte($contexte) {
88 
		$chemin_config_appli_contextuel = self::$parametres['chemin_configurations'];
89 
		$chemin_config_appli_contextuel .= sprintf(self::$parametres['fw_fichier_config'], '_'.$contexte);
90 
		self::parserFichierIni($chemin_config_appli_contextuel);
91 
	}
92 
 
129 aurelien 93 
	/**
94 
	 * Parse le fichier ini donné en paramètre
95 
	 * @param string $fichier_ini nom du fichier ini à parser
96 
	 * @return array tableau contenant les paramètres du fichier ini
97 
	 */
80 jpm 98 
	private static function parserFichierIni($fichier_ini) {
120 aurelien 99 
		$retour = false;
80 jpm 100 
		if (file_exists($fichier_ini)) {
91 jpm 101 
			$ini = parse_ini_file($fichier_ini, true);
98 jpm 102 
			$ini = self::analyserTableauIni($ini);
91 jpm 103 
			self::fusionner($ini);
120 aurelien 104 
			$retour = true;
105 
		}
106 
		return $retour;
80 jpm 107 
	}
98 jpm 108 
 
129 aurelien 109 
	/**
110 
	 * fusionne un tableau de paramètres avec le tableau de paramètres global
111 
	 * @param array $ini le tableau à fusionner
112 
	 */
91 jpm 113 
	private static function fusionner(array $ini) {
114 
		self::$parametres = array_merge(self::$parametres, $ini);
115 
	}
98 jpm 116 
 
129 aurelien 117 
	/**
118 
	 * renvoie la valeur demandé grâce une chaine de paramètres
119 
	 * @param string $param la chaine de paramètres
120 
	 * @param array $config le tableau de paramètre
121 
	 * @return string la valeur de la chaine demandée
122 
	 */
117 jp_milcent 123 
	private static function getValeur($param, $config) {
98 jpm 124 
		if ($param === null) {
117 jp_milcent 125 
			return null;
98 jpm 126 
		} else {
184 jpm 127 
			if (isset($config[$param])) {
128 
				return $config[$param];
129 
			} else if (strpos($param, '.') !== false) {
117 jp_milcent 130 
				$pieces = explode('.', $param, 2);
120 aurelien 131 
				if (strlen($pieces[0]) && strlen($pieces[1])) {
132 
					if (isset($config[$pieces[0]])) {
133 
					   if (is_array($config[$pieces[0]])) {
134 
					   		return self::getValeur($pieces[1], $config[$pieces[0]]);
135 
					   }
136 
					}
137 
				}
138 
			} else {
184 jpm 139 
				return null;
120 aurelien 140 
			}
80 jpm 141 
		}
142 
	}
122 aurelien 143 
 
129 aurelien 144 
	/**
145 
	 * Teste si param existe dans le tableau config
146 
	 * @param string $param nom du paramètre
147 
	 * @param array tableau de configuration
148 
	 */
117 jp_milcent 149 
	private static function existeValeur($param, $config) {
80 jpm 150 
		$retour = false;
117 jp_milcent 151 
		if (self::getValeur($param, $config) !== null) {
80 jpm 152 
			$retour = true;
153 
		}
154 
		return $retour;
155 
	}
98 jpm 156 
 
129 aurelien 157 
	/**
158 
	 * Vérifie si l'instance de classe à été crée, si non la crée
159 
	 */
80 jpm 160 
	private static function verifierCreationInstance() {
161 
		if (empty(self::$instance)) {
98 jpm 162 
			self::$instance = new Config();
80 jpm 163 
		}
164 
	}
98 jpm 165 
 
129 aurelien 166 
	/**
167 
	 * analyse un tableau de paramètres
168 
	 * @param array $config le tableau de paramètres
169 
	 * @return array le tableau analysé
170 
	 */
98 jpm 171 
	private static function analyserTableauIni($config = array()) {
186 jpm 172 
		foreach ($config as $cle => &$valeur) {
120 aurelien 173 
			if (is_array($valeur)) {
174 
				$config[$cle] = self::analyserTableauIni($valeur);
175 
			} else {
98 jpm 176 
				self::evaluerReferences($config, $cle);
120 aurelien 177 
				self::evaluerPhp($config, $cle);
178 
				self::evaluerCle($config, $cle, $config[$cle]);
179 
			}
180 
		}
98 jpm 181 
		return $config;
80 jpm 182 
	}
98 jpm 183 
 
129 aurelien 184 
	/**
185 
	 * dans le cas des chaine de configuration à sous clé (ex.: cle.souscle)
186 
	 * evalue les valeurs correspondantes et crée les sous tableaux associés
187 
	 * @param array $config tableau de configuration (par référence)
188 
	 * @param string $cle la cle dans le tableau
189 
	 * @param string $valeur la valeur à affecter
190 
	 */
98 jpm 191 
	private static function evaluerCle(&$config, $cle, $valeur) {
192 
		if (strpos($cle, '.') !== false) {
193 
			unset($config[$cle]);
194 
			$pieces = explode('.', $cle, 2);
120 aurelien 195 
			if (strlen($pieces[0]) && strlen($pieces[1])) {
189 jpm 196 
				if (isset($config[$pieces[0]]) && !is_array($config[$pieces[0]])) {
197 
					$m = "Ne peut pas créer de sous-clé pour '{$pieces[0]}' car la clé existe déjà";
198 
					trigger_error($m, E_USER_WARNING);
199 
				} else {
200 
					$config[$pieces[0]][$pieces[1]] = $valeur;
201 
					$config[$pieces[0]] = self::evaluerCle($config[$pieces[0]], $pieces[1], $valeur);
120 aurelien 202 
				}
203 
			} else {
189 jpm 204 
				$m = "Clé invalide '$cle'";
205 
				trigger_error($m, E_USER_WARNING);
120 aurelien 206 
			}
207 
		} else {
208 
			$config[$cle] = $valeur;
209 
		}
210 
		return $config;
98 jpm 211 
	}
212 
 
129 aurelien 213 
	/**
214 
	 * Evalue les valeurs de références à une clé dans le tableau config (cas du ref:cle)
215 
	 * @param array $config tableau de configuration
216 
	 * @param string $cle la clé dont il faut évaluer les références
217 
	 */
98 jpm 218 
	private static function evaluerReferences(&$config, $cle) {
203 jpm 219 
		if (preg_match_all('/{ref:([A-Za-z0-9_.-]+)}/', $config[$cle], $correspondances,  PREG_SET_ORDER)) {
120 aurelien 220 
			foreach ($correspondances as $ref) {
221 
				$config[$cle] = str_replace($ref[0], self::getValeur($ref[1], $config), $config[$cle]);
222 
			}
223 
		}
98 jpm 224 
	}
225 
 
129 aurelien 226 
	/**
227 
	 * Evalue le code php contenu dans un clé tu tableau config
228 
	 * @param array $config tableau de configuration (par référence)
229 
	 * @param string $cle le clé du tableau dont il faut évaluer la valeur
230 
	 */
98 jpm 231 
	private static function evaluerPhp(&$config, $cle) {
232 
		if (preg_match('/^php:(.+)$/', $config[$cle], $correspondances)) {
120 aurelien 233 
			eval('$config["'.$cle.'"] = '.$correspondances[1].';');
234 
		}
98 jpm 235 
	}
122 aurelien 236 
 
129 aurelien 237 
	/**
238 
	 * Charge un fichier ini dans le tableau des paramètres de l'appli
239 
	 * @param string $fichier_ini le nom du fichier à charger
240 
	 * @return array le fichier ini parsé
241 
	 */
117 jp_milcent 242 
	public static function charger($fichier_ini) {
243 
		self::verifierCreationInstance();
244 
		return self::parserFichierIni($fichier_ini);
245 
	}
246 
 
129 aurelien 247 
	/**
248 
	 * Acesseur pour la valeur d'un paramètre
249 
	 * @param string $param le nom du paramètre
250 
	 * @return string la valeur du paramètre
251 
	 */
117 jp_milcent 252 
	public static function get($param = null) {
253 
		self::verifierCreationInstance();
122 aurelien 254 
		return self::getValeur($param, self::$parametres);
117 jp_milcent 255 
	}
122 aurelien 256 
 
129 aurelien 257 
	/**
258 
	 * Vérifie si la valeur d'un paramètre existe
259 
	 * @param string $param le nom du paramètre
260 
	 * @return boolean vrai si le paramètre existe, false sinon
261 
	 */
117 jp_milcent 262 
	public static function existe($param) {
263 
		self::verifierCreationInstance();
264 
		return self::existeValeur($param, self::$parametres);
265 
	}
80 jpm 266 
}
267 
?>