Subversion Repositories Applications.framework

Rev

Rev 184 | Rev 189 | 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 
 *
186 jpm 8 
 * @category	PHP 5.2
9 
 * @package		Framework
10 
 * @author		Jean-Pascal MILCENT <jpm@tela-botanica.org>
11 
 * @copyright	Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)
12 
 * @license		http://www.gnu.org/licenses/gpl.html Licence GNU-GPL-v3
13 
 * @license		http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL-v2
14 
 * @version		SVN : $Id: Config.php 186 2010-04-28 15:50:16Z jpm $
15 
 * @link		/doc/framework/
80 jpm 16 
 */
17 
 
18 
class Config {
98 jpm 19 
 
129 aurelien 20 
	/**
21 
	 * instance de la classe pointant sur elle même (pour le pattern singleton)
22 
	 */
80 jpm 23 
	private static $instance = null;
129 aurelien 24 
 
25 
	/**
26 
	 * paramètres de configuration
27 
	 */
80 jpm 28 
	private static $parametres = array();
98 jpm 29 
 
129 aurelien 30 
	/**
31 
	 * Constructeur vide
32 
	 */
80 jpm 33 
	private function __construct() {
105 aurelien 34 
		// Définition de paramètres avant chargement du config.ini
80 jpm 35 
		self::$parametres = array(
89 jpm 36 
			'fw_fichier_config' => 'config%s.ini',
91 jpm 37 
			'fw_chemin' => dirname(__FILE__).DS
80 jpm 38 
			);
98 jpm 39 
 
40 
		// Chargement du fichier config.ini du Framework
139 jpm 41 
		$existe = self::parserFichierIni(self::$parametres['fw_chemin'].sprintf(self::$parametres['fw_fichier_config'], ''));
42 
		if ($existe === false) {
43 
			trigger_error("Veuillez configurer le Framework en renommant le fichier config.defaut.ini en config.ini.", E_USER_ERROR);
44 
		}
98 jpm 45 
 
105 aurelien 46 
		// Chargement du fichier config.ini par défaut de l'application
98 jpm 47 
		$chemin_config_defaut_appli = self::$parametres['chemin_configurations'].sprintf(self::$parametres['fw_fichier_config'], '');
48 
		self::parserFichierIni($chemin_config_defaut_appli);
122 aurelien 49 
 
98 jpm 50 
		// Chargement des fichiers config.ini contextuels
109 jpm 51 
		if (PHP_SAPI == 'cli') {// mode console
52 
			foreach ($_SERVER['argv'] as $cle => $valeur) {
53 
				if ($valeur == '-contexte') {
54 
					chargerFichierContexte($_SERVER['argv'][($cle+1)]);
55 
					break;
56 
				}
57 
			}
58 
		} else {// mode web
59 
			// Pour Papyrus
60 
			if (defined('PAP_VERSION')) {
134 aurelien 61 
				self::chargerFichierContexte('papyrus');
109 jpm 62 
			}
63 
			// Via le fichie .ini par défaut de l'appli
117 jp_milcent 64 
			if (Config::existeValeur('info.contexte', self::$parametres)) {
134 aurelien 65 
				self::chargerFichierContexte(Config::get('info.contexte'));
109 jpm 66 
			}
122 aurelien 67 
 
109 jpm 68 
			// Chargement du contexte présent dans le GET
69 
			if (isset($_GET['contexte'])) {
134 aurelien 70 
				self::chargerFichierContexte($_GET['contexte']);
109 jpm 71 
			}
122 aurelien 72 
 
109 jpm 73 
			// Chargement du contexte présent dans le POST
74 
			if (isset($_POST['contexte'])) {
134 aurelien 75 
				self::chargerFichierContexte($_POST['contexte']);
109 jpm 76 
			}
89 jpm 77 
		}
80 jpm 78 
	}
79 
 
129 aurelien 80 
	/**
81 
	 * Charge le fichier de config correspondant au contexte
82 
	 * @param string $contexte le contexte
83 
	 */
109 jpm 84 
	private static function chargerFichierContexte($contexte) {
85 
		$chemin_config_appli_contextuel = self::$parametres['chemin_configurations'];
86 
		$chemin_config_appli_contextuel .= sprintf(self::$parametres['fw_fichier_config'], '_'.$contexte);
87 
		self::parserFichierIni($chemin_config_appli_contextuel);
88 
	}
89 
 
129 aurelien 90 
	/**
91 
	 * Parse le fichier ini donné en paramètre
92 
	 * @param string $fichier_ini nom du fichier ini à parser
93 
	 * @return array tableau contenant les paramètres du fichier ini
94 
	 */
80 jpm 95 
	private static function parserFichierIni($fichier_ini) {
120 aurelien 96 
		$retour = false;
80 jpm 97 
		if (file_exists($fichier_ini)) {
91 jpm 98 
			$ini = parse_ini_file($fichier_ini, true);
98 jpm 99 
			$ini = self::analyserTableauIni($ini);
91 jpm 100 
			self::fusionner($ini);
120 aurelien 101 
			$retour = true;
102 
		}
103 
		return $retour;
80 jpm 104 
	}
98 jpm 105 
 
129 aurelien 106 
	/**
107 
	 * fusionne un tableau de paramètres avec le tableau de paramètres global
108 
	 * @param array $ini le tableau à fusionner
109 
	 */
91 jpm 110 
	private static function fusionner(array $ini) {
111 
		self::$parametres = array_merge(self::$parametres, $ini);
112 
	}
98 jpm 113 
 
129 aurelien 114 
	/**
115 
	 * renvoie la valeur demandé grâce une chaine de paramètres
116 
	 * @param string $param la chaine de paramètres
117 
	 * @param array $config le tableau de paramètre
118 
	 * @return string la valeur de la chaine demandée
119 
	 */
117 jp_milcent 120 
	private static function getValeur($param, $config) {
98 jpm 121 
		if ($param === null) {
117 jp_milcent 122 
			return null;
98 jpm 123 
		} else {
184 jpm 124 
			if (isset($config[$param])) {
125 
				return $config[$param];
126 
			} else if (strpos($param, '.') !== false) {
117 jp_milcent 127 
				$pieces = explode('.', $param, 2);
120 aurelien 128 
				if (strlen($pieces[0]) && strlen($pieces[1])) {
129 
					if (isset($config[$pieces[0]])) {
130 
					   if (is_array($config[$pieces[0]])) {
131 
					   		return self::getValeur($pieces[1], $config[$pieces[0]]);
132 
					   }
133 
					}
134 
				}
135 
			} else {
184 jpm 136 
				return null;
120 aurelien 137 
			}
80 jpm 138 
		}
139 
	}
122 aurelien 140 
 
129 aurelien 141 
	/**
142 
	 * Teste si param existe dans le tableau config
143 
	 * @param string $param nom du paramètre
144 
	 * @param array tableau de configuration
145 
	 */
117 jp_milcent 146 
	private static function existeValeur($param, $config) {
80 jpm 147 
		$retour = false;
117 jp_milcent 148 
		if (self::getValeur($param, $config) !== null) {
80 jpm 149 
			$retour = true;
150 
		}
151 
		return $retour;
152 
	}
98 jpm 153 
 
129 aurelien 154 
	/**
155 
	 * Vérifie si l'instance de classe à été crée, si non la crée
156 
	 */
80 jpm 157 
	private static function verifierCreationInstance() {
158 
		if (empty(self::$instance)) {
98 jpm 159 
			self::$instance = new Config();
80 jpm 160 
		}
161 
	}
98 jpm 162 
 
129 aurelien 163 
	/**
164 
	 * analyse un tableau de paramètres
165 
	 * @param array $config le tableau de paramètres
166 
	 * @return array le tableau analysé
167 
	 */
98 jpm 168 
	private static function analyserTableauIni($config = array()) {
186 jpm 169 
		foreach ($config as $cle => &$valeur) {
120 aurelien 170 
			if (is_array($valeur)) {
171 
				$config[$cle] = self::analyserTableauIni($valeur);
172 
			} else {
98 jpm 173 
				self::evaluerReferences($config, $cle);
120 aurelien 174 
				self::evaluerPhp($config, $cle);
175 
				self::evaluerCle($config, $cle, $config[$cle]);
176 
			}
177 
		}
98 jpm 178 
		return $config;
80 jpm 179 
	}
98 jpm 180 
 
129 aurelien 181 
	/**
182 
	 * dans le cas des chaine de configuration à sous clé (ex.: cle.souscle)
183 
	 * evalue les valeurs correspondantes et crée les sous tableaux associés
184 
	 * @param array $config tableau de configuration (par référence)
185 
	 * @param string $cle la cle dans le tableau
186 
	 * @param string $valeur la valeur à affecter
187 
	 */
98 jpm 188 
	private static function evaluerCle(&$config, $cle, $valeur) {
189 
		if (strpos($cle, '.') !== false) {
190 
			unset($config[$cle]);
191 
			$pieces = explode('.', $cle, 2);
120 aurelien 192 
			if (strlen($pieces[0]) && strlen($pieces[1])) {
193 
				if (!isset($config[$pieces[0]])) {
194 
					if ($pieces[0] === '0' && !empty($config)) {
195 
						// convert the current values in $config into an array
196 
						$config = array($pieces[0] => $config);
197 
					} else {
198 
						$config[$pieces[0]] = array();
199 
					}
200 
				} elseif (!is_array($config[$pieces[0]])) {
201 
					throw new ErrorException("Ne peut pas créer de sous-clé pour '{$pieces[0]}' car la clé existe déjà");
202 
				}
203 
				$config[$pieces[0]] = self::evaluerCle($config[$pieces[0]], $pieces[1], $valeur);
204 
			} else {
205 
				throw new ErrorException("Clé invalide '$cle'");
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) {
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 
?>