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 142 2010-03-02 12:59:30Z 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 135 → 142

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