Subversion Repositories Applications.framework

Rev

Rev 230 | Rev 241 | Go to most recent revision | Only display areas with differences | Regard whitespace | Details | Blame | Last modification | View Log | RSS feed

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