Subversion Repositories Applications.framework

Compare Revisions

Ignore whitespace Rev 302 → Rev 303

/tags/v0.3-aleaume/doc/HTMLframesConverter/Framework/Debug.html
New file
0,0 → 1,531
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class Debug</title>
<meta http-equiv='Content-Type' content='text/html; charset=UTF-8'/>
<link rel="stylesheet" href="../media/stylesheet.css" />
<script src="../media/lib/classTree.js"></script>
<script language="javascript" type="text/javascript">
var imgPlus = new Image();
var imgMinus = new Image();
imgPlus.src = "../media/images/plus.png";
imgMinus.src = "../media/images/minus.png";
function showNode(Node){
switch(navigator.family){
case 'nn4':
// Nav 4.x code fork...
var oTable = document.layers["span" + Node];
var oImg = document.layers["img" + Node];
break;
case 'ie4':
// IE 4/5 code fork...
var oTable = document.all["span" + Node];
var oImg = document.all["img" + Node];
break;
case 'gecko':
// Standards Compliant code fork...
var oTable = document.getElementById("span" + Node);
var oImg = document.getElementById("img" + Node);
break;
}
oImg.src = imgMinus.src;
oTable.style.display = "block";
}
function hideNode(Node){
switch(navigator.family){
case 'nn4':
// Nav 4.x code fork...
var oTable = document.layers["span" + Node];
var oImg = document.layers["img" + Node];
break;
case 'ie4':
// IE 4/5 code fork...
var oTable = document.all["span" + Node];
var oImg = document.all["img" + Node];
break;
case 'gecko':
// Standards Compliant code fork...
var oTable = document.getElementById("span" + Node);
var oImg = document.getElementById("img" + Node);
break;
}
oImg.src = imgPlus.src;
oTable.style.display = "none";
}
function nodeIsVisible(Node){
switch(navigator.family){
case 'nn4':
// Nav 4.x code fork...
var oTable = document.layers["span" + Node];
break;
case 'ie4':
// IE 4/5 code fork...
var oTable = document.all["span" + Node];
break;
case 'gecko':
// Standards Compliant code fork...
var oTable = document.getElementById("span" + Node);
break;
}
return (oTable && oTable.style.display == "block");
}
function toggleNodeVisibility(Node){
if (nodeIsVisible(Node)){
hideNode(Node);
}else{
showNode(Node);
}
}
</script>
</head>
<body>
<div class="page-body">
<h2 class="class-name">Class Debug</h2>
 
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Classe fournissant des fonctions de débogage équivalante à var_dump et print_r.</p>
<p class="description"><p>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></p>
<ul class="tags">
<li><span class="field">author:</span> Jean-Pascal MILCENT &lt;<a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a>&gt;</li>
<li><span class="field">version:</span> $Id: Debug.php 274 2010-12-28 15:37:22Z jpm $</li>
<li><span class="field">copyright:</span> Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)</li>
<li><span class="field">link:</span> /doc/framework/</li>
<li><span class="field">license:</span> <a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL-v2</a></li>
<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL-v3</a></li>
</ul>
<p class="notes">
Located in <a class="field" href="_Debug.php.html">/Debug.php</a> (line <span class="field"><a href="../__filesource/fsource_Framework__Debug.php.html#a17">17</a></span>)
</p>
<pre></pre>
</div>
</div>
 
 
<a name="sec-const-summary"></a>
<div class="info-box">
<div class="info-box-title">Class Constant Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="const-summary">
<div class="const-title">
<img src="../media/images/Constant.png" alt=" " />
<a href="#MODE_ECHO" title="details" class="const-name">MODE_ECHO</a> = <span class="var-type"> 'echo'</span>
 
</div>
<div class="const-title">
<img src="../media/images/Constant.png" alt=" " />
<a href="#MODE_ENTETE_HTTP" title="details" class="const-name">MODE_ENTETE_HTTP</a> = <span class="var-type"> 'entete_http'</span>
 
