Rev 467 | Blame | Compare with Previous | Last modification | View Log | RSS feed
<!DOCTYPE html><html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="generator" content="ApiGen 2.8.0"><meta name="robots" content="noindex"><title>File Debug.php | TBFramework - v0.2</title><script type="text/javascript" src="resources/combined.js?4205936287"></script><script type="text/javascript" src="elementlist.js?1835392179"></script><link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360"></head><body><div id="left"><div id="menu"><a href="index.html" title="Overview"><span>Overview</span></a><div id="groups"><h3>Packages</h3><ul><li class="active"><a href="package-Framework.html">Framework</a></li><li><a href="package-PHP.html">PHP</a></li></ul></div><hr><div id="elements"><h3>Classes</h3><ul><li><a href="class-Application.html">Application</a></li><li><a href="class-Chronometre.html">Chronometre</a></li><li><a href="class-Config.html">Config</a></li><li><a href="class-Controleur.html">Controleur</a></li><li class="active"><a href="class-Debug.html">Debug</a></li><li><a href="class-GestionnaireException.html">GestionnaireException</a></li><li><a href="class-I18n.html">I18n</a></li><li><a href="class-Log.html">Log</a></li><li><a href="class-Modele.html">Modele</a></li><li><a href="class-Registre.html">Registre</a></li><li><a href="class-SquelettePhp.html">SquelettePhp</a></li><li><a href="class-Url.html">Url</a></li></ul><h3>Functions</h3><ul><li><a href="function-autoloadAppliDefaut.html">autoloadAppliDefaut</a></li><li><a href="function-autoloadFw.html">autoloadFw</a></li></ul></div></div></div><div id="splitter"></div><div id="right"><div id="rightInner"><form id="search"><input type="hidden" name="cx" value=""><input type="hidden" name="ie" value="UTF-8"><input type="text" name="q" class="text"><input type="submit" value="Search"></form><div id="navigation"><ul><li><a href="index.html" title="Overview"><span>Overview</span></a></li><li><a href="package-Framework.html" title="Summary of Framework"><span>Package</span></a></li><li><a href="class-Debug.html" title="Summary of Debug"><span>Class</span></a></li></ul><ul><li><a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a></li><li><a href="deprecated.html" title="List of deprecated elements"><span>Deprecated</span></a></li><li><a href="todo.html" title="Todo list"><span>Todo</span></a></li></ul><ul></ul></div><pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span></span><span id="2" class="l"><a class="l" href="#2"> 2: </a><span class="php-comment">// declare(encoding='UTF-8');</span></span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-comment">/**</span></span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-comment"> * Classe fournissant des fonctions de débogage équivalante à var_dump et print_r.</span></span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment"> * L'affichage et l'utilisation de ces fonctions sont améliorés via cette classe.</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> * Cette classe est inspirée de la classe Zend_Debug.</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> *</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> * @category PHP 5.2</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> * @package Framework</span></span><span id="10" class="l"><a class="l" href="#10"> 10: </a><span class="php-comment"> * @author Jean-Pascal MILCENT <jpm@tela-botanica.org></span></span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment"> * @copyright Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * @license GNU-GPL-v3 <http://www.gnu.org/licenses/gpl.html></span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> * @license CECILL-v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt></span></span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-comment"> */</span></span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-keyword1">class</span> <a id="Debug" href="#Debug">Debug</a> {</span><span id="16" class="l"><a class="l" href="#16"> 16: </a></span><span id="17" class="l"><a class="l" href="#17"> 17: </a> <span class="php-keyword1">const</span> <a id="MODE_ECHO" href="#MODE_ECHO">MODE_ECHO</a> = <span class="php-quote">'echo'</span>;</span><span id="18" class="l"><a class="l" href="#18"> 18: </a> <span class="php-keyword1">const</span> <a id="MODE_NOTICE" href="#MODE_NOTICE">MODE_NOTICE</a> = <span class="php-quote">'e_user_notice'</span>;</span><span id="19" class="l"><a class="l" href="#19"> 19: </a></span><span id="20" class="l"><a class="l" href="#20"> 20: </a> <span class="php-comment">/**</span></span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment"> * mode de php (cli ou sapi)</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> */</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a> <span class="php-keyword1">protected</span> <span class="php-keyword1">static</span> <span class="php-var"><a id="$mode" href="#$mode">$mode</a></span> = <span class="php-keyword1">null</span>;</span><span id="24" class="l"><a class="l" href="#24"> 24: </a></span><span id="25" class="l"><a class="l" href="#25"> 25: </a> <span class="php-comment">/**</span></span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment"> * Accesseur pour le mode</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * @return string le mode de php</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> */</span></span><span id="29" class="l"><a class="l" href="#29"> 29: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_getMode" href="#_getMode">getMode</a>() {</span><span id="30" class="l"><a class="l" href="#30"> 30: </a> <span class="php-keyword1">if</span> (self::<span class="php-var">$mode</span> === <span class="php-keyword1">null</span>) {</span><span id="31" class="l"><a class="l" href="#31"> 31: </a> self::<span class="php-var">$mode</span> = PHP_SAPI;</span><span id="32" class="l"><a class="l" href="#32"> 32: </a> }</span><span id="33" class="l"><a class="l" href="#33"> 33: </a> <span class="php-keyword1">return</span> self::<span class="php-var">$mode</span>;</span><span id="34" class="l"><a class="l" href="#34"> 34: </a> }</span><span id="35" class="l"><a class="l" href="#35"> 35: </a></span><span id="36" class="l"><a class="l" href="#36"> 36: </a> <span class="php-comment">/**</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * Equivalent de var_dump</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> * @param mixed $variable la variable à dumper</span></span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-comment"> * @param string $mot_cle le mot cle à associer à la variable</span></span><span id="40" class="l"><a class="l" href="#40"> 40: </a><span class="php-comment"> * @param boolean $echo si true on affiche le résultat, si false on ne renvoie que la chaine sans l'afficher</span></span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment"> * @return string la chaine à afficher representant le dump ou null si echo</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> */</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_dump" href="#_dump">dump</a>(<span class="php-var">$variable</span>, <span class="php-var">$mot_cle</span> = <span class="php-keyword1">null</span>, <span class="php-var">$echo</span> = <span class="php-keyword1">false</span>) {</span><span id="44" class="l"><a class="l" href="#44"> 44: </a> <span class="php-comment">// var_dump de la variable dans un buffer et récupération de la sortie</span></span><span id="45" class="l"><a class="l" href="#45"> 45: </a> <span class="php-keyword2">ob_start</span>();</span><span id="46" class="l"><a class="l" href="#46"> 46: </a> <span class="php-keyword2">var_dump</span>(<span class="php-var">$variable</span>);</span><span id="47" class="l"><a class="l" href="#47"> 47: </a> <span class="php-var">$sortie</span> = <span class="php-keyword2">ob_get_clean</span>();</span><span id="48" class="l"><a class="l" href="#48"> 48: </a></span><span id="49" class="l"><a class="l" href="#49"> 49: </a> <span class="php-comment">// Pré-traitement de la sortie</span></span><span id="50" class="l"><a class="l" href="#50"> 50: </a> <span class="php-var">$sortie</span> = <span class="php-keyword2">preg_replace</span>(<span class="php-quote">"/\]\=\>\n(\s+)/m"</span>, <span class="php-quote">"] => "</span>, <span class="php-var">$sortie</span>);</span><span id="51" class="l"><a class="l" href="#51"> 51: </a></span><span id="52" class="l"><a class="l" href="#52"> 52: </a> <span class="php-comment">// Traitement général du débogage</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a> <span class="php-keyword1">return</span> self::traiterDebogage(<span class="php-var">$mot_cle</span>, <span class="php-var">$sortie</span>, <span class="php-var">$echo</span>);</span><span id="54" class="l"><a class="l" href="#54"> 54: </a> }</span><span id="55" class="l"><a class="l" href="#55"> 55: </a></span><span id="56" class="l"><a class="l" href="#56"> 56: </a> <span class="php-comment">/**</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * Equivalent de print_r.</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> * @param mixed $variable la variable à afficher</span></span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-comment"> * @param string $mot_cle le mot cle à associer</span></span><span id="60" class="l"><a class="l" href="#60"> 60: </a><span class="php-comment"> * @param boolean $echo faire un echo ou non</span></span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment"> * @return string la chaine contenant la variable printée ou null si echo</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> */</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_printr" href="#_printr">printr</a>(<span class="php-var">$variable</span>, <span class="php-var">$mot_cle</span> = <span class="php-keyword1">null</span>, <span class="php-var">$echo</span> = <span class="php-keyword1">false</span>) {</span><span id="64" class="l"><a class="l" href="#64"> 64: </a> <span class="php-comment">// Récupération de la sortie</span></span><span id="65" class="l"><a class="l" href="#65"> 65: </a> <span class="php-var">$sortie</span> = <span class="php-keyword2">print_r</span>(<span class="php-var">$variable</span>, <span class="php-keyword1">true</span>);</span><span id="66" class="l"><a class="l" href="#66"> 66: </a></span><span id="67" class="l"><a class="l" href="#67"> 67: </a> <span class="php-comment">// Traitement général du débogage</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a> <span class="php-keyword1">return</span> self::traiterDebogage(<span class="php-var">$mot_cle</span>, <span class="php-var">$sortie</span>, <span class="php-var">$echo</span>);</span><span id="69" class="l"><a class="l" href="#69"> 69: </a> }</span><span id="70" class="l"><a class="l" href="#70"> 70: </a></span><span id="71" class="l"><a class="l" href="#71"> 71: </a> <span class="php-comment">/**</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * Traite une chaine de débogage et les mots clés associés</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> * @param string $mot_cle le mot à associer à la chaine</span></span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-comment"> * @param string $sortie le chaine de debogage</span></span><span id="75" class="l"><a class="l" href="#75"> 75: </a><span class="php-comment"> * @param boolean $echo faire un echo du resultat ou non</span></span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment"> * @return string la chaine de debogage formatée ou bien null si echo</span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment"> */</span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_traiterDebogage" href="#_traiterDebogage">traiterDebogage</a>(<span class="php-var">$mot_cle</span>, <span class="php-var">$sortie</span>, <span class="php-var">$echo</span>) {</span><span id="79" class="l"><a class="l" href="#79"> 79: </a> <span class="php-comment">// Formate le mot-clé</span></span><span id="80" class="l"><a class="l" href="#80"> 80: </a> <span class="php-var">$mot_cle</span> = self::formaterMotCle(<span class="php-var">$mot_cle</span>);</span><span id="81" class="l"><a class="l" href="#81"> 81: </a></span><span id="82" class="l"><a class="l" href="#82"> 82: </a> <span class="php-comment">// Traitement de la sortie</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a> <span class="php-var">$sortie</span> = self::traiterSortieSuivantMode(<span class="php-var">$mot_cle</span>, <span class="php-var">$sortie</span>);</span><span id="84" class="l"><a class="l" href="#84"> 84: </a></span><span id="85" class="l"><a class="l" href="#85"> 85: </a> <span class="php-comment">// Affichage et/ou retour</span></span><span id="86" class="l"><a class="l" href="#86"> 86: </a> self::verifierParametresConfig();</span><span id="87" class="l"><a class="l" href="#87"> 87: </a> <span class="php-keyword1">if</span> (Config::get(<span class="php-quote">'fw_debogage'</span>) == <span class="php-keyword1">true</span>) {</span><span id="88" class="l"><a class="l" href="#88"> 88: </a> <span class="php-keyword1">if</span> (<span class="php-var">$echo</span> === <span class="php-keyword1">true</span> || Config::get(<span class="php-quote">'fw_debogage_mode'</span>) == self::MODE_ECHO) {</span><span id="89" class="l"><a class="l" href="#89"> 89: </a> <span class="php-keyword1">echo</span> <span class="php-var">$sortie</span>;</span><span id="90" class="l"><a class="l" href="#90"> 90: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">null</span>;</span><span id="91" class="l"><a class="l" href="#91"> 91: </a> } <span class="php-keyword1">else</span> <span class="php-keyword1">if</span> (Config::get(<span class="php-quote">'fw_debogage_mode'</span>) == self::MODE_NOTICE) {</span><span id="92" class="l"><a class="l" href="#92"> 92: </a> <span class="php-keyword2">trigger_error</span>(<span class="php-var">$sortie</span>, E_USER_NOTICE);</span><span id="93" class="l"><a class="l" href="#93"> 93: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">null</span>;</span><span id="94" class="l"><a class="l" href="#94"> 94: </a> } <span class="php-keyword1">else</span> {</span><span id="95" class="l"><a class="l" href="#95"> 95: </a> <span class="php-keyword1">return</span> <span class="php-var">$sortie</span>;</span><span id="96" class="l"><a class="l" href="#96"> 96: </a> }</span><span id="97" class="l"><a class="l" href="#97"> 97: </a> }</span><span id="98" class="l"><a class="l" href="#98"> 98: </a> }</span><span id="99" class="l"><a class="l" href="#99"> 99: </a></span><span id="100" class="l"><a class="l" href="#100">100: </a> <span class="php-comment">/**</span></span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment"> * formate un mot clé donné</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * @param string $mot_cle le mot clé à formaté</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> * @return string le mot clé formaté ou bien un chaine vide le mot clé est null ou vide</span></span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-comment"> */</span></span><span id="105" class="l"><a class="l" href="#105">105: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_formaterMotCle" href="#_formaterMotCle">formaterMotCle</a>(<span class="php-var">$mot_cle</span>) {</span><span id="106" class="l"><a class="l" href="#106">106: </a> <span class="php-keyword1">return</span> (<span class="php-var">$mot_cle</span> === <span class="php-keyword1">null</span>) ? <span class="php-quote">''</span> : <span class="php-keyword2">rtrim</span>(<span class="php-var">$mot_cle</span>).<span class="php-quote">' '</span>;</span><span id="107" class="l"><a class="l" href="#107">107: </a> }</span><span id="108" class="l"><a class="l" href="#108">108: </a></span><span id="109" class="l"><a class="l" href="#109">109: </a> <span class="php-comment">/**</span></span><span id="110" class="l"><a class="l" href="#110">110: </a><span class="php-comment"> * traite la sortie de la chaine de débogage suivant le mode de php</span></span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment"> * @param string $mot_cle le mot clé associé à la chaine</span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> * @param string $sortie la chaine de débogage</span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> * @return string la sortie formatée pour le mode en cours</span></span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-comment"> */</span></span><span id="115" class="l"><a class="l" href="#115">115: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_traiterSortieSuivantMode" href="#_traiterSortieSuivantMode">traiterSortieSuivantMode</a>(<span class="php-var">$mot_cle</span>, <span class="php-var">$sortie</span>) {</span><span id="116" class="l"><a class="l" href="#116">116: </a> <span class="php-var">$corps</span> = <span class="php-var">$mot_cle</span>.PHP_EOL.<span class="php-var">$sortie</span>;</span><span id="117" class="l"><a class="l" href="#117">117: </a> <span class="php-keyword1">if</span> (self::getMode() == <span class="php-quote">'cli'</span>) {</span><span id="118" class="l"><a class="l" href="#118">118: </a> <span class="php-var">$sortie</span> = PHP_EOL.<span class="php-var">$corps</span>.PHP_EOL;</span><span id="119" class="l"><a class="l" href="#119">119: </a> } <span class="php-keyword1">else</span> {</span><span id="120" class="l"><a class="l" href="#120">120: </a> <span class="php-var">$sortie</span> = <span class="php-quote">'<pre>'</span>.<span class="php-var">$corps</span>.<span class="php-quote">'</pre>'</span>;</span><span id="121" class="l"><a class="l" href="#121">121: </a> }</span><span id="122" class="l"><a class="l" href="#122">122: </a> <span class="php-keyword1">return</span> <span class="php-var">$sortie</span>;</span><span id="123" class="l"><a class="l" href="#123">123: </a> }</span><span id="124" class="l"><a class="l" href="#124">124: </a></span><span id="125" class="l"><a class="l" href="#125">125: </a> <span class="php-comment">/**</span></span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment"> * Vérifie que tous les paramêtres de config nécessaires au fonctionnement de cette classe existe dans les fichiers</span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment"> * de configurations.</span></span><span id="128" class="l"><a class="l" href="#128">128: </a><span class="php-comment"> */</span></span><span id="129" class="l"><a class="l" href="#129">129: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_verifierParametresConfig" href="#_verifierParametresConfig">verifierParametresConfig</a>() {</span><span id="130" class="l"><a class="l" href="#130">130: </a> <span class="php-var">$ok</span> = <span class="php-keyword1">true</span>;</span><span id="131" class="l"><a class="l" href="#131">131: </a> <span class="php-var">$parametres</span> = <span class="php-keyword1">array</span>(<span class="php-quote">'fw_debogage'</span>, <span class="php-quote">'fw_debogage_mode'</span>);</span><span id="132" class="l"><a class="l" href="#132">132: </a> <span class="php-keyword1">foreach</span> (<span class="php-var">$parametres</span> <span class="php-keyword1">as</span> <span class="php-var">$param</span>) {</span><span id="133" class="l"><a class="l" href="#133">133: </a> <span class="php-keyword1">if</span> (<span class="php-keyword2">is_null</span>(Config::get(<span class="php-var">$param</span>))) {</span><span id="134" class="l"><a class="l" href="#134">134: </a> <span class="php-var">$classe</span> = <span class="php-keyword2">get_class</span>();</span><span id="135" class="l"><a class="l" href="#135">135: </a> <span class="php-var">$m</span> = <span class="php-quote">"L'utilisation de la classe </span><span class="php-var">$classe</span><span class="php-quote"> nécessite de définir '</span><span class="php-var">$param</span><span class="php-quote">' dans un fichier de configuration."</span>;</span><span id="136" class="l"><a class="l" href="#136">136: </a> <span class="php-keyword2">trigger_error</span>(<span class="php-var">$m</span>, E_USER_WARNING);</span><span id="137" class="l"><a class="l" href="#137">137: </a> <span class="php-var">$ok</span> = <span class="php-keyword1">false</span>;</span><span id="138" class="l"><a class="l" href="#138">138: </a> }</span><span id="139" class="l"><a class="l" href="#139">139: </a> }</span><span id="140" class="l"><a class="l" href="#140">140: </a> <span class="php-keyword1">return</span> <span class="php-var">$ok</span>;</span><span id="141" class="l"><a class="l" href="#141">141: </a> }</span><span id="142" class="l"><a class="l" href="#142">142: </a>}</span><span id="143" class="l"><a class="l" href="#143">143: </a></span><span class="xlang">?></span></code></pre><div id="footer">TBFramework - v0.2 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a></div></div></div></body></html>