Subversion Repositories Applications.framework

Rev

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