Subversion Repositories Applications.framework

Rev

Rev 467 | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

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