Subversion Repositories Applications.framework

Rev

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