Subversion Repositories Applications.framework

Rev

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

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