Subversion Repositories Applications.framework

Compare Revisions

Ignore whitespace Rev 468 → Rev 469

/branches/v0.3-aleaume/doc/ApiGen/class-Debug.html
New file
0,0 → 1,542
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="generator" content="ApiGen 2.8.0">
 
<title>Class Debug | TBFramework - v0.3</title>
 
<script type="text/javascript" src="resources/combined.js?4205936287"></script>
<script type="text/javascript" src="elementlist.js?4111837732"></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-None.html">None</a>
</li>
<li><a href="package-PHP.html">PHP</a>
</li>
<li><a href="package-Utilitaire.html">Utilitaire</a>
</li>
</ul>
</div>
 
<hr>
 
 
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Bdd.html">Bdd</a></li>
<li><a href="class-Cache.html">Cache</a></li>
<li><a href="class-CacheSimple.html">CacheSimple</a></li>
<li><a href="class-Chronometre.html">Chronometre</a></li>
<li><a href="class-Cli.html">Cli</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-Framework.html">Framework</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-Registre.html">Registre</a></li>
<li><a href="class-RestClient.html">RestClient</a></li>
<li><a href="class-RestServeur.html">RestServeur</a></li>
<li><a href="class-RestService.html">RestService</a></li>
<li><a href="class-Script.html">Script</a></li>
<li><a href="class-SquelettePhp.html">SquelettePhp</a></li>
<li><a href="class-Url.html">Url</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 class="active">
<span>Class</span> </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>
 
<div id="content" class="class">
<h1>Class Debug</h1>
 
 
<div class="description">
<p>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.</p>
 
</div>
 
 
 
 
 
 
 
 
 
<div class="info">
<b>Package:</b> <a href="package-Framework.html">Framework</a><br>
 
