Subversion Repositories Applications.framework

Rev

Rev 167 | Rev 218 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
97 jpm 1 
<?php
2 
// declare(encoding='UTF-8');
3 
/**
129 aurelien 4 
 * Classe fournissant des fonctions de débogage équivalante à var_dump et print_r.
5 
 * L'affichage et l'utilisation de ces fonctions sont améliorés via cette classe.
6 
 * Cette classe est inspirée de la classe Zend_Debug.
7 
 *
186 jpm 8 
 * @category	PHP 5.2
9 
 * @package		Framework
10 
 * @author		Jean-Pascal MILCENT <jpm@tela-botanica.org>
11 
 * @copyright	Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)
12 
 * @license		http://www.gnu.org/licenses/gpl.html Licence GNU-GPL-v3
13 
 * @license		http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL-v2
14 
 * @version		SVN : $Id: Debug.php 186 2010-04-28 15:50:16Z jpm $
15 
 * @link		/doc/framework/
129 aurelien 16 
 */
97 jpm 17 
class Debug {
18 
 
186 jpm 19 
	const MODE_ECHO = 'echo';
20 
	const MODE_NOTICE = 'e_user_notice';
21 
 
129 aurelien 22 
	/**
23 
	 * mode de php (cli ou sapi)
24 
	 */
97 jpm 25 
	protected static $mode = null;
26 
 
129 aurelien 27 
	/**
28 
	 * Accesseur pour le mode
29 
	 * @return string le mode de php
30 
	 */
97 jpm 31 
	public static function getMode() {
32 
		if (self::$mode === null) {
33 
			self::$mode = PHP_SAPI;
34 
		}
35 
		return self::$mode;
36 
	}
37 
 
129 aurelien 38 
	/**
39 
	 * Equivalent de var_dump
40 
	 * @param mixed $variable la variable à dumper
41 
	 * @param string $mot_cle le mot cle à associer à la variable
42 
	 * @param boolean $echo si true on affiche le résultat, si false on ne renvoie que la chaine sans l'afficher
43 
	 * @return string la chaine à afficher representant le dump ou null si echo
44 
	 */
186 jpm 45 
	public static function dump($variable, $mot_cle = null, $echo = false) {
97 jpm 46 
		// var_dump de la variable dans un buffer et récupération de la sortie
47 
		ob_start();
48 
		var_dump($variable);
49 
		$sortie = ob_get_clean();
50 
 
51 
		// Pré-traitement de la sortie
52 
		$sortie = preg_replace("/\]\=\>\n(\s+)/m", "] => ", $sortie);
53 
 
54 
		// Traitement général du débogage
55 
		return self::traiterDebogage($mot_cle, $sortie, $echo);
56 
	}
57 
 
129 aurelien 58 
	/**
186 jpm 59 
	 * Equivalent de print_r.
129 aurelien 60 
	 * @param mixed $variable la variable à afficher
61 
	 * @param string $mot_cle le mot cle à associer
62 
	 * @param boolean $echo faire un echo ou non
63 
	 * @return string la chaine contenant la variable printée ou null si echo
64 
	 */
186 jpm 65 
	public static function printr($variable, $mot_cle = null, $echo = false) {
97 jpm 66 
		// Récupération de la sortie
67 
		$sortie = print_r($variable, true);
68 
 
69 
		// Traitement général du débogage
70 
		return self::traiterDebogage($mot_cle, $sortie, $echo);
71 
	}
72 
 
129 aurelien 73 
	/**
74 
	 * Traite une chaine de débogage et les mots clés associés
75 
	 * @param string  $mot_cle le mot à associer à la chaine
76 
	 * @param string  $sortie le chaine de debogage
77 
	 * @param boolean $echo faire un echo du resultat ou non
78 
	 * @return string la chaine de debogage formatée ou bien null si echo
79 
	 */
97 jpm 80 
	private static function traiterDebogage($mot_cle, $sortie, $echo) {
81 
		// Formate le mot-clé
82 
		$mot_cle = self::formaterMotCle($mot_cle);
83 
 
84 
		// Traitement de la sortie
85 
		$sortie = self::traiterSortieSuivantMode($mot_cle, $sortie);
86 
 
87 
		// Affichage et/ou retour
186 jpm 88 
		self::verifierParametresConfig();
167 jpm 89 
		if (Config::get('fw_debogage') == true) {
186 jpm 90 
			if ($echo === true || Config::get('fw_debogage_mode') == self::MODE_ECHO) {
167 jpm 91 
				echo $sortie;
92 
				return null;
186 jpm 93 
			} else if (Config::get('fw_debogage_mode') == self::MODE_NOTICE) {
94 
				trigger_error($sortie, E_USER_NOTICE);
95 
				return null;
167 jpm 96 
			} else {
97 
				return $sortie;
98 
			}
97 jpm 99 
		}
100 
	}
101 
 
129 aurelien 102 
	/**
103 
	 * formate un mot clé donné
104 
	 * @param string $mot_cle le mot clé à formaté
105 
	 * @return string le mot clé formaté ou bien un chaine vide le mot clé est null ou vide
106 
	 */
97 jpm 107 
	private static function formaterMotCle($mot_cle) {
108 
		return ($mot_cle === null) ? '' : rtrim($mot_cle).' ';
109 
	}
110 
 
129 aurelien 111 
	/**
112 
	 * traite la sortie de la chaine de débogage suivant le mode de php
113 
	 * @param string $mot_cle le mot clé associé à la chaine
114 
	 * @param string  $sortie la chaine de débogage
115 
	 * @return string la sortie formatée pour le mode en cours
116 
	 */
97 jpm 117 
	private static function traiterSortieSuivantMode($mot_cle, $sortie) {
118 
		$corps = $mot_cle.PHP_EOL.$sortie;
119 
		if (self::getMode() == 'cli') {
120 
			$sortie = PHP_EOL.$corps.PHP_EOL;
121 
		} else {
122 
			$sortie = '<pre>'.$corps.'</pre>';
123 
		}
124 
		return $sortie;
125 
	}
186 jpm 126 
 
127 
	/**
128 
	 * Vérifie que tous les paramêtres de config nécessaires au fonctionnement de cette classe existe dans les fichiers
129 
	 * de configurations.
130 
	 */
131 
	private static function verifierParametresConfig() {
132 
		$ok = true;
133 
		$parametres = array('fw_debogage', 'fw_debogage_mode');
134 
		foreach ($parametres as $param) {
135 
			if (is_null(Config::get($param))) {
136 
				$classe = get_class();
137 
				$m = "L'utilisation de la classe $classe nécessite de définir '$param' dans un fichier de configuration.";
138 
				trigger_error($m, E_USER_WARNING);
139 
				$ok = false;
140 
			}
141 
		}
142 
		return $ok;
143 
	}
97 jpm 144 
}
145 
?>