Subversion Repositories Applications.framework

Rev

Rev 187 | 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.
98 jpm 7 
 *
8 
 * PHP Version 5
9 
 *
80 jpm 10 
 * @category  PHP
11 
 * @package   Framework
120 aurelien 12 
 * @author	Jean-Pascal MILCENT <jpm@tela-botanica.org>
80 jpm 13 
 * @copyright 2009 Tela-Botanica
98 jpm 14 
 * @license   GPL-v3 et CECILL-v2
15 
 * @version   SVN: <svn_id>
120 aurelien 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'])) {
134 aurelien 71 
				self::chargerFichierContexte($_GET['contexte']);
109 jpm 72 
			}
122 aurelien 73 
 
109 jpm 74 
			// Chargement du contexte présent dans le POST
75 
			if (isset($_POST['contexte'])) {
134 aurelien 76 
				self::chargerFichierContexte($_POST['contexte']);
109 jpm 77 
			}
89 jpm 78 
		}
80 jpm 79 
	}
80 
 
129 aurelien 81 
	/**
82 
	 * Charge le fichier de config correspondant au contexte
83 
	 * @param string $contexte le contexte
84 
	 */
109 jpm 85 
	private static function chargerFichierContexte($contexte) {
86 
		$chemin_config_appli_contextuel = self::$parametres['chemin_configurations'];
87 
		$chemin_config_appli_contextuel .= sprintf(self::$parametres['fw_fichier_config'], '_'.$contexte);
88 
		self::parserFichierIni($chemin_config_appli_contextuel);
89 
	}
90 
 
129 aurelien 91 
	/**
92 
	 * Parse le fichier ini donné en paramètre
93 
	 * @param string $fichier_ini nom du fichier ini à parser
94 
	 * @return array tableau contenant les paramètres du fichier ini
95 
	 */
80 jpm 96 
	private static function parserFichierIni($fichier_ini) {
120 aurelien 97 
		$retour = false;
80 jpm 98 
		if (file_exists($fichier_ini)) {
91 jpm 99 
			$ini = parse_ini_file($fichier_ini, true);
98 jpm 100 
			$ini = self::analyserTableauIni($ini);
91 jpm 101 
			self::fusionner($ini);
120 aurelien 102 
			$retour = true;
103 
		}
104 
		return $retour;
80 jpm 105 
	}
98 jpm 106 
 
129 aurelien 107 
	/**
108 
	 * fusionne un tableau de paramètres avec le tableau de paramètres global
109 
	 * @param array $ini le tableau à fusionner
110 
	 */
91 jpm 111 
	private static function fusionner(array $ini) {
112 
		self::$parametres = array_merge(self::$parametres, $ini);
113 
	}
98 jpm 114 
 
129 aurelien 115 
	/**
116 
	 * renvoie la valeur demandé grâce une chaine de paramètres
117 
	 * @param string $param la chaine de paramètres
118 
	 * @param array $config le tableau de paramètre
119 
	 * @return string la valeur de la chaine demandée
120 
	 */
117 jp_milcent 121 
	private static function getValeur($param, $config) {
98 jpm 122 
		if ($param === null) {
117 jp_milcent 123 
			return null;
98 jpm 124 
		} else {
182 jpm 125 
			if (isset($config[$param])) {
126 
				return $config[$param];
127 
			} else if (strpos($param, '.') !== false) {
117 jp_milcent 128 
				$pieces = explode('.', $param, 2);
120 aurelien 129 
				if (strlen($pieces[0]) && strlen($pieces[1])) {
130 
					if (isset($config[$pieces[0]])) {
131 
					   if (is_array($config[$pieces[0]])) {
132 
					   		return self::getValeur($pieces[1], $config[$pieces[0]]);
133 
					   }
134 
					}
135 
				}
136 
			} else {
182 jpm 137 
				return null;
120 aurelien 138 
			}
80 jpm 139 
		}
140 
	}
122 aurelien 141 
 
129 aurelien 142 
	/**
143 
	 * Teste si param existe dans le tableau config
144 
	 * @param string $param nom du paramètre
145 
	 * @param array tableau de configuration
146 
	 */
117 jp_milcent 147 
	private static function existeValeur($param, $config) {
80 jpm 148 
		$retour = false;
117 jp_milcent 149 
		if (self::getValeur($param, $config) !== null) {
80 jpm 150 
			$retour = true;
151 
		}
152 
		return $retour;
153 
	}
98 jpm 154 
 
129 aurelien 155 
	/**
156 
	 * Vérifie si l'instance de classe à été crée, si non la crée
157 
	 */
80 jpm 158 
	private static function verifierCreationInstance() {
159 
		if (empty(self::$instance)) {
98 jpm 160 
			self::$instance = new Config();
80 jpm 161 
		}
162 
	}
98 jpm 163 
 
129 aurelien 164 
	/**
165 
	 * analyse un tableau de paramètres
166 
	 * @param array $config le tableau de paramètres
167 
	 * @return array le tableau analysé
168 
	 */
