WebSVN – Applications.framework – Diff – /branches/v0.3-aleaume/framework/GestionnaireException.php


<?php
// declare(encoding='UTF-8');
/**
 * Classe de gestion des exceptions.
 * C'est un Singleton.
 *
 * PHP Version 5
 *
 * @category  Class
 * @package   Framework
 * @author	aurelien <aurelien@tela-botanica.org>
 * @copyright 2009 Tela-Botanica
 * @license   http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL
 * @license   http://www.gnu.org/licenses/gpl.html Licence GNU-GPL
 * @version   SVN: $$Id: GestionnaireException.php 158 2010-03-04 17:14:36Z jpm $$
 * @link	  /doc/framework/
 *
 */
class GestionnaireException {
 
	/**
	 * Liste des exceptions enregistrées
	 */
	private static $exceptions = array();
 
	/**
	 * Détermine si l'on affiche ou non le contexte
	 */
	private static $contexte = false;
 
 
 
 
 
 
	 /**
	 * Détermine si l'on loggue ou non les erreurs
	 */
	private static $logger = false;
 
	/**
	 * Definit si php est lancé en ligne de commande ou en mode serveur
	 */
	private static $mode = php_sapi_name ;
 
	/**
	 * le gestionnaire d'exception est un singleton
	 * et possède donc un "pointeur statique sur lui-même"
	 */
	private static $gestionnaireException;
 
	/**
	 * Constructeur avec paramètres optionnel
	 * @param bool indique si l'on veut afficher ou non le contexte des exceptions (i.e. la trace)
	 */
	public function __construct() {
		self::$exceptions = array();
		self::$contexte = Config::get('fw_debogage_contexte');
		self::$logger = Config::get('fw_log_debogage');
 
		self::$mode = php_sapi_name();
 
		set_exception_handler(array(get_class($this),'gererException'));
		set_error_handler(array(get_class($this),'gererErreur'));
	}
 
	/**
	 * Renvoie le booleen définissant si l'on affiche le contexte ou non
	 */
	public static function getContexte() {
		return self::$contexte;
	}
 
	/**
	 * Definit si l'on veut afficher le contexte ou non
	 * @param bool true si on veut afficher le contexte, false sinon, par défaut vaut false
	 */
	public function setContexte($contexte) {
		self::$contexte = $contexte;
	}
 
	 /** Fonction d'accès au singleton
	 * @return GestionnaireErreur le gestionnaire d'exceptions courant
	 */
	public static function getInstance() {
		if (self::$gestionnaireException instanceof GestionnaireException) {
			return self::$gestionnaireException;
		}
		self::$gestionnaireException = new GestionnaireException;
 
		return self::$gestionnaireException;
	}
 
	/**
	 * Fonction de gestion des exceptions, remplace le handler par défaut
	 * @param Exception $e l'exception à traiter
	 */
	public static function gererException(Exception $e) {
		// pour le moment on se contente de l'ajouter au tableau et de les afficher
		self::$exceptions[] = $e;
 
		// si on doit logger on envoie l'exception au loggeur
		if (self::$logger) {
			self::loggerException($e);
		}
	}
 
	/**
	 * Gère les erreurs en les convertissant en exceptions (remplace la fonction gestion d'erreurs native de php)
	 * @param int $niveau le niveau de l'erreur
	 * @param string $message le message associé à l'erreur
	 * @param string $fichier le nom du fichier où l'erreur s'est produite
	 * @param int $ligne la ligne où l'erreur s'est produite
	 * @param string $contexte le contexte associé à l'erreur
	 */
	public static function gererErreur($niveau,  $message,  $fichier,  $ligne,  $contexte){
		// si aucun rapport d'erreur, on sort directement
		if (error_reporting() == 0) {
			return;
		}
 
		// sinon on crée une exception
		$e = new ErrorException($message, 0, $niveau, $fichier, $ligne);
		// que l'on donne au tableau d'exceptions
		self::$exceptions[] = $e;
		// on la logge si nécéssaire
		if (self::$logger) {
			self::loggerException($e);
		}
		return;
	}
 