<b>Category:</b>
PHP 5.2<br>
<b>Copyright:</b>
Copyright (c) 2009, Tela Botanica (<a
href="mailto:accueil&#64;tela-botanica.org">accueil&#64;<!-- -->tela-botanica.org</a>)<br>
<b>License:</b>
<a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL-v3</a><br>
<b>License:</b>
<a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL-v2</a><br>
<b>Author:</b>
Jean-Pascal MILCENT &lt;<a
href="mailto:jpm&#64;tela-botanica.org">jpm&#64;<!-- -->tela-botanica.org</a>&gt;<br>
<b>Version:</b>
$Id: Debug.php 366 2011-09-30 08:20:45Z jpm $<br>
<b>Link:</b>
/doc/framework/<br>
<b>Located at</b> <a href="source-class-Debug.html#3-191" title="Go to source code">Debug.php</a><br>
</div>
 
 
 
<table class="summary" id="methods">
<caption>Methods summary</caption>
<tr data-order="getMode" id="_getMode">
 
<td class="attributes"><code>
public static
string
</code>
</td>
 
<td class="name"><div>
<a class="anchor" href="#_getMode">#</a>
<code><a href="source-class-Debug.html#40-49" title="Go to source code">getMode</a>( )</code>
 
<div class="description short">
<p>Accesseur pour le mode</p>
 
</div>
 
<div class="description detailed hidden">
<p>Accesseur pour le mode</p>
 
 
 
 
<h4>Returns</h4>
<div class="list">
<code>string</code><br>le mode de php<br>
</div>
 
 
 
 
</div>
</div></td>
</tr>
<tr data-order="dump" id="_dump">
 
<td class="attributes"><code>
public static
string
</code>
</td>
 
<td class="name"><div>
<a class="anchor" href="#_dump">#</a>
<code><a href="source-class-Debug.html#51-69" title="Go to source code">dump</a>( <span>mixed <var>$variable</var></span>, <span>string <var>$mot_cle</var> = <span class="php-keyword1">null</span></span>, <span>boolean <var>$echo</var> = <span class="php-keyword1">false</span></span> )</code>
 
<div class="description short">
<p>Equivalent de var_dump</p>
 
</div>
 
<div class="description detailed hidden">
<p>Equivalent de var_dump</p>
 
 
 
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$variable</var></dt>
<dd><code>mixed</code><br>$variable la variable à dumper</dd>
<dt><var>$mot_cle</var></dt>
<dd><code>string</code><br>$mot_cle le mot cle à associer à la variable</dd>
<dt><var>$echo</var></dt>
<dd><code>boolean</code><br>$echo si true on affiche le résultat, si false on ne renvoie que la chaine sans
l'afficher</dd>
</dl></div>
 
<h4>Returns</h4>
<div class="list">
<code>string</code><br>la chaine à afficher representant le dump ou null si echo<br>
</div>
 
 
 
 
</div>
</div></td>
</tr>
<tr data-order="printr" id="_printr">
 
<td class="attributes"><code>
public static
string
</code>
</td>
 
<td class="name"><div>
<a class="anchor" href="#_printr">#</a>
<code><a href="source-class-Debug.html#71-84" title="Go to source code">printr</a>( <span>mixed <var>$variable</var></span>, <span>string <var>$mot_cle</var> = <span class="php-keyword1">null</span></span>, <span>boolean <var>$echo</var> = <span class="php-keyword1">false</span></span> )</code>
 
<div class="description short">
<p>Equivalent de print_r.</p>
 
</div>
 
<div class="description detailed hidden">
<p>Equivalent de print_r.</p>
 
 
 
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$variable</var></dt>
<dd><code>mixed</code><br>$variable la variable à afficher</dd>
<dt><var>$mot_cle</var></dt>
<dd><code>string</code><br>$mot_cle le mot cle à associer</dd>
<dt><var>$echo</var></dt>
<dd><code>boolean</code><br>$echo faire un echo ou non</dd>
</dl></div>
 
<h4>Returns</h4>
<div class="list">
<code>string</code><br>la chaine contenant la variable printée ou null si echo<br>
</div>
 
 
 
 
</div>
</div></td>
</tr>
<tr data-order="tailleMemoireVar" id="_tailleMemoireVar">
 
<td class="attributes"><code>
public static
string
</code>
</td>
 
<td class="name"><div>
<a class="anchor" href="#_tailleMemoireVar">#</a>
<code><a href="source-class-Debug.html#86-104" title="Go to source code">tailleMemoireVar</a>( <span>mixed <var>$var</var></span>, <span>string <var>$mot_cle</var> = <span class="php-keyword1">null</span></span>, <span>boolean <var>$echo</var> = <span class="php-keyword1">false</span></span> )</code>
 
<div class="description short">
<p>Affichage d'informations sur l'espace mémoire occupé par une variable</p>
 
</div>
 
<div class="description detailed hidden">
<p>Affichage d'informations sur l'espace mémoire occupé par une variable</p>
 
 
 
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$var</var></dt>
<dd><code>mixed</code><br>$var la variable dont on veut connaître l'empreinte mémoire.</dd>
<dt><var>$mot_cle</var></dt>
<dd><code>string</code><br>$mot_cle le mot cle à associer</dd>
<dt><var>$echo</var></dt>
<dd><code>boolean</code><br>$echo faire un echo ou non</dd>
</dl></div>
 
<h4>Returns</h4>
<div class="list">
<code>string</code><br>la chaine d'information sur l'espace mémoire occupé ou bien null si echo<br>
</div>
 
 
<h4>Since</h4>
<div class="list">
0.3<br>
</div>
<h4>Link</h4>
<div class="list">
<a href="http://forum.webmaster-rank.info/developpement-site/code-taille-memoire-d-une-variable-en-php-t1344.html">http://forum.webmaster-rank.info/developpement-site/code-taille-memoire-d-une-variable-en-php-t1344.html</a><br>
</div>
 
 
</div>
</div></td>
</tr>
<tr data-order="tailleMemoireScript" id="_tailleMemoireScript">
 
<td class="attributes"><code>
public static
string
</code>
</td>
 
<td class="name"><div>
<a class="anchor" href="#_tailleMemoireScript">#</a>
<code><a href="source-class-Debug.html#106-130" title="Go to source code">tailleMemoireScript</a>( <span>string <var>$mot_cle</var> = <span class="php-keyword1">null</span></span>, <span>boolean <var>$echo</var> = <span class="php-keyword1">false</span></span> )</code>
 
<div class="description short">
<p>Affichage d'informations sur l'espace mémoire occupé par le script PHP</p>
 
</div>
 
<div class="description detailed hidden">
<p>Affichage d'informations sur l'espace mémoire occupé par le script PHP</p>
 
 
 
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$mot_cle</var></dt>
<dd><code>string</code><br>$mot_cle le mot cle à associer</dd>
<dt><var>$echo</var></dt>
<dd><code>boolean</code><br>$echo faire un echo ou non</dd>
</dl></div>
 
<h4>Returns</h4>
<div class="list">
<code>string</code><br>la chaine d'information sur l'espace mémoire occupé ou bien null si echo<br>
</div>
 
 
<h4>Since</h4>
<div class="list">
0.3<br>
</div>
<h4>Link</h4>
<div class="list">
<a href="http://forum.webmaster-rank.info/developpement-site/code-taille-memoire-d-une-variable-en-php-t1344.html">http://forum.webmaster-rank.info/developpement-site/code-taille-memoire-d-une-variable-en-php-t1344.html</a><br>
</div>
 
 
</div>
</div></td>
</tr>
</table>
 
 
 
 
 
 
 
 
<table class="summary" id="constants">
<caption>Constants summary</caption>
<tr data-order="MODE_ECHO" id="MODE_ECHO">
 
<td class="attributes"><code>string</code></td>
<td class="name"><code>
<a href="source-class-Debug.html#19-21" title="Go to source code"><b>MODE_ECHO</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'echo'</span></code></td>
<td class="description"><div>
<a href="#MODE_ECHO" class="anchor">#</a>
 
<div class="description short">
<p>Paramètrer le fichier de config avec "php:Debug::MODE_ECHO" : les messages
sont affichés en utilisant echo au moment où ils sont déclenchés dans le
code.</p>
 
</div>
 
<div class="description detailed hidden">
<p>Paramètrer le fichier de config avec "php:Debug::MODE_ECHO" : les messages
sont affichés en utilisant echo au moment où ils sont déclenchés dans le
code.</p>
 
 
</div>
</div></td>
</tr>
<tr data-order="MODE_NOTICE" id="MODE_NOTICE">
 
<td class="attributes"><code>string</code></td>
<td class="name"><code>
<a href="source-class-Debug.html#23-26" title="Go to source code"><b>MODE_NOTICE</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'e_user_notice'</span></code></td>
<td class="description"><div>
<a href="#MODE_NOTICE" class="anchor">#</a>
 
<div class="description short">
<p>Paramètrer le fichier de config avec "php:Debug::MODE_NOTICE" : les message
sont stockés par le gestionnaire d'exception sous forme d'erreur de type
E_USER_NOTICE et sont renvoyés sur la sortie standard à la fin de l'execution
du programme (via echo).</p>
 
</div>
 
<div class="description detailed hidden">
<p>Paramètrer le fichier de config avec "php:Debug::MODE_NOTICE" : les message
sont stockés par le gestionnaire d'exception sous forme d'erreur de type
E_USER_NOTICE et sont renvoyés sur la sortie standard à la fin de l'execution
du programme (via echo).</p>
 
 
</div>
</div></td>
</tr>
<tr data-order="MODE_ENTETE_HTTP" id="MODE_ENTETE_HTTP">
 
<td class="attributes"><code>string</code></td>
<td class="name"><code>
<a href="source-class-Debug.html#28-32" title="Go to source code"><b>MODE_ENTETE_HTTP</b></a>
</code></td>
<td class="value"><code><span class="php-quote">'entete_http'</span></code></td>
<td class="description"><div>
<a href="#MODE_ENTETE_HTTP" class="anchor">#</a>
 
<div class="description short">
<p>Paramètrer le fichier de config avec "php:Debug::MODE_ENTETE_HTTP" : les
message sont stockés par le gestionnaire d'exception sous forme d'erreur de
type E_USER_NOTICE et sont renvoyés dans un entête HTTP
(X_REST_DEBOGAGE_MESSAGES) à la fin de l'execution du programme. Surtout utile
pour le Serveur REST.</p>
 
</div>
 
<div class="description detailed hidden">
<p>Paramètrer le fichier de config avec "php:Debug::MODE_ENTETE_HTTP" : les
message sont stockés par le gestionnaire d'exception sous forme d'erreur de
type E_USER_NOTICE et sont renvoyés dans un entête HTTP
(X_REST_DEBOGAGE_MESSAGES) à la fin de l'execution du programme. Surtout utile
pour le Serveur REST.</p>
 
 
</div>
</div></td>
</tr>
</table>
 
 
 
 
<table class="summary" id="properties">
<caption>Properties summary</caption>
<tr data-order="mode" id="$mode">
<td class="attributes"><code>
protected static
mixed
</code></td>
 
<td class="name">
<a href="source-class-Debug.html#34-35" title="Go to source code"><var>$mode</var></a>
</td>
<td class="value"><code><span class="php-keyword1">null</span></code></td>
<td class="description"><div>
<a href="#$mode" class="anchor">#</a>
 
<div class="description short">
<p>Mode de php (cli ou sapi)</p>
 
</div>
 
<div class="description detailed hidden">
<p>Mode de php (cli ou sapi)</p>
 
 
</div>
</div></td>
</tr>
</table>
 
 
 
 
 
 
</div>
 
<div id="footer">
TBFramework - v0.3 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>