Subversion Repositories Applications.framework

<?php
// declare(encoding='UTF-8');
/**
 * Classe de gestion des exceptions.
 * C'est un Singleton.
 *
 * @category    PHP 5.2
 * @package             Framework
 * @author              Aurélien PERONNET <aurelien@tela-botanica.org>
 * @author              Jean-Pascal MILCENT <jmp@tela-botanica.org>
 * @copyright   Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)
 * @license             GNU-GPL-v3 <http://www.gnu.org/licenses/gpl.html>
 * @license             CECILL-v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt>
 */
class GestionnaireException {

        const MODE_CLI = 'cli';

        /** Liste des exceptions enregistrées */
        private static $exceptions = array();

        /** Détermine si l'on affiche ou non le contexte */
        private static $contexte = false;

         /** Détermine si l'on loggue ou non les erreurs */
        private static $logger = false;

        /** Détermine si l'affichage des erreurs est forcé (true) ou pas (false) à la destruction de la classe */
        private static $afficher = false;

        /** Definit si php est lancé en ligne de commande ou en mode serveur */
        private static $mode = null ;

        /** Initialise le Gestionnaire d'exceptions et d'erreur sans tenir comptes des paramêtres de config. */
        public static function initialiser() {
                self::$mode = php_sapi_name();
                // Désactivation des balises HTML dans les messages d'erreur de PHP en mode ligne de commande
                if (self::$mode == self::MODE_CLI) {
                        ini_set('html_errors', 0);
                }

                set_exception_handler(array(get_class(),'gererException'));
                set_error_handler(array(get_class(),'gererErreur'));
        }

        /** Configure le Gestionnaire d'exceptions et d'erreur à partir des paramêtres de config. */
        public static function configurer() {
                self::$contexte = Config::get('fw_debogage_contexte');
                self::$logger = Config::get('fw_log_debogage');
                self::$afficher = Config::get('fw_debogage');
        }

        /** Renvoie le booleen définissant si l'on affiche le contexte ou non */
        public static function getContexte() {
                return self::$contexte;
        }

        /**
         * Definit si l'on veut afficher le contexte ou non
         * @param bool true si on veut afficher le contexte, false sinon, par défaut vaut false
         */
        public static function setContexte($contexte) {
                self::$contexte = $contexte;
        }

        /**
         * Fonction de gestion des exceptions, remplace le handler par défaut
         * @param Exception $e l'exception à traiter
         */
        public static function gererException(Exception $e) {
                // pour le moment on se contente de l'ajouter au tableau et de les afficher
                self::$exceptions[] = $e;
                // Log si nécéssaire
                self::loggerException($e);
        }

        /**
         * Gère les erreurs en les convertissant en exceptions (remplace la fonction gestion d'erreurs native de php)
         * @param int $niveau le niveau de l'erreur
         * @param string $message le message associé à l'erreur
         * @param string $fichier le nom du fichier où l'erreur s'est produite
         * @param int $ligne la ligne où l'erreur s'est produite
         * @param string $contexte le contexte associé à l'erreur
         */
        public static function gererErreur($niveau,  $message,  $fichier,  $ligne,  $contexte){
                // Si un rapport d'erreur existe, création d'une exception
                if (error_reporting() != 0) {
                        $e = new ErrorException($message, 0, $niveau, $fichier, $ligne);
                        // que l'on donne au tableau d'exceptions
                        self::$exceptions[] = $e;
                        // Log si nécéssaire
                        self::loggerException($e);
                }
                return null;
        }

        /**
         * Renvoie les exceptions au format (X)HTML
         * ou bien au format texte suivant le mode d'utilisation de PHP
         */
        public static function getExceptions() {
                $retour = '';
                foreach (self::$exceptions as $cle => $e) {
                        switch (self::$mode) {
                                case self::MODE_CLI :
                                        $retour .= $e->getMessage()."\n";
                                        $retour .= 'Fichier : '.$e->getFile()."\n";
                                        $retour .= 'Ligne : '.$e->getLine()."\n";
                                        if (self::getContexte()) {
                                                $retour .= 'Contexte : '."\n".print_r($e->getTraceAsString(), true)."\n";
                                        }
                                        break;
                                default:
                                        $retour .= '<div class="debogage">'."\n";
                                        $retour .= $e->getMessage()."\n";
                                        $retour .= '<span class="debogage_fichier">'.'Fichier : '.$e->getFile().'</span>'."\n";
                                        $retour .= '<span class="debogage_ligne">'.'Ligne : '.$e->getLine().'</span>'."\n";
                                        if (self::getContexte()) {
                                                $retour .= '<pre>'."\n";
                                                $retour .= '<strong>Contexte : </strong>'."\n".print_r($e->getTraceAsString(), true)."\n";
                                                $retour .= '</pre>'."\n";
                                        }
                                        $retour .= '</div>'."\n";
                        }
                        // Nous vidons le tableau des exceptions au fur et à mesure
                        unset(self::$exceptions[$cle]);
                }
                return $retour;
        }

        /**
         * Logue une exception donnée sous une forme lisible si self::logger vaut true.
         * @param Exception     $e l'exception à logger
         */
        private static function loggerException($e) {
                if (self::$logger) {
                        $erreur = '';
                        $erreur .= $e->getMessage()."\n";
                        $erreur .= 'Fichier : '.$e->getFile()."\n";
                        $erreur .= 'Ligne : '.$e->getLine()."\n";
                        if (self::getContexte()) {
                                $erreur .= 'Contexte : '."\n".print_r($e->getTraceAsString(), true)."\n";
                        }
                        $erreur .= "\n";
                        Log::ajouterEntree('erreurs', $erreur);
                }
        }

        public function __destruct() {
                // Si des erreurs n'ont pas été affichée nous forçons leur affichage
                if (self::$afficher && count(self::$exceptions) > 0) {
                        echo self::getExceptions();
                }
        }

}
?>