</div>
<div class="const-title">
<img src="../media/images/Constant.png" alt=" " />
<a href="#MODE_NOTICE" title="details" class="const-name">MODE_NOTICE</a> = <span class="var-type"> 'e_user_notice'</span>
 
</div>
</div>
</div>
</div>
 
<a name="sec-var-summary"></a>
<div class="info-box">
<div class="info-box-title">Variable Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
</div>
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
static <span class="var-type">mixed</span>
<a href="#$mode" title="details" class="var-name">$mode</a>
</div>
</div>
</div>
</div>
 
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
static <span class="method-result">string</span>
<a href="#dump" title="details" class="method-name">dump</a>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$variable</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$mot_cle</span> = <span class="var-default">null</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$echo</span> = <span class="var-default">false</span>])
</div>
<div class="method-definition">
static <span class="method-result">string</span>
<a href="#getMode" title="details" class="method-name">getMode</a>
()
</div>
<div class="method-definition">
static <span class="method-result">string</span>
<a href="#printr" title="details" class="method-name">printr</a>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$variable</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$mot_cle</span> = <span class="var-default">null</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$echo</span> = <span class="var-default">false</span>])
</div>
<div class="method-definition">
static <span class="method-result">string</span>
<a href="#tailleMemoireScript" title="details" class="method-name">tailleMemoireScript</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$mot_cle</span> = <span class="var-default">null</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$echo</span> = <span class="var-default">false</span>])
</div>
<div class="method-definition">
static <span class="method-result">string</span>
<a href="#tailleMemoireVar" title="details" class="method-name">tailleMemoireVar</a>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$var</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$mot_cle</span> = <span class="var-default">null</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$echo</span> = <span class="var-default">false</span>])
</div>
</div>
</div>
</div>
 
<a name="sec-vars"></a>
<div class="info-box">
<div class="info-box-title">Variables</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<a name="var$mode" id="$mode"><!-- --></A>
<div class="oddrow">
 
<div class="var-header">
<span class="var-title">
static <span class="var-type">mixed</span>
<span class="var-name">$mode</span>
= <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Debug.php.html#a35">35</a></span>)
</span>
</div>
 
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Mode de php (cli ou sapi)</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
 
