Subversion Repositories Applications.framework

Rev

Rev 447 | 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 489 2014-09-16 13:27:44Z mathias $
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') {
402 jpm 48 
					self::chargerFichierContexte($_SERVER['argv'][($cle+1)]);
109 jpm 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 
	 */
489 mathias 80 
	public static function chargerFichierContexte($contexte) {
109 jpm 81 
		$chemin_config_appli_contextuel = self::$parametres['chemin_configurations'];
395 aurelien 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) {
447 jpm 92 
		$retour = false;
93 
		if (file_exists($fichier_ini)) {
94 
			$ini = parse_ini_file($fichier_ini, true);
95 
			$ini = self::analyserTableauIni($ini);
96 
			$retour = true;
97 
		} else {
98 
			error_log("Fichier de configuration introuvable : $fichier_ini");
99 
		}
100 
		return $retour;
80 jpm 101 
	}
98 jpm 102 
 
129 aurelien 103 
	/**
241 jpm 104 
	 * Fusionne un tableau de paramètres avec le tableau de paramètres global
129 aurelien 105 
	 * @param array $ini le tableau à fusionner
106 
	 */
91 jpm 107 
	private static function fusionner(array $ini) {
108 
		self::$parametres = array_merge(self::$parametres, $ini);
109 
	}
98 jpm 110 
 
129 aurelien 111 
	/**
241 jpm 112 
	 * Renvoie la valeur demandée grâce une chaîne de paramètres
129 aurelien 113 
	 * @param string $param la chaine de paramètres
114 
	 * @param array $config le tableau de paramètre
115 
	 * @return string la valeur de la chaine demandée
116 
	 */
117 jp_milcent 117 
	private static function getValeur($param, $config) {
98 jpm 118 
		if ($param === null) {
117 jp_milcent 119 
			return null;
98 jpm 120 
		} else {
184 jpm 121 
			if (isset($config[$param])) {
122 
				return $config[$param];
123 
			} else if (strpos($param, '.') !== false) {
117 jp_milcent 124 
				$pieces = explode('.', $param, 2);
120 aurelien 125 
				if (strlen($pieces[0]) && strlen($pieces[1])) {
126 
					if (isset($config[$pieces[0]])) {
127 
					   if (is_array($config[$pieces[0]])) {
128 
					   		return self::getValeur($pieces[1], $config[$pieces[0]]);
129 
					   }
130 
					}
131 
				}
132 
			} else {
184 jpm 133 
				return null;
120 aurelien 134 
			}
80 jpm 135 
		}
136 
	}
122 aurelien 137 
 
129 aurelien 138 
	/**
139 
	 * Teste si param existe dans le tableau config
140 
	 * @param string $param nom du paramètre
141 
	 * @param array tableau de configuration
142 
	 */
117 jp_milcent 143 
	private static function existeValeur($param, $config) {
80 jpm 144 
		$retour = false;
117 jp_milcent 145 
		if (self::getValeur($param, $config) !== null) {
80 jpm 146 
			$retour = true;
147 
		}
148 
		return $retour;
149 
	}
98 jpm 150 
 
129 aurelien 151 
	/**
152 
	 * Vérifie si l'instance de classe à été crée, si non la crée
153 
	 */
80 jpm 154 
	private static function verifierCreationInstance() {
155 
		if (empty(self::$instance)) {
98 jpm 156 
			self::$instance = new Config();
80 jpm 157 
		}
158 
	}
98 jpm 159 
 
129 aurelien 160 
	/**
241 jpm 161 
	 * Analyse un tableau de paramètres.
129 aurelien 162 
	 * @param array $config le tableau de paramètres
163 
	 * @return array le tableau analysé
164 
	 */
98 jpm 165 
	private static function analyserTableauIni($config = array()) {
186 jpm 166 
		foreach ($config as $cle => &$valeur) {
120 aurelien 167 
			if (is_array($valeur)) {
168 
				$config[$cle] = self::analyserTableauIni($valeur);
169 
			} else {
98 jpm 170 
				self::evaluerReferences($config, $cle);
120 aurelien 171 
				self::evaluerPhp($config, $cle);
172 
				self::evaluerCle($config, $cle, $config[$cle]);
173 
			}
390 jpm 174 
			self::fusionner($config);
120 aurelien 175 
		}
98 jpm 176 
		return $config;
80 jpm 177 
	}
98 jpm 178 
 
129 aurelien 179 
	/**
241 jpm 180 
	 * Dans le cas des chaine de configuration à sous clé (ex.: cle.souscle)
181 
	 * évalue les valeurs correspondantes et crée les sous tableaux associés.
129 aurelien 182 
	 * @param array $config tableau de configuration (par référence)
183 
	 * @param string $cle la cle dans le tableau
184 
	 * @param string $valeur la valeur à affecter
185 
	 */
