Subversion Repositories Applications.framework

Rev

Details | 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 161 2010-03-05 09:04:15Z aurelien $$
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 
	/**
160 aurelien 37 
	 * Détermine si l'on loggue ou non les erreurs
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 
	/**
47 
	 * le gestionnaire d'exception est un singleton
114 jp_milcent 48 
	 * et possède donc un "pointeur statique sur lui-même"
5 aurelien 49 
	 */
115 jp_milcent 50 
	private static $gestionnaireException;
120 aurelien 51 
 
5 aurelien 52 
	/**
105 aurelien 53 
	 * Constructeur avec paramètres optionnel
5 aurelien 54 
	 * @param bool indique si l'on veut afficher ou non le contexte des exceptions (i.e. la trace)
55 
	 */
122 aurelien 56 
	public function __construct() {
115 jp_milcent 57 
		self::$exceptions = array();
129 aurelien 58 
		self::$contexte = Config::get('fw_debogage_contexte');
59 
		self::$logger = Config::get('fw_log_debogage');
160 aurelien 60 
		self::$afficher = Config::get('fw_debogage');
120 aurelien 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'));
5 aurelien 65 
	}
120 aurelien 66 
 
5 aurelien 67 
	/**
105 aurelien 68 
	 * Renvoie le booleen définissant si l'on affiche le contexte ou non
5 aurelien 69 
	 */
120 aurelien 70 
	public static function getContexte() {
129 aurelien 71 
		return self::$contexte;
5 aurelien 72 
	}
120 aurelien 73 
 
5 aurelien 74 
	/**
75 
	 * Definit si l'on veut afficher le contexte ou non
105 aurelien 76 
	 * @param bool true si on veut afficher le contexte, false sinon, par défaut vaut false
5 aurelien 77 
	 */
160 aurelien 78 
	public static function setContexte($contexte) {
129 aurelien 79 
		self::$contexte = $contexte;
5 aurelien 80 
	}
120 aurelien 81 
 
105 aurelien 82 
	 /** Fonction d'accès au singleton
5 aurelien 83 
	 * @return GestionnaireErreur le gestionnaire d'exceptions courant
84 
	 */
114 jp_milcent 85 
	public static function getInstance() {
5 aurelien 86 
		if (self::$gestionnaireException instanceof GestionnaireException) {
87 
			return self::$gestionnaireException;
88 
		}
89 
		self::$gestionnaireException = new GestionnaireException;
120 aurelien 90 
 
91 
		return self::$gestionnaireException;
5 aurelien 92 
	}
120 aurelien 93 
 
5 aurelien 94 
	/**
105 aurelien 95 
	 * Fonction de gestion des exceptions, remplace le handler par défaut
129 aurelien 96 
	 * @param Exception $e l'exception à traiter
5 aurelien 97 
	 */
98 
	public static function gererException(Exception $e) {
120 aurelien 99 
		// pour le moment on se contente de l'ajouter au tableau et de les afficher
100 
		self::$exceptions[] = $e;
101 
 
129 aurelien 102 
		// si on doit logger on envoie l'exception au loggeur
142 jpm 103 
		if (self::$logger) {
129 aurelien 104 
			self::loggerException($e);
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
142 jpm 118 
		if (error_reporting() == 0) {
120 aurelien 119 
			return;
120 
		}
121 
 
122 
		// sinon on crée une exception
123 
		$e = new ErrorException($message, 0, $niveau, $fichier, $ligne);
124 
		// que l'on donne au tableau d'exceptions
125 
		self::$exceptions[] = $e;
129 aurelien 126 
		// on la logge si nécéssaire
142 jpm 127 
		if (self::$logger) {
129 aurelien 128 
			self::loggerException($e);
129 
		}
130 
		return;
120 aurelien 131 
	}
132 
 
5 aurelien 133 
	/**
134 
	 * Renvoie les exceptions au format (X)HTML
135 
	 * ou bien au format texte suivant le mode d'utilisation de PHP
136 
	 */
120 aurelien 137 
	public static function getExceptions() {
114 jp_milcent 138 
		$retour = '';
142 jpm 139 
		foreach (self::$exceptions as $cle => $e) {
140 
			switch (self::$mode) {
120 aurelien 141 
				case 'cli' :
98 jpm 142 
					$retour .= $e->getMessage()."\n";
143 
					$retour .= 'Fichier : '.$e->getFile()."\n";
120 aurelien 144 
					$retour .= 'Ligne : '.$e->getLine()."\n";
145 
					if (self::getContexte()) {
98 jpm 146 
						$retour .= 'Contexte : '."\n".print_r($e->getTraceAsString(), true)."\n";
147 
					}
148 
					break;
149 
				default:
5 aurelien 150 
					$retour .= '<pre class="debogage">'."\n";
124 aurelien 151 
					$retour .= $e->getMessage()."\n";
5 aurelien 152 
					$retour .= '<span class="debogage_fichier">'.'Fichier : '.$e->getFile().'</span>'."\n";
153 
					$retour .= '<span class="debogage_ligne">'.'Ligne : '.$e->getLine().'</span>'."\n";
154 
					$retour .= '</pre>'."\n";
120 aurelien 155 
 
156 
					if (self::getContexte()) {
5 aurelien 157 
						$retour .= '<pre>'."\n";
158 
						$retour .= '<strong>Contexte : </strong>'."\n".print_r($e->getTraceAsString(), true)."\n";
159 
						$retour .= '</pre>'."\n";
160 
					}
98 jpm 161 
			}
142 jpm 162 
			// Nous vidons le tableau des exceptions au fur et à mesure
163 
			unset(self::$exceptions[$cle]);
5 aurelien 164 
		}
165 
		return $retour;
166 
	}
167 
 
129 aurelien 168 
	/**
169 
	 * logge une exception donnée sous une forme lisible
170 
	 * @param Exception	$e l'exception à logger
171 
	 */
172 
	private static function loggerException($e) {
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 
 
135 aurelien 184 
	public function __destruct() {
142 jpm 185 
		// Si des erreurs n'ont pas été affichée nous forçons leur affichage
160 aurelien 186 
		if (self::$afficher && count(self::$exceptions) > 0) {
142 jpm 187 
			echo self::getExceptions();
188 
		}
135 aurelien 189 
	}
190 
 
120 aurelien 191 
}
142 jpm 192 
?>