Subversion Repositories Applications.framework

Rev

Rev 389 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
95 jpm 1 
<?php
96 jpm 2 
// declare(encoding='UTF-8');
3 
/**
389 jpm 4 
 * Classe de base du Framework :
5 
 *  - fournissant des infos sur l'application,
221 jpm 6 
 *  - paramétrant l'environnement de l'appli et du framework,
7 
 *  - réalisant des traitements sur les variables globales ($_GET, $_POST, $_COOKIE...)
389 jpm 8 
 *
221 jpm 9 
 * Cette classe contient la fonction de chargement automatique de classes.
389 jpm 10 
 * Ce fichier doit toujours rester à la racine du framework car il initialise le chemin
221 jpm 11 
 * de l'application en se basant sur son propre emplacement.
129 aurelien 12 
 *
186 jpm 13 
 * @category	PHP 5.2
221 jpm 14 
 * @package	Framework
186 jpm 15 
 * @author		Jean-Pascal MILCENT <jpm@tela-botanica.org>
241 jpm 16 
 * @copyright	Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)
221 jpm 17 
 * @license	http://www.gnu.org/licenses/gpl.html Licence GNU-GPL-v3
18 
 * @license	http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL-v2
232 jpm 19 
 * @version	$Id: Framework.php 391 2011-11-09 16:55:53Z jpm $
20 
 * @since		0.3
186 jpm 21 
 * @link		/doc/framework/
129 aurelien 22 
 */