	/**
	 * Renvoie les exceptions au format (X)HTML
	 * ou bien au format texte suivant le mode d'utilisation de PHP
	 */
	public static function getExceptions() {
		$retour = '';
		foreach (self::$exceptions as $cle => $e) {
			switch (self::$mode) {
				case 'cli' :
					$retour .= $e->getMessage()."\n";
					$retour .= 'Fichier : '.$e->getFile()."\n";
					$retour .= 'Ligne : '.$e->getLine()."\n";
					if (self::getContexte()) {
						$retour .= 'Contexte : '."\n".print_r($e->getTraceAsString(), true)."\n";
					}
					break;
				default:
					$retour .= '<pre class="debogage">'."\n";
					$retour .= $e->getMessage()."\n";
					$retour .= '<span class="debogage_fichier">'.'Fichier : '.$e->getFile().'</span>'."\n";
					$retour .= '<span class="debogage_ligne">'.'Ligne : '.$e->getLine().'</span>'."\n";
					$retour .= '</pre>'."\n";
 
					if (self::getContexte()) {
						$retour .= '<pre>'."\n";
						$retour .= '<strong>Contexte : </strong>'."\n".print_r($e->getTraceAsString(), true)."\n";
						$retour .= '</pre>'."\n";
					}
			}
			// Nous vidons le tableau des exceptions au fur et à mesure
			unset(self::$exceptions[$cle]);
		}
		return $retour;
	}
 
	/**
	 * logge une exception donnée sous une forme lisible
	 * @param Exception	$e l'exception à logger
	 */
	private static function loggerException($e) {
		$erreur = '';
		$erreur .= $e->getMessage()."\n";
		$erreur .= 'Fichier : '.$e->getFile()."\n";
		$erreur .= 'Ligne : '.$e->getLine()."\n";
		if (self::getContexte()) {
			$erreur .= 'Contexte : '."\n".print_r($e->getTraceAsString(), true)."\n";
		}
		$erreur .= "\n";
		Log::ajouterEntree('erreurs',$erreur);
	}
 
	public function __destruct() {
		// Si des erreurs n'ont pas été affichée nous forçons leur affichage
		if (count(self::$exceptions) > 0) {
			echo self::getExceptions();
		}
	}
 
}
?>

Subversion Repositories Applications.framework

(root)/branches/v0.3-aleaume/framework/GestionnaireException.php @ 399 – Rev 157 → 158

