Subversion Repositories Applications.framework

<?php

// declare(encoding='UTF-8');

/**

* classe de gestion des erreurs.

*

* PHP Version 5

*

* @category  Class

* @package   Framework

* @author    Jean-Pascal Milcent <jpm@tela-botanica.org>

* @copyright 2009 Tela-Botanica

* @license   http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL

* @license   http://www.gnu.org/licenses/gpl.html Licence GNU-GPL

* @version   SVN: $$Id: GestionnaireErreur.php 105 2009-08-31 15:25:05Z aurelien $$

* @link      /doc/framework/

*

*/

class GestionnaireErreur

{

	/*** Attributs: ***/

	/**

	 * Permet de savoir si on utilise PHP en ligne de commande dans une console (PHP-CLI) ou en mode module de serveur.

	 * @access private

	 */

	private $mode;

	/**

	 * Contient la liste des erreurs.

	 * @access private

	 */

	private $erreurs;

	/**

	 * Permet de savoir si on veut faire apparaître ou pas le contexte de l'erreur,

	 * c'est à dire le contenu des variables.

	 * @access private

	 */

	private $contexte;

	/**

	 * Contient le niveau d'erreur courant. Celui que l'on donne à la fonction

	 * error_reporting().

	 * @access private

	 */

	private $niveau_erreur_courant;

	/**

	 * Le gestionnaire d'erreur est un singleton

	 */

	private static $gestionnaire_erreurs;

	/*** Constructeur: ***/

	/**

	 * Construit le gestionnaire d'erreur.

	 *

	 * @return void

	 * @access public

	 */

	private function __construct( $contexte = false )

	{

		$this->mode = php_sapi_name();

		$this->erreurs = array();

		$this->setContexte($contexte);

		$this->niveau_erreur_courant = 2048 ;

		set_error_handler(array(&$this, 'gererErreur'));

	}

	/**

	 * Fonction d'accès au singleton

	 * @return GestionnaireErreur le gestionnaire d'erreurs courant

	 */

	public static function getInstance()

	{

		if (self::$gestionnaire_erreurs instanceof GestionnaireErreur) {

			return self::$gestionnaire_erreurs;

		}

		self::$gestionnaire_erreurs = new GestionnaireErreur ;

	    return self::$gestionnaire_erreurs;

	}

	/*** Accesseurs: ***/

	/**

	 * Récupère le tableau des erreurs.

	 *

	 * @return array

	 * @access public

	 */

	public function getErreur( ) {

		return $this->erreurs;

	}

	/**

	 * Ajoute une erreur à la liste.

	 *

	 * @param array une_erreur

	 * @return void

	 * @access public

	 */

	public function setErreur( $une_erreur ) {

		$this->erreurs[] = $une_erreur;

	}

	/**

	 * Récupère la valeur du contexte.

	 *

	 * @return boolean

	 * @access public

	 */

	public function getContexte( ) {

		return $this->contexte;

	}

	/**

	 * Définit si oui ou non le contexte sera affiché.

	 *

	 * @param boolean un_contexte

	 * @return  void

	 * @access public

	 */

	public function setContexte( $un_contexte ) {

		$this->contexte = $un_contexte;

	}

	/**

	 * Récupère le niveau d'erreur courrant.

	 *

	 * @return int le niveau d'erreur courrant.

	 * @access public

	 */

	public function getNiveauErreurCourant( ) {

		return (int)$this->niveau_erreur_courant;

	}

	/**

	 * Définit le niveau d'erreur courrant.

	 *

	 * @param int un niveau d'erreur.

	 * @return void

	 * @access public

	 */

	public function setNiveauErreurCourant( $niveau = 2048 ) {

		$this->niveau_erreur_courant = $niveau;

	}

	/**

	 * Définit le niveau d'erreur courrant (synonyme fonction precedente)

	 *

	 * @param int un niveau d'erreur.

	 * @return void

	 * @access public

	 */

	public function setActive ($niveau) {

		$this->niveau_erreur_courant = $niveau;

	}

	/*** Méthodes : ***/

	/**

	 *

	 * @param int niveau

	 * @param string message

	 * @param string fichier

	 * @param int ligne

	 * @param boolean contexte

	 * @return void

	 * @access public

	 */

	public function gererErreur($niveau,  $message,  $fichier,  $ligne,  $contexte)

	{

		$aso_erreur = array();

		// Nous vérifions si nous affichons ou pas l'erreur en fonction du niveau demandé

		if ( $niveau <= $this->getNiveauErreurCourant() ) {

			$aso_erreur['niveau'] = $niveau;

			switch ($niveau) {

				case E_USER_NOTICE :

					if (is_array($message) || is_object($message)) {

						$aso_erreur['message'] = print_r($message, true);

					} else {

						$aso_erreur['message'] = $message;

					}

					break;

				default:

					$aso_erreur['message'] = $message;

			}

			$aso_erreur['fichier'] = $fichier;

			$aso_erreur['ligne'] = $ligne;

			if ($this->getContexte()) {

				$aso_erreur['contexte'] = $contexte;

			}

			$this->setErreur($aso_erreur);

		}

		echo print_r($this->erreurs,true) ;

		exit() ;

		// Si nous avons affaire à une erreur et non à un warning ou une notice, nous arrêtons l'exécution du script

		switch ($niveau) {

			case E_ERROR :

			case E_USER_ERROR :

				die($this->retournerErreur());

				break;

		}

	}

