Subversion Repositories Applications.framework

Rev

Rev 179 | Rev 190 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

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