WebSVN – Applications.framework – Diff – /trunk/framework/Debug.php


<?php
// declare(encoding='UTF-8');
/**
 * Classe fournissant des fonctions de débogage équivalante à var_dump et print_r.
 * L'affichage et l'utilisation de ces fonctions sont améliorés via cette classe.
 * Cette classe est inspirée de la classe Zend_Debug.
 *
 * PHP version 5
 *
 * @category Debogage
 * @package Framework
 // Auteur principal :
 * @author Jean-Pascal MILCENT <jpm@tela-botanica.org>
 // Autres auteurs :
 * @license GPL v3 <http://www.gnu.org/licenses/gpl.txt>
 * @license CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt>
 * @version $$Id: Debug.php 167 2010-03-19 17:12:08Z jpm $$
 * @copyright 1999-2009 Tela Botanica (accueil@tela-botanica.org)
 */
class Debug {
 
	/**
	 * mode de php (cli ou sapi)
	 */
	protected static $mode = null;
 
	/**
	 * Accesseur pour le mode
	 * @return string le mode de php
	 */
	public static function getMode() {
		if (self::$mode === null) {
			self::$mode = PHP_SAPI;
		}
		return self::$mode;
	}
 
	/**
	 * Equivalent de var_dump
	 * @param mixed $variable la variable à dumper
	 * @param string $mot_cle le mot cle à associer à la variable
	 * @param boolean $echo si true on affiche le résultat, si false on ne renvoie que la chaine sans l'afficher
	 * @return string la chaine à afficher representant le dump ou null si echo
	 */
	public static function dump($variable, $mot_cle = null, $echo = true) {
		// var_dump de la variable dans un buffer et récupération de la sortie
		ob_start();
		var_dump($variable);
		$sortie = ob_get_clean();
 
		// Pré-traitement de la sortie
		$sortie = preg_replace("/\]\=\>\n(\s+)/m", "] => ", $sortie);
 
		// Traitement général du débogage
		return self::traiterDebogage($mot_cle, $sortie, $echo);
	}
 
	/**
	 * Equivalent de print_r
	 * @param mixed $variable la variable à afficher
	 * @param string $mot_cle le mot cle à associer
	 * @param boolean $echo faire un echo ou non
	 * @return string la chaine contenant la variable printée ou null si echo
	 */
	public static function printr($variable, $mot_cle = null, $echo = true) {
		// Récupération de la sortie
		$sortie = print_r($variable, true);
 
		// Traitement général du débogage
		return self::traiterDebogage($mot_cle, $sortie, $echo);
	}
 
	/**
	 * Traite une chaine de débogage et les mots clés associés
	 * @param string  $mot_cle le mot à associer à la chaine
	 * @param string  $sortie le chaine de debogage
	 * @param boolean $echo faire un echo du resultat ou non
	 * @return string la chaine de debogage formatée ou bien null si echo
	 */
	private static function traiterDebogage($mot_cle, $sortie, $echo) {
		// Formate le mot-clé
		$mot_cle = self::formaterMotCle($mot_cle);
 
		// Traitement de la sortie
		$sortie = self::traiterSortieSuivantMode($mot_cle, $sortie);
 
		// Affichage et/ou retour
		if (Config::get('fw_debogage') == true) {
			if ($echo) {
				echo $sortie;
				return null;
			} else {
				return $sortie;
			}
		}
	}
 
	/**
	 * formate un mot clé donné
	 * @param string $mot_cle le mot clé à formaté
	 * @return string le mot clé formaté ou bien un chaine vide le mot clé est null ou vide
	 */
	private static function formaterMotCle($mot_cle) {
		return ($mot_cle === null) ? '' : rtrim($mot_cle).' ';
	}
 
	/**
	 * traite la sortie de la chaine de débogage suivant le mode de php
	 * @param string $mot_cle le mot clé associé à la chaine
	 * @param string  $sortie la chaine de débogage
	 * @return string la sortie formatée pour le mode en cours
	 */
	private static function traiterSortieSuivantMode($mot_cle, $sortie) {
		$corps = $mot_cle.PHP_EOL.$sortie;
		if (self::getMode() == 'cli') {
			$sortie = PHP_EOL.$corps.PHP_EOL;
		} else {
			$sortie = '<pre>'.$corps.'</pre>';
		}
		return $sortie;
	}
}
?>