	/**

	 * Retourne l'erreur PHP formatée en XHTML.

	 *

	 * @return string

	 * @access public

	 */

	public function retournerErreur()

	{

		$retour = '';

		foreach($this->getErreur() as $aso_erreur) {

			if ('<!-- BEGIN sql -->' == substr($aso_erreur['message'], 0, 18)) {

				$retour .= $aso_erreur['message'];

				continue;

			}

			switch ($this->mode) {

				case 'cli' :

					if ($aso_erreur['niveau'] == E_USER_NOTICE) {

						$retour .= $aso_erreur['message']."\n";

						$retour .= 'Fichier : '.$aso_erreur['fichier']."\n";

						$retour .= 'Ligne : '.$aso_erreur['ligne']."\n";

					} else if ($aso_erreur['niveau'] <= 512) {

						$retour .= 'INFO : Niveau '.$aso_erreur['niveau']."\n";

					} else {

						$retour .= 'ERREUR : Niveau '.$aso_erreur['niveau']."\n";

					}

					$retour .= 'Niveau : '.$aso_erreur['niveau']."\n";

					$retour .= 'Message : '.$aso_erreur['message']."\n";

					$retour .= 'Fichier : '.$aso_erreur['fichier']."\n";

					$retour .= 'Ligne : '.$aso_erreur['ligne']."\n";

					if ($this->getContexte()) {

						$retour .= 'Contexte : '."\n".print_r($aso_erreur['contexte'], true)."\n";

					}

					break;

				default:

					if ($aso_erreur['niveau'] == E_USER_NOTICE) {

						$retour .= '<pre class="debogage">'."\n";

						$retour .= htmlentities($aso_erreur['message'])."\n";

						$retour .= '<span class="debogage_fichier">'.'Fichier : '.$aso_erreur['fichier'].'</span>'."\n";

						$retour .= '<span class="debogage_ligne">'.'Ligne : '.$aso_erreur['ligne'].'</span>'."\n";

						$retour .= '</pre>'."\n";

						continue;

					} else if ($aso_erreur['niveau'] <= 512) {

						$retour .= '<p class="information">'."\n";

						$retour .= '<strong>INFO : Niveau '.$aso_erreur['niveau'].'</strong><br />'."\n";

					} else {

						$retour .= '<p class="attention">'."\n";

						$retour .= '<strong>ERREUR : Niveau '.$aso_erreur['niveau'].'</strong><br />'."\n";

					}

					$retour .= '<strong>Niveau : </strong>'.$aso_erreur['niveau'].'<br />'."\n";

					$retour .= '<strong>Message : </strong>'.$aso_erreur['message'].'<br />'."\n";

					$retour .= '<strong>Fichier : </strong>'.$aso_erreur['fichier'].'<br />'."\n";

					$retour .= '<strong>Ligne : </strong>'.$aso_erreur['ligne'].'<br />'."\n";

					if ($this->getContexte()) {

						$retour .= '<pre>'."\n";

						$retour .= '<strong>Contexte : </strong>'."\n".print_r($aso_erreur['contexte'], true)."\n";

						$retour .= '</pre>'."\n";

					}

					$retour .= '</p>'."\n";

			}

		}

		return $retour;

	}

	/**

	* Retourne l'erreur SQL formatée en XHTML.

	*

	* @param string fichier

	* @param int ligne

	* @param string message

	* @param string requete

	* @param string autres

	* @return string

	* @static

	* @access public

	*/

	public static function retournerErreurSql( $fichier,  $methode,  $message,  $requete = null,  $autres = null )

	{

		$retour = '';

		switch (php_sapi_name()) {

			case 'cli' :

				$retour .= 'ERREUR SQL '."\n";

				$retour .= 'Fichier : '.$fichier."\n";

				$retour .= 'Méthode : '.$methode."\n";

				$retour .= 'Message : '.$message."\n";

				if (!is_null($requete)) {

					$retour .= 'Requete : '."\n";

					$retour .= $requete."\n";

		    	}

				if (!is_null($autres)) {

					$retour .= 'Autres infos : '."\n";

					$retour .= $autres."\n";

				}

				break;

			default:

				$retour .= '<!-- BEGIN sql -->';

				$retour .= '<div id="zone_erreur">'."\n";

				$retour .= '<h1 > ERREUR SQL </h1><br />'."\n";

				$retour .= '<dl>'."\n";

				$retour .= '<dt> Fichier : </dt> ';

				$retour .= '<dd> '.$fichier.'</dd>'."\n";

				$retour .= '<dt> Méthode : </dt> ';

				$retour .= '<dd> '.$methode.'</dd>'."\n";

				$retour .= '<dt> Message erreur : </dt> ';

				$retour .= '<dd> '.$message.'</dd>'."\n";

				if (!is_null($requete)) {

					$retour .= '<dt> Requete : </dt> ';

					$retour .= '<dd> '.$requete.' </dd>'."\n";

		    	}

				if (!is_null($autres)) {

					$retour .= '<dt> Autres infos : </dt> ';

					$retour .= '<dd> '.$autres.' </dd>'."\n";

				}

				$retour .= '</dl>'."\n";

				$retour .= '</div>'."\n";

				$retour .= '<!-- END sql -->'."\n";

		}

		return $retour;

	}

}

?>