Subversion Repositories Applications.framework

Rev

Go to most recent revision | Details | Last modification | View Log | RSS feed

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