WebSVN – Applications.framework – Diff – /trunk/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 216 2010-11-10 11:29:59Z jpm $$
 * @link	  /doc/framework/
 *
 */
class GestionnaireException {
	
	const MODE_CLI = 'cli';
	
	/** 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;
 
	/** Détermine si l'affichage des erreurs est forcé (true) ou pas (false) à la destruction de la classe */
	private static $afficher = false;
 
	/** Definit si php est lancé en ligne de commande ou en mode serveur */
	private static $mode = null ;
 
	/** Initialise le Gestionnaire d'exceptions et d'erreur sans tenir comptes des paramêtres de config. */
	public static function initialiser() {
		self::$mode = php_sapi_name();
		// Désactivation des balises HTML dans les messages d'erreur de PHP en mode ligne de commande
		if (self::$mode == self::MODE_CLI) {
			ini_set('html_errors', 0);
		} 
		
		set_exception_handler(array(get_class(),'gererException'));
		set_error_handler(array(get_class(),'gererErreur'));
	}
	
	/** Configure le Gestionnaire d'exceptions et d'erreur à partir des paramêtres de config. */
	public static function configurer() {
		self::$contexte = Config::get('fw_debogage_contexte');
		self::$logger = Config::get('fw_log_debogage');
		self::$afficher = Config::get('fw_debogage');
	}
	