</div>
 
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methoddump" id="dump"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static dump</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Debug.php.html#a58">58</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Equivalent de var_dump</p>
<ul class="tags">
<li><span class="field">return:</span> la chaine à afficher representant le dump ou null si echo</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static <span class="method-result">string</span>
<span class="method-name">
dump
</span>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$variable</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$mot_cle</span> = <span class="var-default">null</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$echo</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">mixed</span>
<span class="var-name">$variable</span><span class="var-description">: la variable à dumper</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$mot_cle</span><span class="var-description">: le mot cle à associer à la variable</span> </li>
<li>
<span class="var-type">boolean</span>
<span class="var-name">$echo</span><span class="var-description">: si true on affiche le résultat, si false on ne renvoie que la chaine sans l'afficher</span> </li>
</ul>
</div>
<a name="methodgetMode" id="getMode"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static getMode</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Debug.php.html#a44">44</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Accesseur pour le mode</p>
<ul class="tags">
<li><span class="field">return:</span> le mode de php</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static <span class="method-result">string</span>
<span class="method-name">
getMode
</span>
()
</div>
</div>
<a name="methodprintr" id="printr"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static printr</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Debug.php.html#a78">78</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Equivalent de print_r.</p>
<ul class="tags">
<li><span class="field">return:</span> la chaine contenant la variable printée ou null si echo</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static <span class="method-result">string</span>
<span class="method-name">
printr
</span>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$variable</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$mot_cle</span> = <span class="var-default">null</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$echo</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">mixed</span>
<span class="var-name">$variable</span><span class="var-description">: la variable à afficher</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$mot_cle</span><span class="var-description">: le mot cle à associer</span> </li>
<li>
<span class="var-type">boolean</span>
<span class="var-name">$echo</span><span class="var-description">: faire un echo ou non</span> </li>
</ul>
</div>
<a name="methodtailleMemoireScript" id="tailleMemoireScript"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static tailleMemoireScript</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Debug.php.html#a117">117</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Affichage d'informations sur l'espace mémoire occupé par le script PHP</p>
<ul class="tags">
<li><span class="field">return:</span> la chaine d'information sur l'espace mémoire occupé ou bien null si echo</li>
<li><span class="field">link:</span> <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></li>
<li><span class="field">since:</span> 0.3</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static <span class="method-result">string</span>
<span class="method-name">
tailleMemoireScript
</span>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$mot_cle</span> = <span class="var-default">null</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$echo</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$mot_cle</span><span class="var-description">: le mot cle à associer</span> </li>
<li>
<span class="var-type">boolean</span>
<span class="var-name">$echo</span><span class="var-description">: faire un echo ou non</span> </li>
</ul>
</div>
<a name="methodtailleMemoireVar" id="tailleMemoireVar"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static tailleMemoireVar</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Debug.php.html#a98">98</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Affichage d'informations sur l'espace mémoire occupé par une variable</p>
<ul class="tags">
<li><span class="field">return:</span> la chaine d'information sur l'espace mémoire occupé ou bien null si echo</li>
<li><span class="field">link:</span> <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></li>
<li><span class="field">since:</span> 0.3</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static <span class="method-result">string</span>
<span class="method-name">
tailleMemoireVar
</span>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$var</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$mot_cle</span> = <span class="var-default">null</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$echo</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">mixed</span>
<span class="var-name">$var</span><span class="var-description">: la variable dont on veut connaître l'empreinte mémoire.</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$mot_cle</span><span class="var-description">: le mot cle à associer</span> </li>
<li>
<span class="var-type">boolean</span>
<span class="var-name">$echo</span><span class="var-description">: faire un echo ou non</span> </li>
</ul>
</div>
</div>
</div>
 
<a name="sec-consts"></a>
<div class="info-box">
<div class="info-box-title">Class Constants</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<a name="constMODE_ECHO" id="MODE_ECHO"><!-- --></A>
<div class="oddrow">
 
<div class="const-header">
<img src="../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">MODE_ECHO</span>
= <span class="const-default"> 'echo'</span>
(line <span class="line-number"><a href="../__filesource/fsource_Framework__Debug.php.html#a21">21</a></span>)
</span>
</div>
 
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Paramètrer le fichier de config avec &quot;php:Debug::MODE_ECHO&quot; : les messages sont affichés en utilisant echo au moment où ils sont déclenchés dans le code.</p>
</div>
<a name="constMODE_ENTETE_HTTP" id="MODE_ENTETE_HTTP"><!-- --></A>
<div class="evenrow">
 
<div class="const-header">
<img src="../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">MODE_ENTETE_HTTP</span>
= <span class="const-default"> 'entete_http'</span>
(line <span class="line-number"><a href="../__filesource/fsource_Framework__Debug.php.html#a32">32</a></span>)
</span>
</div>
 
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Paramètrer le fichier de config avec &quot;php:Debug::MODE_ENTETE_HTTP&quot; : 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.</p>
<p class="description"><p>Surtout utile pour le Serveur REST.</p></p>
</div>
<a name="constMODE_NOTICE" id="MODE_NOTICE"><!-- --></A>
<div class="oddrow">
 
<div class="const-header">
<img src="../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">MODE_NOTICE</span>
= <span class="const-default"> 'e_user_notice'</span>
(line <span class="line-number"><a href="../__filesource/fsource_Framework__Debug.php.html#a26">26</a></span>)
</span>
</div>
 
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Paramètrer le fichier de config avec &quot;php:Debug::MODE_NOTICE&quot; : 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>
</div>
 
<p class="notes" id="credit">
Documentation generated on Tue, 18 Jan 2011 15:30:47 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>