221 jpm 23 
class Framework {
96 jpm 24 
 
206 aurelien 25 
	/** Variable statique indiquant que les tableaux _GET et _POST ont déjà été encodé au format de l'appli. */
26 
	private static $encodage = false;
389 jpm 27 
 
221 jpm 28 
	/** Tableau d'informations sur l'application */
96 jpm 29 
	private static $info = null;
389 jpm 30 
 
221 jpm 31 
	/** Chemin de base de l'application */
95 jpm 32 
	private static $chemin = null;
96 jpm 33 
 
241 jpm 34 
	/** Tableau des noms des paramètres à définir dans le fichier de config car obligatoirement nécessaire à cette classe.*/
389 jpm 35 
	private static $parametres_obligatoires = array('chemin_controleurs', 'chemin_modeles', 'chemin_bibliotheque',
274 jpm 36 
		'url_arg_separateur_entree', 'url_arg_separateur_sortie',
37 
		'encodage_sortie', 'encodage_appli');
389 jpm 38 
 
129 aurelien 39 
	/**
389 jpm 40 
	 * Initialise l'environnement nécessaire au Framework : constantes globales, méthodeles autoload, séparateur d'arguments
221 jpm 41 
	 * d'url.
42 
	 * Cette méthode est appelée automatiquement suite à la définition du chemin de l'application via Application::setChemin().
43 
	 */
44 
	private static function initialiserEnvironnement() {
45 
		self::enregistrerMethodesAutoload();
46 
		self::initialiserUrl();
47 
	}
389 jpm 48 
 
221 jpm 49 
	/**
186 jpm 50 
	 * Initialise différentes classes du Framework nécessaires pour le fonctionnement de l'application.
51 
	 * Ces classes sont ensuites controlées via les fichiers de config.ini.
52 
	 * Elle est appelée automatiquement suite à la définition du chemin de l'application via Application::setChemin().
53 
	 */
221 jpm 54 
	private static function initialiserFramework() {
189 jpm 55 
		GestionnaireException::configurer();
389 jpm 56 
		//Log::configurer();
206 aurelien 57 
		self::verifierEtReencoderTableauRequete();
186 jpm 58 
	}
389 jpm 59 
 
186 jpm 60 
	/**
221 jpm 61 
	 * Redéfinit des constantes globales utiles pour le Framework et les applis.
62 
	 */
63 
	private static function definirConstantesGlobales() {
64 
		if (!defined('DS')) {
391 jpm 65 
			/** Redéfinition de la constante DIRECTORY_SEPARATOR en version abrégée DS */
221 jpm 66 
			define('DS', DIRECTORY_SEPARATOR);
67 
		}
68 
		if (!defined('PS')) {
391 jpm 69 
			/** Redéfinition de la constante PATH_SEPARATOR en version abrégée PS */
221 jpm 70 
			define('PS', PATH_SEPARATOR);
71 
		}
72 
	}
389 jpm 73 
 
74 
	private static function definirCheminAppli($chemin) {
75 
		if (is_file($chemin)) {
76 
			self::$chemin = dirname($chemin).DS;
77 
		} else if (is_dir($chemin)) {
78 
			self::$chemin = $chemin;
79 
		} else {
80 
			throw new Exception("Le chemin indiqué '$chemin' n'est ni un fichier ni un dossier.");
81 
		}
82 
	}
83 
 
221 jpm 84 
	private static function enregistrerMethodesAutoload() {
85 
		spl_autoload_register(array(get_class(), 'autoloadFw'));
389 jpm 86 
 
241 jpm 87 
		// Vérification des paramètres de configuration obligatoire pour assurer le fonctionnement du Framework
88 
		Config::verifierPresenceParametres(self::$parametres_obligatoires);
389 jpm 89 
 
221 jpm 90 
		// Initialisation du gestionnaire d'erreur avant toute chose
91 
		GestionnaireException::initialiser();
389 jpm 92 
 
221 jpm 93 
		spl_autoload_register(array(get_class(), 'autoloadAppliDefaut'));
389 jpm 94 
 
221 jpm 95 
		// Autoload défini par l'application
96 
		if (function_exists('__autoload')) {
97 
			spl_autoload_register('__autoload');
98 
		}
99 
	}
389 jpm 100 
 
221 jpm 101 
	/**
102 
	 * Autoload pour le Framework.
103 
	 */
104 
	private static function autoloadFw($nom_classe_fw) {
105 
		$dossiers_classes = array(	dirname(__FILE__).DS,
106 
									dirname(__FILE__).DS.'utilitaires'.DS);
107 
		foreach ($dossiers_classes as $chemin) {
108 
			$fichier_a_tester = $chemin.$nom_classe_fw.'.php';
109 
			if (file_exists($fichier_a_tester)) {
110 
				include_once $fichier_a_tester;
111 
				return null;
112 
			}
113 
		}
114 
	}
389 jpm 115 
 
221 jpm 116 
	/**
117 
	 * Autoload par défaut pour l'application
118 
	 */
119 
	private static function autoloadAppliDefaut($nom_classe) {
120 
		$dossiers_classes = array(	Config::get('chemin_controleurs'),
121 
									Config::get('chemin_modeles'),
122 
									Config::get('chemin_bibliotheque'));
389 jpm 123 
 
221 jpm 124 
		foreach ($dossiers_classes as $chemin) {
125 
			$fichier_a_tester = $chemin.$nom_classe.'.php';
126 
			if (file_exists($fichier_a_tester)) {
127 
				include_once $fichier_a_tester;
128 
				return null;
129 
			}
130 
		}
131 
	}
389 jpm 132 
 
221 jpm 133 
	/**
199 jpm 134 
	 * Initialise le format des urls.
135 
	 */
136 
	private static function initialiserUrl() {
274 jpm 137 
		ini_set('arg_separator.input', Config::get('furl_arg_separateur_entree'));
138 
		ini_set('arg_separator.output', Config::get('url_arg_separateur_sortie'));
199 jpm 139 
	}
389 jpm 140 
 
199 jpm 141 
	/**
186 jpm 142 
	 * Permet d'indiquer le chemin de base de l'Application.
143 
	 * Cette méthode doit obligatoirement être utilisée par l'application pour que le Framework fonctionne correctement.
129 aurelien 144 
	 * @param string $chemin_fichier_principal chemin de base
145 
	 */
221 jpm 146 
	public static function setCheminAppli($chemin_fichier_principal) {
95 jpm 147 
		if (self::$chemin === null) {
148 
			if (!file_exists($chemin_fichier_principal)) {
221 jpm 149 
				trigger_error("Le fichier indiqué n'existe pas. Utilisez __FILE__ dans la méthode setCheminAppli().", E_USER_ERROR);
95 jpm 150 
			} else {
268 jpm 151 
				self::definirConstantesGlobales();
389 jpm 152 
				self::definirCheminAppli($chemin_fichier_principal);
221 jpm 153 
				self::initialiserEnvironnement();
154 
				self::initialiserFramework();
95 jpm 155 
			}
156 
		} else {
98 jpm 157 
			trigger_error("Le chemin de l'application a déjà été enregistré auprès du Framework", E_USER_WARNING);
95 jpm 158 
		}
159 
	}
160 
 
129 aurelien 161 
	/**
162 
	 * accesseur pour le chemin
163 
	 * @return string le chemin
164 
	 */
221 jpm 165 
	public static function getCheminAppli() {
95 jpm 166 
		return self::$chemin;
167 
	}
96 jpm 168 
 
98 jpm 169 
	/** Le tableau des informations sur l'application possède les clés suivantes :
170 
	 * - nom : nom de l'application
171 
	 * - abr : abréviation de l'application
172 
	 * - encodage : encodage de l'application (ISO-8859-15, UTF-8...)
173 
	 *
174 
	 * @param array $info tableau fournissant des informations sur l'application
175 
	 * @return void
176 
	 */
221 jpm 177 
	public static function setInfoAppli($info) {
98 jpm 178 
		if (self::$info === null) {
179 
			self::$info = $info;
180 
		} else {
181 
			trigger_error("Le informations de l'application ont déjà été enregistrées auprès du Framework", E_USER_WARNING);
182 
		}
183 
	}
184 
 
129 aurelien 185 
	/**
221 jpm 186 
	 * Accesseur pour le tableau d'infos sur l'application.
129 aurelien 187 
	 * @param string $cle la clé à laquelle on veut accéder
188 
	 */
221 jpm 189 
	public static function getInfoAppli($cle = null) {
96 jpm 190 
		if ($cle !== null) {
191 
			if (isset(self::$info[$cle])) {
192 
				return self::$info[$cle];
193 
			}
194 
		} else {
195 
			return self::$info;
196 
		}
95 jpm 197 
	}
389 jpm 198 
 
221 jpm 199 
	/**
206 aurelien 200 
	 * Procédure vérifiant l'encodage des tableaux $_GET et $_POST et les transcodant dans l'encodage de l'application
201 
	 */
202 
	protected static function verifierEtReencoderTableauRequete() {
274 jpm 203 
		if (self::$encodage == false && Config::get('encodage_sortie') != Config::get('encodage_appli')) {
204 
			$_POST = self::encoderTableau($_POST, Config::get('encodage_appli'), Config::get('encodage_sortie'));
205 
			$_GET = self::encoderTableau($_GET, Config::get('encodage_appli'), Config::get('encodage_sortie'));
389 jpm 206 
 
221 jpm 207 
			// Traitement des magic quotes
206 aurelien 208 
			self::verifierEtTraiterSlashTableauRequete();
389 jpm 209 
 
206 aurelien 210 
			self::$encodage = true;
211 
		}
212 
	}
389 jpm 213 
 
206 aurelien 214 
	/**
215 
	 * Procédure vérifiant l'activation des magic quotes et remplacant les slash dans les tableaux de requete
216 
	 */
217 
	private static function verifierEtTraiterSlashTableauRequete() {
221 jpm 218 
		if (get_magic_quotes_gpc()) {
219 
			if (!function_exists('nettoyerSlashProfond')) {
220 
				function nettoyerSlashProfond($valeur) {
221 
					return ( is_array($valeur) ) ? array_map('nettoyerSlashProfond', $valeur) : stripslashes($valeur);
222 
				}
206 aurelien 223 
			}
221 jpm 224 
			$_GET = array_map('nettoyerSlashProfond', $_GET);
225 
			$_POST = array_map('nettoyerSlashProfond', $_POST);
226 
			$_COOKIE = array_map('nettoyerSlashProfond', $_COOKIE);
206 aurelien 227 
		}
228 
	}
229 
 
230 
	/**
231 
	 * Fonction récursive transcodant toutes les valeurs d'un tableau de leur encodage d'entrée vers un encodage de sortie donné
232 
	 * @param $tableau Array Un tableau de données à encoder
233 
	 * @param $encodage_sortie String l'encodage vers lequel on doit transcoder
234 
	 * @param $encodage_entree String l'encodage original des chaines du tableau (optionnel)
235 
	 * @return Array Le tableau encodé dans l'encodage de sortie
236 
	 *
237 
	 */
238 
	final static protected function encoderTableau($tableau, $encodage_sortie, $encodage_entree = null) {
239 
		if (is_array($tableau)) {
240 
			foreach ($tableau as $cle => $valeur) {
241 
				if (is_array($valeur)) {
242 
				 	$tableau[$cle] = self::encoderTableau($valeur, $encodage_sortie, $encodage_entree);
243 
				} else {
244 
					$tableau[$cle] = mb_convert_encoding($valeur, $encodage_sortie, $encodage_entree);
245 
				}
246 
			}
247 
		}
248 
		return $tableau;
249 
	}
208 gduche 250 
}
230 jpm 251 
?>