Rev 157		Rev 158
1	`<?php`	1	`<?php`
2	`// declare(encoding='UTF-8');`	2	`// declare(encoding='UTF-8');`
3	`/**`	3	`/**`
4	`* Classe de gestion des exceptions.`	4	`* Classe de gestion des exceptions.`
5	`* C'est un Singleton.`	5	`* C'est un Singleton.`
6	`*`	6	`*`
7	`* PHP Version 5`	7	`* PHP Version 5`
8	`*`	8	`*`
9	`* @category Class`	9	`* @category Class`
10	`* @package Framework`	10	`* @package Framework`
11	`* @author aurelien <aurelien@tela-botanica.org>`	11	`* @author aurelien <aurelien@tela-botanica.org>`
12	`* @copyright 2009 Tela-Botanica`	12	`* @copyright 2009 Tela-Botanica`
13	`* @license http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL`	13	`* @license http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL`
14	`* @license http://www.gnu.org/licenses/gpl.html Licence GNU-GPL`	14	`* @license http://www.gnu.org/licenses/gpl.html Licence GNU-GPL`
15	`* @version SVN: $$Id: GestionnaireException.php 157 2010-03-04 14:24:54Z aurelien $$`	15	`* @version SVN: $$Id: GestionnaireException.php 158 2010-03-04 17:14:36Z jpm $$`
16	`* @link /doc/framework/`	16	`* @link /doc/framework/`
17	`*`	17	`*`
18	`*/`	18	`*/`
19	`class GestionnaireException {`	19	`class GestionnaireException {`
20		20
21	`/**`	21	`/**`
22	`* Liste des exceptions enregistrées`	22	`* Liste des exceptions enregistrées`
23	`*/`	23	`*/`
24	`private static $exceptions = array();`	24	`private static $exceptions = array();`
25		25
26	`/**`	26	`/**`
27	`* Détermine si l'on affiche ou non le contexte`	27	`* Détermine si l'on affiche ou non le contexte`
28	`*/`	28	`*/`
29	`private static $contexte = false;`	29	`private static $contexte = false;`
30		-
31	`/**`	-
32	`* Détermine si l'on affiche ou non les erreur`	-
33	`*/`	-
34	`private static $afficher = false;`	-
35		30
36	`/**`	31	`/**`
37	`* Détermine si l'on loggue ou non les erreurs`	32	`* Détermine si l'on loggue ou non les erreurs`
38	`*/`	33	`*/`
39	`private static $logger = false;`	34	`private static $logger = false;`
40		35
41	`/**`	36	`/**`
42	`* Definit si php est lancé en ligne de commande ou en mode serveur`	37	`* Definit si php est lancé en ligne de commande ou en mode serveur`
43	`*/`	38	`*/`
44	`private static $mode = php_sapi_name ;`	39	`private static $mode = php_sapi_name ;`
45		40
46	`/**`	41	`/**`
47	`* le gestionnaire d'exception est un singleton`	42	`* le gestionnaire d'exception est un singleton`
48	`* et possède donc un "pointeur statique sur lui-même"`	43	`* et possède donc un "pointeur statique sur lui-même"`
49	`*/`	44	`*/`
50	`private static $gestionnaireException;`	45	`private static $gestionnaireException;`
51		46
52	`/**`	47	`/**`
53	`* Constructeur avec paramètres optionnel`	48	`* Constructeur avec paramètres optionnel`
54	`* @param bool indique si l'on veut afficher ou non le contexte des exceptions (i.e. la trace)`	49	`* @param bool indique si l'on veut afficher ou non le contexte des exceptions (i.e. la trace)`
55	`*/`	50	`*/`
56	`public function __construct() {`	51	`public function __construct() {`
57	`self::$exceptions = array();`	52	`self::$exceptions = array();`
58	`self::$contexte = Config::get('fw_debogage_contexte');`	53	`self::$contexte = Config::get('fw_debogage_contexte');`
59	`self::$logger = Config::get('fw_log_debogage');`	54	`self::$logger = Config::get('fw_log_debogage');`
60	`self::$afficher = Config::get('fw_debogage');`	-
61	`self::$mode = php_sapi_name();`	55	`self::$mode = php_sapi_name();`
62		56
63	`set_exception_handler(array(get_class($this),'gererException'));`	57	`set_exception_handler(array(get_class($this),'gererException'));`
64	`set_error_handler(array(get_class($this),'gererErreur'));`	58	`set_error_handler(array(get_class($this),'gererErreur'));`
65	`}`	59	`}`
66		60
67	`/**`	61	`/**`
68	`* Renvoie le booleen définissant si l'on affiche le contexte ou non`	62	`* Renvoie le booleen définissant si l'on affiche le contexte ou non`
69	`*/`	63	`*/`
70	`public static function getContexte() {`	64	`public static function getContexte() {`
71	`return self::$contexte;`	65	`return self::$contexte;`
72	`}`	66	`}`
73		67
74	`/**`	68	`/**`
75	`* Definit si l'on veut afficher le contexte ou non`	69	`* Definit si l'on veut afficher le contexte ou non`
76	`* @param bool true si on veut afficher le contexte, false sinon, par défaut vaut false`	70	`* @param bool true si on veut afficher le contexte, false sinon, par défaut vaut false`
77	`*/`	71	`*/`
78	`public function setContexte($contexte) {`	72	`public function setContexte($contexte) {`
79	`self::$contexte = $contexte;`	73	`self::$contexte = $contexte;`
80	`}`	74	`}`
81		75
82	`/** Fonction d'accès au singleton`	76	`/** Fonction d'accès au singleton`
83	`* @return GestionnaireErreur le gestionnaire d'exceptions courant`	77	`* @return GestionnaireErreur le gestionnaire d'exceptions courant`
84	`*/`	78	`*/`
85	`public static function getInstance() {`	79	`public static function getInstance() {`
86	`if (self::$gestionnaireException instanceof GestionnaireException) {`	80	`if (self::$gestionnaireException instanceof GestionnaireException) {`
87	`return self::$gestionnaireException;`	81	`return self::$gestionnaireException;`
88	`}`	82	`}`
89	`self::$gestionnaireException = new GestionnaireException;`	83	`self::$gestionnaireException = new GestionnaireException;`
90		84
91	`return self::$gestionnaireException;`	85	`return self::$gestionnaireException;`
92	`}`	86	`}`
93		87
94	`/**`	88	`/**`
95	`* Fonction de gestion des exceptions, remplace le handler par défaut`	89	`* Fonction de gestion des exceptions, remplace le handler par défaut`
96	`* @param Exception $e l'exception à traiter`	90	`* @param Exception $e l'exception à traiter`
97	`*/`	91	`*/`
98	`public static function gererException(Exception $e) {`	92	`public static function gererException(Exception $e) {`
99	`// pour le moment on se contente de l'ajouter au tableau et de les afficher`	93	`// pour le moment on se contente de l'ajouter au tableau et de les afficher`
100	`self::$exceptions[] = $e;`	94	`self::$exceptions[] = $e;`
101		95
102	`// si on doit logger on envoie l'exception au loggeur`	96	`// si on doit logger on envoie l'exception au loggeur`
103	`if (self::$logger) {`	97	`if (self::$logger) {`
104	`self::loggerException($e);`	98	`self::loggerException($e);`
105	`}`	99	`}`
106	`}`	100	`}`
107		101
108	`/**`	102	`/**`
109	`* Gère les erreurs en les convertissant en exceptions (remplace la fonction gestion d'erreurs native de php)`	103	`* Gère les erreurs en les convertissant en exceptions (remplace la fonction gestion d'erreurs native de php)`
110	`* @param int $niveau le niveau de l'erreur`	104	`* @param int $niveau le niveau de l'erreur`
111	`* @param string $message le message associé à l'erreur`	105	`* @param string $message le message associé à l'erreur`
112	`* @param string $fichier le nom du fichier où l'erreur s'est produite`	106	`* @param string $fichier le nom du fichier où l'erreur s'est produite`
113	`* @param int $ligne la ligne où l'erreur s'est produite`	107	`* @param int $ligne la ligne où l'erreur s'est produite`
114	`* @param string $contexte le contexte associé à l'erreur`	108	`* @param string $contexte le contexte associé à l'erreur`
115	`*/`	109	`*/`
116	`public static function gererErreur($niveau, $message, $fichier, $ligne, $contexte){`	110	`public static function gererErreur($niveau, $message, $fichier, $ligne, $contexte){`
117	`// si aucun rapport d'erreur, on sort directement`	111	`// si aucun rapport d'erreur, on sort directement`
118	`if (error_reporting() == 0) {`	112	`if (error_reporting() == 0) {`
119	`return;`	113	`return;`
120	`}`	114	`}`
121		115
122	`// sinon on crée une exception`	116	`// sinon on crée une exception`
123	`$e = new ErrorException($message, 0, $niveau, $fichier, $ligne);`	117	`$e = new ErrorException($message, 0, $niveau, $fichier, $ligne);`
124	`// que l'on donne au tableau d'exceptions`	118	`// que l'on donne au tableau d'exceptions`
125	`self::$exceptions[] = $e;`	119	`self::$exceptions[] = $e;`
126	`// on la logge si nécéssaire`	120	`// on la logge si nécéssaire`
127	`if (self::$logger) {`	121	`if (self::$logger) {`
128	`self::loggerException($e);`	122	`self::loggerException($e);`
129	`}`	123	`}`
130	`return;`	124	`return;`
131	`}`	125	`}`
132		126
133	`/**`	127	`/**`
134	`* Renvoie les exceptions au format (X)HTML`	128	`* Renvoie les exceptions au format (X)HTML`
135	`* ou bien au format texte suivant le mode d'utilisation de PHP`	129	`* ou bien au format texte suivant le mode d'utilisation de PHP`
136	`*/`	130	`*/`
137	`public static function getExceptions() {`	131	`public static function getExceptions() {`
138	`$retour = '';`	132	`$retour = '';`
139	`foreach (self::$exceptions as $cle => $e) {`	133	`foreach (self::$exceptions as $cle => $e) {`
140	`switch (self::$mode) {`	134	`switch (self::$mode) {`
141	`case 'cli' :`	135	`case 'cli' :`
142	`$retour .= $e->getMessage()."\n";`	136	`$retour .= $e->getMessage()."\n";`
143	`$retour .= 'Fichier : '.$e->getFile()."\n";`	137	`$retour .= 'Fichier : '.$e->getFile()."\n";`
144	`$retour .= 'Ligne : '.$e->getLine()."\n";`	138	`$retour .= 'Ligne : '.$e->getLine()."\n";`
145	`if (self::getContexte()) {`	139	`if (self::getContexte()) {`
146	`$retour .= 'Contexte : '."\n".print_r($e->getTraceAsString(), true)."\n";`	140	`$retour .= 'Contexte : '."\n".print_r($e->getTraceAsString(), true)."\n";`
147	`}`	141	`}`
148	`break;`	142	`break;`
149	`default:`	143	`default:`
150	`$retour .= '<pre class="debogage">'."\n";`	144	`$retour .= '<pre class="debogage">'."\n";`
151	`$retour .= $e->getMessage()."\n";`	145	`$retour .= $e->getMessage()."\n";`
152	`$retour .= '<span class="debogage_fichier">'.'Fichier : '.$e->getFile().'</span>'."\n";`	146	`$retour .= '<span class="debogage_fichier">'.'Fichier : '.$e->getFile().'</span>'."\n";`
153	`$retour .= '<span class="debogage_ligne">'.'Ligne : '.$e->getLine().'</span>'."\n";`	147	`$retour .= '<span class="debogage_ligne">'.'Ligne : '.$e->getLine().'</span>'."\n";`
154	`$retour .= '</pre>'."\n";`	148	`$retour .= '</pre>'."\n";`
155		149
156	`if (self::getContexte()) {`	150	`if (self::getContexte()) {`
157	`$retour .= '<pre>'."\n";`	151	`$retour .= '<pre>'."\n";`
158	`$retour .= '<strong>Contexte : </strong>'."\n".print_r($e->getTraceAsString(), true)."\n";`	152	`$retour .= '<strong>Contexte : </strong>'."\n".print_r($e->getTraceAsString(), true)."\n";`
159	`$retour .= '</pre>'."\n";`	153	`$retour .= '</pre>'."\n";`
160	`}`	154	`}`
161	`}`	155	`}`
162	`// Nous vidons le tableau des exceptions au fur et à mesure`	156	`// Nous vidons le tableau des exceptions au fur et à mesure`
163	`unset(self::$exceptions[$cle]);`	157	`unset(self::$exceptions[$cle]);`
164	`}`	158	`}`
165	`return $retour;`	159	`return $retour;`
166	`}`	160	`}`
167		161
168	`/**`	162	`/**`
169	`* logge une exception donnée sous une forme lisible`	163	`* logge une exception donnée sous une forme lisible`
170	`* @param Exception $e l'exception à logger`	164	`* @param Exception $e l'exception à logger`
171	`*/`	165	`*/`
172	`private static function loggerException($e) {`	166	`private static function loggerException($e) {`
173	`$erreur = '';`	167	`$erreur = '';`
174	`$erreur .= $e->getMessage()."\n";`	168	`$erreur .= $e->getMessage()."\n";`
175	`$erreur .= 'Fichier : '.$e->getFile()."\n";`	169	`$erreur .= 'Fichier : '.$e->getFile()."\n";`
176	`$erreur .= 'Ligne : '.$e->getLine()."\n";`	170	`$erreur .= 'Ligne : '.$e->getLine()."\n";`
177	`if (self::getContexte()) {`	171	`if (self::getContexte()) {`
178	`$erreur .= 'Contexte : '."\n".print_r($e->getTraceAsString(), true)."\n";`	172	`$erreur .= 'Contexte : '."\n".print_r($e->getTraceAsString(), true)."\n";`
179	`}`	173	`}`
180	`$erreur .= "\n";`	174	`$erreur .= "\n";`
181	`Log::ajouterEntree('erreurs',$erreur);`	175	`Log::ajouterEntree('erreurs',$erreur);`
182	`}`	176	`}`
183		177
184	`public function __destruct() {`	178	`public function __destruct() {`
185	`// Si des erreurs n'ont pas été affichée nous forçons leur affichage`	179	`// Si des erreurs n'ont pas été affichée nous forçons leur affichage`
186	`if (self::$afficher && count(self::$exceptions) > 0) {`	180	`if (count(self::$exceptions) > 0) {`
187	`echo self::getExceptions();`	181	`echo self::getExceptions();`
188	`}`	182	`}`
189	`}`	183	`}`
190		184
191	`}`	185	`}`
192	`?>`	186	`?>`