Subversion Repositories Applications.framework

Rev

Rev 129 | Rev 167 | 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 
 *
8 
 * PHP version 5
9 
 *
10 
 * @category Debogage
11 
 * @package Framework
12 
 // Auteur principal :
13 
 * @author Jean-Pascal MILCENT <jpm@tela-botanica.org>
14 
 // Autres auteurs :
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>
17 
 * @version $$Id: Debug.php 153 2010-03-04 10:48:32Z jpm $$
18 
 * @copyright 1999-2009 Tela Botanica (accueil@tela-botanica.org)
19 
 */
97 jpm 20 
class Debug {
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 
	 */
97 jpm 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
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 
	/**
59 
	 * Equivalent de print_r
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 
	 */
97 jpm 65 
	public static function printr($variable, $mot_cle = null, $echo = true) {
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
88 
		if ($echo) {
89 
			echo $sortie;
90 
			return null;
91 
		} else {
92 
			return $sortie;
93 
		}
94 
	}
95 
 
129 aurelien 96 
	/**
97 
	 * formate un mot clé donné
98 
	 * @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
100 
	 */
97 jpm 101 
	private static function formaterMotCle($mot_cle) {
102 
		return ($mot_cle === null) ? '' : rtrim($mot_cle).' ';
103 
	}
104 
 
129 aurelien 105 
	/**
106 
	 * 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
108 
	 * @param string  $sortie la chaine de débogage
109 
	 * @return string la sortie formatée pour le mode en cours
110 
	 */
97 jpm 111 
	private static function traiterSortieSuivantMode($mot_cle, $sortie) {
112 
		$corps = $mot_cle.PHP_EOL.$sortie;
113 
		if (self::getMode() == 'cli') {
114 
			$sortie = PHP_EOL.$corps.PHP_EOL;
115 
		} else {
116 
			$sortie = '<pre>'.$corps.'</pre>';
117 
		}
118 
		return $sortie;
119 
	}
120 
}
121 
?>