Subversion Repositories Applications.framework

Rev

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