98 jpm 186 
	private static function evaluerCle(&$config, $cle, $valeur) {
187 
		if (strpos($cle, '.') !== false) {
188 
			unset($config[$cle]);
189 
			$pieces = explode('.', $cle, 2);
120 aurelien 190 
			if (strlen($pieces[0]) && strlen($pieces[1])) {
189 jpm 191 
				if (isset($config[$pieces[0]]) && !is_array($config[$pieces[0]])) {
192 
					$m = "Ne peut pas créer de sous-clé pour '{$pieces[0]}' car la clé existe déjà";
193 
					trigger_error($m, E_USER_WARNING);
194 
				} else {
195 
					$config[$pieces[0]][$pieces[1]] = $valeur;
196 
					$config[$pieces[0]] = self::evaluerCle($config[$pieces[0]], $pieces[1], $valeur);
120 aurelien 197 
				}
198 
			} else {
189 jpm 199 
				$m = "Clé invalide '$cle'";
200 
				trigger_error($m, E_USER_WARNING);
120 aurelien 201 
			}
202 
		} else {
203 
			$config[$cle] = $valeur;
204 
		}
205 
		return $config;
98 jpm 206 
	}
207 
 
129 aurelien 208 
	/**
241 jpm 209 
	 * Évalue les valeurs de références à une clé dans le tableau config (cas du ref:cle).
129 aurelien 210 
	 * @param array $config tableau de configuration
211 
	 * @param string $cle la clé dont il faut évaluer les références
212 
	 */
98 jpm 213 
	private static function evaluerReferences(&$config, $cle) {
203 jpm 214 
		if (preg_match_all('/{ref:([A-Za-z0-9_.-]+)}/', $config[$cle], $correspondances,  PREG_SET_ORDER)) {
120 aurelien 215 
			foreach ($correspondances as $ref) {
388 jpm 216 
				$config[$cle] = str_replace($ref[0], self::getValeur($ref[1], self::$parametres), $config[$cle]);
120 aurelien 217 
			}
218 
		}
98 jpm 219 
	}
220 
 
129 aurelien 221 
	/**
241 jpm 222 
	 * Évalue le code php contenu dans un clé tu tableau config.
129 aurelien 223 
	 * @param array $config tableau de configuration (par référence)
224 
	 * @param string $cle le clé du tableau dont il faut évaluer la valeur
225 
	 */
98 jpm 226 
	private static function evaluerPhp(&$config, $cle) {
227 
		if (preg_match('/^php:(.+)$/', $config[$cle], $correspondances)) {
120 aurelien 228 
			eval('$config["'.$cle.'"] = '.$correspondances[1].';');
229 
		}
98 jpm 230 
	}
122 aurelien 231 
 
129 aurelien 232 
	/**
241 jpm 233 
	 * Charge un fichier ini dans le tableau des paramètres de l'appli.
129 aurelien 234 
	 * @param string $fichier_ini le nom du fichier à charger
235 
	 * @return array le fichier ini parsé
236 
	 */
117 jp_milcent 237 
	public static function charger($fichier_ini) {
238 
		self::verifierCreationInstance();
239 
		return self::parserFichierIni($fichier_ini);
240 
	}
241 
 
129 aurelien 242 
	/**
241 jpm 243 
	 * Accesseur pour la valeur d'un paramètre.
129 aurelien 244 
	 * @param string $param le nom du paramètre
245 
	 * @return string la valeur du paramètre
246 
	 */
117 jp_milcent 247 
	public static function get($param = null) {
248 
		self::verifierCreationInstance();
122 aurelien 249 
		return self::getValeur($param, self::$parametres);
117 jp_milcent 250 
	}
122 aurelien 251 
 
129 aurelien 252 
	/**
241 jpm 253 
	 * Vérifie si la valeur d'un paramètre existe.
129 aurelien 254 
	 * @param string $param le nom du paramètre
255 
	 * @return boolean vrai si le paramètre existe, false sinon
256 
	 */
117 jp_milcent 257 
	public static function existe($param) {
258 
		self::verifierCreationInstance();
259 
		return self::existeValeur($param, self::$parametres);
260 
	}
388 jpm 261 
 
241 jpm 262 
	/**
263 
	 * Vérifie que tous les paramêtres de config nécessaires au fonctionnement d'une classe existe dans les fichiers
264 
	 * de configurations.
265 
	 * L'utilisation de cette méthode depuis la classe Config évite de faire appel à une classe supplémentaire.
388 jpm 266 
	 *
241 jpm 267 
	 * @param array $parametres tableau des noms des paramètres de la config à verifier.
268 
	 * @return boolean true si tous les paramétres sont présents sinon false.
269 
	 */
270 
	public static function verifierPresenceParametres(Array $parametres) {
271 
		$ok = true;
272 
		foreach ($parametres as $param) {
273 
			if (is_null(self::get($param))) {
274 
				$classe = get_class();
275 
				$m = "L'utilisation de la classe $classe nécessite de définir '$param' dans un fichier de configuration.";
276 
				trigger_error($m, E_USER_ERROR);
277 
				$ok = false;
278 
			}
279 
		}
280 
		return $ok;
281 
	}
80 jpm 282 
}
283 
?>