WebSVN – Applications.framework – Diff – /trunk/framework/Config.php

  * Elle offre l'accès en lecture seule aux paramètres de config.
  * C'est une Singleton.
  * Si vous avez besoin de modifier dynamiquement des paramètres de configuration, utiliser le @see Registe, il est fait pour ça.
+ *
  * @category	PHP 5.2
- * @package		Framework
+ * @package	Framework
  * @author		Jean-Pascal MILCENT <jpm@tela-botanica.org>
  * @copyright	Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)
- * @license		http://www.gnu.org/licenses/gpl.html Licence GNU-GPL-v3
+ * @license	http://www.gnu.org/licenses/gpl.html Licence GNU-GPL-v3
- * @license		http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL-v2
+ * @license	http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL-v2
- * @version		SVN : $Id: Config.php 239 2010-11-25 18:04:00Z jpm $
+ * @version	$Id: Config.php 241 2010-12-06 15:19:07Z jpm $
  * @link		/doc/framework/
  */
-class Config {
+class Config {
-	/**
 	 * instance de la classe pointant sur elle même (pour le pattern singleton)
-	 */
-	private static $instance = null;
+	/** Instance de la classe pointant sur elle même (pour le pattern singleton). */
-	/**
+	private static $instance = null;
-	 * paramètres de configuration
-	 */
-	private static $parametres = array();
-	/**
+	/** Paramètres de configuration. */
-	 * Constructeur vide
+	private static $parametres = array();
 	 */
 	private function __construct() {
+		}
 		return $retour;
+	}
 	/**
-	 * fusionne un tableau de paramètres avec le tableau de paramètres global
+	 * Fusionne un tableau de paramètres avec le tableau de paramètres global
 	 * @param array $ini le tableau à fusionner
 	 */
 	private static function fusionner(array $ini) {
 		self::$parametres = array_merge(self::$parametres, $ini);
+	}
 	/**
-	 * renvoie la valeur demandé grâce une chaine de paramètres
+	 * Renvoie la valeur demandée grâce une chaîne de paramètres
 	 * @param string $param la chaine de paramètres
 	 * @param array $config le tableau de paramètre
 	 * @return string la valeur de la chaine demandée
 			self::$instance = new Config();
+		}
+	}
 	/**
-	 * analyse un tableau de paramètres
+	 * Analyse un tableau de paramètres.
 	 * @param array $config le tableau de paramètres
 	 * @return array le tableau analysé
 	 */
 	private static function analyserTableauIni($config = array()) {
+		}
 		return $config;
+	}
 	/**
-	 * dans le cas des chaine de configuration à sous clé (ex.: cle.souscle)
+	 * Dans le cas des chaine de configuration à sous clé (ex.: cle.souscle)
-	 * evalue les valeurs correspondantes et crée les sous tableaux associés
+	 * évalue les valeurs correspondantes et crée les sous tableaux associés.
 	 * @param array $config tableau de configuration (par référence)
 	 * @param string $cle la cle dans le tableau
 	 * @param string $valeur la valeur à affecter
 	 */
+		}
 		return $config;
+	}
 	/**
-	 * Evalue les valeurs de références à une clé dans le tableau config (cas du ref:cle)
+	 * Évalue les valeurs de références à une clé dans le tableau config (cas du ref:cle).
 	 * @param array $config tableau de configuration
 	 * @param string $cle la clé dont il faut évaluer les références
 	 */
 	private static function evaluerReferences(&$config, $cle) {
+			}
+		}
+	}
 	/**
-	 * Evalue le code php contenu dans un clé tu tableau config
+	 * Évalue le code php contenu dans un clé tu tableau config.
 	 * @param array $config tableau de configuration (par référence)
 	 * @param string $cle le clé du tableau dont il faut évaluer la valeur
 	 */
 	private static function evaluerPhp(&$config, $cle) {
 		if (preg_match('/^php:(.+)$/', $config[$cle], $correspondances)) {
 			eval('$config["'.$cle.'"] = '.$correspondances[1].';');
+		}
+	}
 	/**
-	 * Charge un fichier ini dans le tableau des paramètres de l'appli
+	 * Charge un fichier ini dans le tableau des paramètres de l'appli.
 	 * @param string $fichier_ini le nom du fichier à charger
 	 * @return array le fichier ini parsé
 	 */
 	public static function charger($fichier_ini) {
 		self::verifierCreationInstance();
 		return self::parserFichierIni($fichier_ini);
 	}
 	/**
-	 * Acesseur pour la valeur d'un paramètre
+	 * Accesseur pour la valeur d'un paramètre.
 	 * @param string $param le nom du paramètre
 	 * @return string la valeur du paramètre
 	 */
 	public static function get($param = null) {
 		self::verifierCreationInstance();
 		return self::getValeur($param, self::$parametres);
+	}
 	/**
-	 * Vérifie si la valeur d'un paramètre existe
+	 * Vérifie si la valeur d'un paramètre existe.
 	 * @param string $param le nom du paramètre
 	 * @return boolean vrai si le paramètre existe, false sinon
 	 */
+	public static function existe($param) {
+		self::verifierCreationInstance();
+		return self::existeValeur($param, self::$parametres);
+	}
+	/**
+	 * Vérifie que tous les paramêtres de config nécessaires au fonctionnement d'une classe existe dans les fichiers
+	 * de configurations.
+	 * L'utilisation de cette méthode depuis la classe Config évite de faire appel à une classe supplémentaire.
+	 *
+	 * @param array $parametres tableau des noms des paramètres de la config à verifier.
+	 * @return boolean true si tous les paramétres sont présents sinon false.
+	 */
+	public static function verifierPresenceParametres(Array $parametres) {
+		$ok = true;
+		foreach ($parametres as $param) {
+			if (is_null(self::get($param))) {
+				$classe = get_class();
+				$m = "L'utilisation de la classe $classe nécessite de définir '$param' dans un fichier de configuration.";
+				trigger_error($m, E_USER_ERROR);
+				$ok = false;
 	public static function existe($param) {
 		self::verifierCreationInstance();
-		return self::existeValeur($param, self::$parametres);
+		return $ok;

Subversion Repositories Applications.framework

(root)/trunk/framework/Config.php – Rev 239 → 241