98 jpm 169 
	private static function analyserTableauIni($config = array()) {
187 jpm 170 
		foreach ($config as $cle => &$valeur) {
120 aurelien 171 
			if (is_array($valeur)) {
172 
				$config[$cle] = self::analyserTableauIni($valeur);
173 
			} else {
98 jpm 174 
				self::evaluerReferences($config, $cle);
120 aurelien 175 
				self::evaluerPhp($config, $cle);
176 
				self::evaluerCle($config, $cle, $config[$cle]);
177 
			}
178 
		}
98 jpm 179 
		return $config;
80 jpm 180 
	}
98 jpm 181 
 
129 aurelien 182 
	/**
183 
	 * dans le cas des chaine de configuration à sous clé (ex.: cle.souscle)
184 
	 * evalue les valeurs correspondantes et crée les sous tableaux associés
185 
	 * @param array $config tableau de configuration (par référence)
186 
	 * @param string $cle la cle dans le tableau
187 
	 * @param string $valeur la valeur à affecter
188 
	 */
98 jpm 189 
	private static function evaluerCle(&$config, $cle, $valeur) {
190 
		if (strpos($cle, '.') !== false) {
191 
			unset($config[$cle]);
192 
			$pieces = explode('.', $cle, 2);
120 aurelien 193 
			if (strlen($pieces[0]) && strlen($pieces[1])) {
187 jpm 194 
				if (isset($config[$pieces[0]]) && !is_array($config[$pieces[0]])) {
195 
					$m = "Ne peut pas créer de sous-clé pour '{$pieces[0]}' car la clé existe déjà";
196 
					trigger_error($m, E_USER_WARNING);
197 
				} else {
198 
					$config[$pieces[0]][$pieces[1]] = $valeur;
199 
					$config[$pieces[0]] = self::evaluerCle($config[$pieces[0]], $pieces[1], $valeur);
120 aurelien 200 
				}
201 
			} else {
187 jpm 202 
				$m = "Clé invalide '$cle'";
203 
				trigger_error($m, E_USER_WARNING);
120 aurelien 204 
			}
205 
		} else {
206 
			$config[$cle] = $valeur;
207 
		}
208 
		return $config;
98 jpm 209 
	}
210 
 
129 aurelien 211 
	/**
212 
	 * Evalue les valeurs de références à une clé dans le tableau config (cas du ref:cle)
213 
	 * @param array $config tableau de configuration
214 
	 * @param string $cle la clé dont il faut évaluer les références
215 
	 */
98 jpm 216 
	private static function evaluerReferences(&$config, $cle) {
203 jpm 217 
		if (preg_match_all('/{ref:([A-Za-z0-9_.-]+)}/', $config[$cle], $correspondances,  PREG_SET_ORDER)) {
120 aurelien 218 
			foreach ($correspondances as $ref) {
219 
				$config[$cle] = str_replace($ref[0], self::getValeur($ref[1], $config), $config[$cle]);
220 
			}
221 
		}
98 jpm 222 
	}
223 
 
129 aurelien 224 
	/**
225 
	 * Evalue le code php contenu dans un clé tu tableau config
226 
	 * @param array $config tableau de configuration (par référence)
227 
	 * @param string $cle le clé du tableau dont il faut évaluer la valeur
228 
	 */
98 jpm 229 
	private static function evaluerPhp(&$config, $cle) {
230 
		if (preg_match('/^php:(.+)$/', $config[$cle], $correspondances)) {
120 aurelien 231 
			eval('$config["'.$cle.'"] = '.$correspondances[1].';');
232 
		}
98 jpm 233 
	}
122 aurelien 234 
 
129 aurelien 235 
	/**
236 
	 * Charge un fichier ini dans le tableau des paramètres de l'appli
237 
	 * @param string $fichier_ini le nom du fichier à charger
238 
	 * @return array le fichier ini parsé
239 
	 */
117 jp_milcent 240 
	public static function charger($fichier_ini) {
241 
		self::verifierCreationInstance();
242 
		return self::parserFichierIni($fichier_ini);
243 
	}
244 
 
129 aurelien 245 
	/**
246 
	 * Acesseur pour la valeur d'un paramètre
247 
	 * @param string $param le nom du paramètre
248 
	 * @return string la valeur du paramètre
249 
	 */
117 jp_milcent 250 
	public static function get($param = null) {
251 
		self::verifierCreationInstance();
122 aurelien 252 
		return self::getValeur($param, self::$parametres);
117 jp_milcent 253 
	}
122 aurelien 254 
 
129 aurelien 255 
	/**
256 
	 * Vérifie si la valeur d'un paramètre existe
257 
	 * @param string $param le nom du paramètre
258 
	 * @return boolean vrai si le paramètre existe, false sinon
259 
	 */
117 jp_milcent 260 
	public static function existe($param) {
261 
		self::verifierCreationInstance();
262 
		return self::existeValeur($param, self::$parametres);
263 
	}
80 jpm 264 
}
265 
?>