Rev 153	Rev 167
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`	8	`* PHP version 5`
9	`*`	9	`*`
10	`* @category Debogage`	10	`* @category Debogage`
11	`* @package Framework`	11	`* @package Framework`
12	`// Auteur principal :`	12	`// Auteur principal :`
13	`* @author Jean-Pascal MILCENT <jpm@tela-botanica.org>`	13	`* @author Jean-Pascal MILCENT <jpm@tela-botanica.org>`
14	`// Autres auteurs :`	14	`// Autres auteurs :`
15	`* @license GPL v3 <http://www.gnu.org/licenses/gpl.txt>`	15	`* @license GPL v3 <http://www.gnu.org/licenses/gpl.txt>`
16	`* @license CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt>`	16	`* @license CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt>`
17	`* @version $$Id: Debug.php 153 2010-03-04 10:48:32Z jpm $$`	17	`* @version $$Id: Debug.php 167 2010-03-19 17:12:08Z jpm $$`
18	`* @copyright 1999-2009 Tela Botanica (accueil@tela-botanica.org)`	18	`* @copyright 1999-2009 Tela Botanica (accueil@tela-botanica.org)`
19	`*/`	19	`*/`
20	`class Debug {`	20	`class Debug {`
21		21
22	`/**`	22	`/**`
23	`* mode de php (cli ou sapi)`	23	`* mode de php (cli ou sapi)`
24	`*/`	24	`*/`
25	`protected static $mode = null;`	25	`protected static $mode = null;`
26		26
27	`/**`	27	`/**`
28	`* Accesseur pour le mode`	28	`* Accesseur pour le mode`
29	`* @return string le mode de php`	29	`* @return string le mode de php`
30	`*/`	30	`*/`
31	`public static function getMode() {`	31	`public static function getMode() {`
32	`if (self::$mode === null) {`	32	`if (self::$mode === null) {`
33	`self::$mode = PHP_SAPI;`	33	`self::$mode = PHP_SAPI;`
34	`}`	34	`}`
35	`return self::$mode;`	35	`return self::$mode;`
36	`}`	36	`}`
37		37
38	`/**`	38	`/**`
39	`* Equivalent de var_dump`	39	`* Equivalent de var_dump`
40	`* @param mixed $variable la variable à dumper`	40	`* @param mixed $variable la variable à dumper`
41	`* @param string $mot_cle le mot cle à associer à la variable`	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`	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`	43	`* @return string la chaine à afficher representant le dump ou null si echo`
44	`*/`	44	`*/`
45	`public static function dump($variable, $mot_cle = null, $echo = true) {`	45	`public static function dump($variable, $mot_cle = null, $echo = true) {`
46	`// var_dump de la variable dans un buffer et récupération de la sortie`	46	`// var_dump de la variable dans un buffer et récupération de la sortie`
47	`ob_start();`	47	`ob_start();`
48	`var_dump($variable);`	48	`var_dump($variable);`
49	`$sortie = ob_get_clean();`	49	`$sortie = ob_get_clean();`
50		50
51	`// Pré-traitement de la sortie`	51	`// Pré-traitement de la sortie`
52	`$sortie = preg_replace("/\]\=\>\n(\s+)/m", "] => ", $sortie);`	52	`$sortie = preg_replace("/\]\=\>\n(\s+)/m", "] => ", $sortie);`
53		53
54	`// Traitement général du débogage`	54	`// Traitement général du débogage`
55	`return self::traiterDebogage($mot_cle, $sortie, $echo);`	55	`return self::traiterDebogage($mot_cle, $sortie, $echo);`
56	`}`	56	`}`
57		57
58	`/**`	58	`/**`
59	`* Equivalent de print_r`	59	`* Equivalent de print_r`
60	`* @param mixed $variable la variable à afficher`	60	`* @param mixed $variable la variable à afficher`
61	`* @param string $mot_cle le mot cle à associer`	61	`* @param string $mot_cle le mot cle à associer`
62	`* @param boolean $echo faire un echo ou non`	62	`* @param boolean $echo faire un echo ou non`
63	`* @return string la chaine contenant la variable printée ou null si echo`	63	`* @return string la chaine contenant la variable printée ou null si echo`
64	`*/`	64	`*/`
65	`public static function printr($variable, $mot_cle = null, $echo = true) {`	65	`public static function printr($variable, $mot_cle = null, $echo = true) {`
66	`// Récupération de la sortie`	66	`// Récupération de la sortie`
67	`$sortie = print_r($variable, true);`	67	`$sortie = print_r($variable, true);`
68		68
69	`// Traitement général du débogage`	69	`// Traitement général du débogage`
70	`return self::traiterDebogage($mot_cle, $sortie, $echo);`	70	`return self::traiterDebogage($mot_cle, $sortie, $echo);`
71	`}`	71	`}`
72		72
73	`/**`	73	`/**`
74	`* Traite une chaine de débogage et les mots clés associés`	74	`* Traite une chaine de débogage et les mots clés associés`
75	`* @param string $mot_cle le mot à associer à la chaine`	75	`* @param string $mot_cle le mot à associer à la chaine`
76	`* @param string $sortie le chaine de debogage`	76	`* @param string $sortie le chaine de debogage`
77	`* @param boolean $echo faire un echo du resultat ou non`	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`	78	`* @return string la chaine de debogage formatée ou bien null si echo`
79	`*/`	79	`*/`
80	`private static function traiterDebogage($mot_cle, $sortie, $echo) {`	80	`private static function traiterDebogage($mot_cle, $sortie, $echo) {`
81	`// Formate le mot-clé`	81	`// Formate le mot-clé`
82	`$mot_cle = self::formaterMotCle($mot_cle);`	82	`$mot_cle = self::formaterMotCle($mot_cle);`
83		83
84	`// Traitement de la sortie`	84	`// Traitement de la sortie`
85	`$sortie = self::traiterSortieSuivantMode($mot_cle, $sortie);`	85	`$sortie = self::traiterSortieSuivantMode($mot_cle, $sortie);`
86		86
87	`// Affichage et/ou retour`	87	`// Affichage et/ou retour`
-		88	`if (Config::get('fw_debogage') == true) {`
88	`if ($echo) {`	89	`if ($echo) {`
89	`echo $sortie;`	90	`echo $sortie;`
90	`return null;`	91	`return null;`
91	`} else {`	92	`} else {`
92	`return $sortie;`	93	`return $sortie;`
-		94	`}`
93	`}`	95	`}`
94	`}`	96	`}`
95		97
96	`/**`	98	`/**`
97	`* formate un mot clé donné`	99	`* formate un mot clé donné`
98	`* @param string $mot_cle le mot clé à formaté`	100	`* @param string $mot_cle le mot clé à formaté`
99	`* @return string le mot clé formaté ou bien un chaine vide le mot clé est null ou vide`	101	`* @return string le mot clé formaté ou bien un chaine vide le mot clé est null ou vide`
100	`*/`	102	`*/`
101	`private static function formaterMotCle($mot_cle) {`	103	`private static function formaterMotCle($mot_cle) {`
102	`return ($mot_cle === null) ? '' : rtrim($mot_cle).' ';`	104	`return ($mot_cle === null) ? '' : rtrim($mot_cle).' ';`
103	`}`	105	`}`
104		106
105	`/**`	107	`/**`
106	`* traite la sortie de la chaine de débogage suivant le mode de php`	108	`* traite la sortie de la chaine de débogage suivant le mode de php`
107	`* @param string $mot_cle le mot clé associé à la chaine`	109	`* @param string $mot_cle le mot clé associé à la chaine`
108	`* @param string $sortie la chaine de débogage`	110	`* @param string $sortie la chaine de débogage`
109	`* @return string la sortie formatée pour le mode en cours`	111	`* @return string la sortie formatée pour le mode en cours`
110	`*/`	112	`*/`
111	`private static function traiterSortieSuivantMode($mot_cle, $sortie) {`	113	`private static function traiterSortieSuivantMode($mot_cle, $sortie) {`
112	`$corps = $mot_cle.PHP_EOL.$sortie;`	114	`$corps = $mot_cle.PHP_EOL.$sortie;`
113	`if (self::getMode() == 'cli') {`	115	`if (self::getMode() == 'cli') {`
114	`$sortie = PHP_EOL.$corps.PHP_EOL;`	116	`$sortie = PHP_EOL.$corps.PHP_EOL;`
115	`} else {`	117	`} else {`
116	`$sortie = '<pre>'.$corps.'</pre>';`	118	`$sortie = '<pre>'.$corps.'</pre>';`
117	`}`	119	`}`
118	`return $sortie;`	120	`return $sortie;`
119	`}`	121	`}`
120	`}`	122	`}`
121	`?>`	123	`?>`

Subversion Repositories Applications.framework

(root)/trunk/framework/Debug.php @ 153 – Rev 153 → 167