Subversion Repositories Applications.framework

Rev

Rev 232 | Rev 268 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

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