	/** 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 static function setContexte($contexte) {
		self::$contexte = $contexte;
	}
 
	/**
	 * Fonction de gestion des exceptions, remplace le handler par défaut.
	 * Si une boucle génère de multiple exception (ou erreur) identique une seule sera stockée.
	 * @param Exception $e l'exception à traiter
	 */
	public static function gererException(Exception $e) {
		$cle = hash('md5', $e->getMessage().'-'.$e->getFile().'-'.$e->getLine());
		if (!isset(self::$exceptions[$cle])) {
			self::$exceptions[$cle] = $e;
			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 un rapport d'erreur existe, création d'une exception
		if (error_reporting() != 0) {
			$e = new ErrorException($message, 0, $niveau, $fichier, $ligne);
 
 
 
			self::gererException($e);
		}
		return null;
	}
 
	/**
	 * 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 self::MODE_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 .= '<div 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";
					if (self::getContexte()) {
						$retour .= '<pre>'."\n";
						$retour .= '<strong>Contexte : </strong>'."\n".print_r($e->getTraceAsString(), true)."\n";
						$retour .= '</pre>'."\n";
					}
					$retour .= '</div>'."\n";
			}
			// Nous vidons le tableau des exceptions au fur et à mesure
			unset(self::$exceptions[$cle]);
		}
		return $retour;
	}
 
	/**
	 * Logue une exception donnée sous une forme lisible si self::logger vaut true.
	 * @param Exception	$e l'exception à logger
	 */
	private static function loggerException($e) {
		if (self::$logger) {
			$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 (self::$afficher && count(self::$exceptions) > 0) {
			echo self::getExceptions();
		}
	}
 
}
?>

Subversion Repositories Applications.framework

(root)/trunk/framework/GestionnaireException.php – Rev 195 → 216

Rev 195		Rev 216
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 195 2010-05-19 13:07:36Z jpm $$`	15	`* @version SVN: $$Id: GestionnaireException.php 216 2010-11-10 11:29:59Z jpm $$`
16	`* @link /doc/framework/`	16	`* @link /doc/framework/`
17	`*`	17	`*`
18	`*/`	18	`*/`
19	`class GestionnaireException {`	19	`class GestionnaireException {`
20		20
21	`const MODE_CLI = 'cli';`	21	`const MODE_CLI = 'cli';`
22		22
23	`/** Liste des exceptions enregistrées */`	23	`/** Liste des exceptions enregistrées */`
24	`private static $exceptions = array();`	24	`private static $exceptions = array();`
25		25
26	`/** Détermine si l'on affiche ou non le contexte */`	26	`/** Détermine si l'on affiche ou non le contexte */`
27	`private static $contexte = false;`	27	`private static $contexte = false;`
28		28
29	`/** Détermine si l'on loggue ou non les erreurs */`	29	`/** Détermine si l'on loggue ou non les erreurs */`
30	`private static $logger = false;`	30	`private static $logger = false;`
31		31
32	`/** Détermine si l'affichage des erreurs est forcé (true) ou pas (false) à la destruction de la classe */`	32	`/** Détermine si l'affichage des erreurs est forcé (true) ou pas (false) à la destruction de la classe */`
33	`private static $afficher = false;`	33	`private static $afficher = false;`
34		34
35	`/** Definit si php est lancé en ligne de commande ou en mode serveur */`	35	`/** Definit si php est lancé en ligne de commande ou en mode serveur */`
36	`private static $mode = null ;`	36	`private static $mode = null ;`
37		37
38	`/** Initialise le Gestionnaire d'exceptions et d'erreur sans tenir comptes des paramêtres de config. */`	38	`/** Initialise le Gestionnaire d'exceptions et d'erreur sans tenir comptes des paramêtres de config. */`
39	`public static function initialiser() {`	39	`public static function initialiser() {`
40	`self::$mode = php_sapi_name();`	40	`self::$mode = php_sapi_name();`
41	`// Désactivation des balises HTML dans les messages d'erreur de PHP en mode ligne de commande`	41	`// Désactivation des balises HTML dans les messages d'erreur de PHP en mode ligne de commande`
42	`if (self::$mode == self::MODE_CLI) {`	42	`if (self::$mode == self::MODE_CLI) {`
43	`ini_set('html_errors', 0);`	43	`ini_set('html_errors', 0);`
44	`}`	44	`}`
45		45
46	`set_exception_handler(array(get_class(),'gererException'));`	46	`set_exception_handler(array(get_class(),'gererException'));`
47	`set_error_handler(array(get_class(),'gererErreur'));`	47	`set_error_handler(array(get_class(),'gererErreur'));`
48	`}`	48	`}`
49		49
50	`/** Configure le Gestionnaire d'exceptions et d'erreur à partir des paramêtres de config. */`	50	`/** Configure le Gestionnaire d'exceptions et d'erreur à partir des paramêtres de config. */`
51	`public static function configurer() {`	51	`public static function configurer() {`
52	`self::$contexte = Config::get('fw_debogage_contexte');`	52	`self::$contexte = Config::get('fw_debogage_contexte');`
53	`self::$logger = Config::get('fw_log_debogage');`	53	`self::$logger = Config::get('fw_log_debogage');`
54	`self::$afficher = Config::get('fw_debogage');`	54	`self::$afficher = Config::get('fw_debogage');`
55	`}`	55	`}`
56		56
57	`/** Renvoie le booleen définissant si l'on affiche le contexte ou non */`	57	`/** Renvoie le booleen définissant si l'on affiche le contexte ou non */`
58	`public static function getContexte() {`	58	`public static function getContexte() {`
59	`return self::$contexte;`	59	`return self::$contexte;`
60	`}`	60	`}`
61		61
62	`/**`	62	`/**`
63	`* Definit si l'on veut afficher le contexte ou non`	63	`* Definit si l'on veut afficher le contexte ou non`
64	`* @param bool true si on veut afficher le contexte, false sinon, par défaut vaut false`	64	`* @param bool true si on veut afficher le contexte, false sinon, par défaut vaut false`
65	`*/`	65	`*/`
66	`public static function setContexte($contexte) {`	66	`public static function setContexte($contexte) {`
67	`self::$contexte = $contexte;`	67	`self::$contexte = $contexte;`
68	`}`	68	`}`
69		69
70	`/**`	70	`/**`
71	`* Fonction de gestion des exceptions, remplace le handler par défaut`	71	`* Fonction de gestion des exceptions, remplace le handler par défaut.`
-		72	`* Si une boucle génère de multiple exception (ou erreur) identique une seule sera stockée.`
72	`* @param Exception $e l'exception à traiter`	73	`* @param Exception $e l'exception à traiter`
73	`*/`	74	`*/`
74	`public static function gererException(Exception $e) {`	75	`public static function gererException(Exception $e) {`
75	`// pour le moment on se contente de l'ajouter au tableau et de les afficher`	76	`$cle = hash('md5', $e->getMessage().'-'.$e->getFile().'-'.$e->getLine());`
76	`self::$exceptions[] = $e;`	77	`if (!isset(self::$exceptions[$cle])) {`
77	`// Log si nécéssaire`	78	`self::$exceptions[$cle] = $e;`
78	`self::loggerException($e);`	79	`self::loggerException($e);`
-		80	`}`
79	`}`	81	`}`
80		82
81	`/**`	83	`/**`
82	`* Gère les erreurs en les convertissant en exceptions (remplace la fonction gestion d'erreurs native de php)`	84	`* Gère les erreurs en les convertissant en exceptions (remplace la fonction gestion d'erreurs native de php)`
83	`* @param int $niveau le niveau de l'erreur`	85	`* @param int $niveau le niveau de l'erreur`
84	`* @param string $message le message associé à l'erreur`	86	`* @param string $message le message associé à l'erreur`
85	`* @param string $fichier le nom du fichier où l'erreur s'est produite`	87	`* @param string $fichier le nom du fichier où l'erreur s'est produite`
86	`* @param int $ligne la ligne où l'erreur s'est produite`	88	`* @param int $ligne la ligne où l'erreur s'est produite`
87	`* @param string $contexte le contexte associé à l'erreur`	89	`* @param string $contexte le contexte associé à l'erreur`
88	`*/`	90	`*/`
89	`public static function gererErreur($niveau, $message, $fichier, $ligne, $contexte){`	91	`public static function gererErreur($niveau, $message, $fichier, $ligne, $contexte){`
90	`// Si un rapport d'erreur existe, création d'une exception`	92	`// Si un rapport d'erreur existe, création d'une exception`
91	`if (error_reporting() != 0) {`	93	`if (error_reporting() != 0) {`
92	`$e = new ErrorException($message, 0, $niveau, $fichier, $ligne);`	94	`$e = new ErrorException($message, 0, $niveau, $fichier, $ligne);`
93	`// que l'on donne au tableau d'exceptions`	-
94	`self::$exceptions[] = $e;`	-
95	`// Log si nécéssaire`	-
96	`self::loggerException($e);`	95	`self::gererException($e);`
97	`}`	96	`}`
98	`return null;`	97	`return null;`
99	`}`	98	`}`
100		99
101	`/**`	100	`/**`
102	`* Renvoie les exceptions au format (X)HTML`	101	`* Renvoie les exceptions au format (X)HTML`
103	`* ou bien au format texte suivant le mode d'utilisation de PHP`	102	`* ou bien au format texte suivant le mode d'utilisation de PHP`
104	`*/`	103	`*/`
105	`public static function getExceptions() {`	104	`public static function getExceptions() {`
106	`$retour = '';`	105	`$retour = '';`
107	`foreach (self::$exceptions as $cle => $e) {`	106	`foreach (self::$exceptions as $cle => $e) {`
108	`switch (self::$mode) {`	107	`switch (self::$mode) {`
109	`case self::MODE_CLI :`	108	`case self::MODE_CLI :`
110	`$retour .= $e->getMessage()."\n";`	109	`$retour .= $e->getMessage()."\n";`
111	`$retour .= 'Fichier : '.$e->getFile()."\n";`	110	`$retour .= 'Fichier : '.$e->getFile()."\n";`
112	`$retour .= 'Ligne : '.$e->getLine()."\n";`	111	`$retour .= 'Ligne : '.$e->getLine()."\n";`
113	`if (self::getContexte()) {`	112	`if (self::getContexte()) {`
114	`$retour .= 'Contexte : '."\n".print_r($e->getTraceAsString(), true)."\n";`	113	`$retour .= 'Contexte : '."\n".print_r($e->getTraceAsString(), true)."\n";`
115	`}`	114	`}`
116	`break;`	115	`break;`
117	`default:`	116	`default:`
118	`$retour .= '<div class="debogage">'."\n";`	117	`$retour .= '<div class="debogage">'."\n";`
119	`$retour .= $e->getMessage()."\n";`	118	`$retour .= $e->getMessage()."\n";`
120	`$retour .= '<span class="debogage_fichier">'.'Fichier : '.$e->getFile().'</span>'."\n";`	119	`$retour .= '<span class="debogage_fichier">'.'Fichier : '.$e->getFile().'</span>'."\n";`
121	`$retour .= '<span class="debogage_ligne">'.'Ligne : '.$e->getLine().'</span>'."\n";`	120	`$retour .= '<span class="debogage_ligne">'.'Ligne : '.$e->getLine().'</span>'."\n";`
122	`if (self::getContexte()) {`	121	`if (self::getContexte()) {`
123	`$retour .= '<pre>'."\n";`	122	`$retour .= '<pre>'."\n";`
124	`$retour .= '<strong>Contexte : </strong>'."\n".print_r($e->getTraceAsString(), true)."\n";`	123	`$retour .= '<strong>Contexte : </strong>'."\n".print_r($e->getTraceAsString(), true)."\n";`
125	`$retour .= '</pre>'."\n";`	124	`$retour .= '</pre>'."\n";`
126	`}`	125	`}`
127	`$retour .= '</div>'."\n";`	126	`$retour .= '</div>'."\n";`
128	`}`	127	`}`
129	`// Nous vidons le tableau des exceptions au fur et à mesure`	128	`// Nous vidons le tableau des exceptions au fur et à mesure`
130	`unset(self::$exceptions[$cle]);`	129	`unset(self::$exceptions[$cle]);`
131	`}`	130	`}`
132	`return $retour;`	131	`return $retour;`
133	`}`	132	`}`
134		133
135	`/**`	134	`/**`
136	`* Logue une exception donnée sous une forme lisible si self::logger vaut true.`	135	`* Logue une exception donnée sous une forme lisible si self::logger vaut true.`
137	`* @param Exception $e l'exception à logger`	136	`* @param Exception $e l'exception à logger`
138	`*/`	137	`*/`
139	`private static function loggerException($e) {`	138	`private static function loggerException($e) {`
140	`if (self::$logger) {`	139	`if (self::$logger) {`
141	`$erreur = '';`	140	`$erreur = '';`
142	`$erreur .= $e->getMessage()."\n";`	141	`$erreur .= $e->getMessage()."\n";`
143	`$erreur .= 'Fichier : '.$e->getFile()."\n";`	142	`$erreur .= 'Fichier : '.$e->getFile()."\n";`
144	`$erreur .= 'Ligne : '.$e->getLine()."\n";`	143	`$erreur .= 'Ligne : '.$e->getLine()."\n";`
145	`if (self::getContexte()) {`	144	`if (self::getContexte()) {`
146	`$erreur .= 'Contexte : '."\n".print_r($e->getTraceAsString(), true)."\n";`	145	`$erreur .= 'Contexte : '."\n".print_r($e->getTraceAsString(), true)."\n";`
147	`}`	146	`}`
148	`$erreur .= "\n";`	147	`$erreur .= "\n";`
149	`Log::ajouterEntree('erreurs', $erreur);`	148	`Log::ajouterEntree('erreurs', $erreur);`
150	`}`	149	`}`
151	`}`	150	`}`
152		151
153	`public function __destruct() {`	152	`public function __destruct() {`
154	`// Si des erreurs n'ont pas été affichée nous forçons leur affichage`	153	`// Si des erreurs n'ont pas été affichée nous forçons leur affichage`
155	`if (self::$afficher && count(self::$exceptions) > 0) {`	154	`if (self::$afficher && count(self::$exceptions) > 0) {`
156	`echo self::getExceptions();`	155	`echo self::getExceptions();`
157	`}`	156	`}`
158	`}`	157	`}`
159		158
160	`}`	159	`}`
161	`?>`	160	`?>`