Subversion Repositories Applications.framework

Compare Revisions

Ignore whitespace Rev 159 → Rev 297

/trunk/doc/HTMLframesConverter/Framework/GestionnaireException.html
95,21 → 95,24
<span class="disabled">Description</span> |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<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 de gestion des exceptions.</p>
<p class="description"><p>C'est un Singleton.</p><p>PHP Version 5</p></p>
<p class="description"><p>C'est un Singleton.</p></p>
<ul class="tags">
<li><span class="field">author:</span> aurelien &lt;<a href="mailto:aurelien@tela-botanica.org">aurelien@tela-botanica.org</a>&gt;</li>
<li><span class="field">version:</span> SVN: $$Id: GestionnaireException.php 158 2010-03-04 17:14:36Z jpm $$</li>
<li><span class="field">copyright:</span> 2009 Tela-Botanica</li>
<li><span class="field">author:</span> Jean-Pascal MILCENT &lt;<a href="mailto:jmp@tela-botanica.org">jmp@tela-botanica.org</a>&gt;</li>
<li><span class="field">author:</span> Aurélien PERONNET &lt;<a href="mailto:aurelien@tela-botanica.org">aurelien@tela-botanica.org</a>&gt;</li>
<li><span class="field">version:</span> $Id: GestionnaireException.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.gnu.org/licenses/gpl.html">Licence GNU-GPL</a></li>
<li><span class="field">license:</span> <a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL</a></li>
</ul>
<p class="notes">
Located in <a class="field" href="_GestionnaireException.php.html">/GestionnaireException.php</a> (line <span class="field"><a href="../__filesource/fsource_Framework__GestionnaireException.php.html#a19">19</a></span>)
Located in <a class="field" href="_GestionnaireException.php.html">/GestionnaireException.php</a> (line <span class="field"><a href="../__filesource/fsource_Framework__GestionnaireException.php.html#a18">18</a></span>)
</p>
119,20 → 122,60
</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-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_CLI" title="details" class="const-name">MODE_CLI</a> = <span class="var-type"> 'cli'</span>
 
</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> |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">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">void</span>
<a href="#configurer" title="details" class="method-name">configurer</a>
()
</div>
<div class="method-definition">
static <span class="method-result">void</span>
<a href="#formaterExceptionTxt" title="details" class="method-name">formaterExceptionTxt</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$e</span>)
</div>
<div class="method-definition">
static <span class="method-result">void</span>
<a href="#formaterExceptionXhtml" title="details" class="method-name">formaterExceptionXhtml</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$e</span>)
</div>
<div class="method-definition">
static <span class="method-result">void</span>
<a href="#gererErreur" title="details" class="method-name">gererErreur</a>
(<span class="var-type">int</span>&nbsp;<span class="var-name">$niveau</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$fichier</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$ligne</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$contexte</span>)
</div>
144,41 → 187,53
</div>
<div class="method-definition">
static <span class="method-result">void</span>
static <span class="method-result">bool</span>
<a href="#getContexte" title="details" class="method-name">getContexte</a>
()
</div>
<div class="method-definition">
static <span class="method-result">void</span>
static <span class="method-result">string</span>
<a href="#getExceptions" title="details" class="method-name">getExceptions</a>
()
</div>
<div class="method-definition">
static <span class="method-result">GestionnaireErreur</span>
<a href="#getInstance" title="details" class="method-name">getInstance</a>
static <span class="method-result">string</span>
<a href="#getExceptionsFormatees" title="details" class="method-name">getExceptionsFormatees</a>
()
</div>
<div class="method-definition">
<span class="method-result">GestionnaireException</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
(<span class="var-type">bool</span>&nbsp;<span class="var-name">0</span>)
static <span class="method-result">int</span>
<a href="#getExceptionsNbre" title="details" class="method-name">getExceptionsNbre</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#__destruct" title="details" class="method-name">__destruct</a>
static <span class="method-result">array</span>
<a href="#getExceptionsTriees" title="details" class="method-name">getExceptionsTriees</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
static <span class="method-result">void</span>
<a href="#initialiser" title="details" class="method-name">initialiser</a>
()
</div>
<div class="method-definition">
static <span class="method-result">void</span>
<a href="#setContexte" title="details" class="method-name">setContexte</a>
(<span class="var-type">bool</span>&nbsp;<span class="var-name">$contexte</span>)
</div>
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#__destruct" title="details" class="method-name">__destruct</a>
()
</div>
</div>
</div>
</div>
 
188,16 → 243,102
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-method-summary">Methods</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> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodconfigurer" id="configurer"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static configurer</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__GestionnaireException.php.html#a53">53</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Configure le Gestionnaire d'exceptions et d'erreur à partir des paramêtres de config.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static <span class="method-result">void</span>
<span class="method-name">
configurer
</span>
()
</div>
</div>
<a name="methodformaterExceptionTxt" id="formaterExceptionTxt"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static formaterExceptionTxt</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__GestionnaireException.php.html#a188">188</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Formate en texte une exception passée en paramètre.</p>
<ul class="tags">
<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">void</span>
<span class="method-name">
formaterExceptionTxt
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$e</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">Exception</span>
<span class="var-name">$e</span><span class="var-description">: l'exception à formater.</span> </li>
</ul>
</div>
<a name="methodformaterExceptionXhtml" id="formaterExceptionXhtml"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static formaterExceptionXhtml</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__GestionnaireException.php.html#a205">205</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Formate en (X)HTML une exception passée en paramètre.</p>
<ul class="tags">
<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">void</span>
<span class="method-name">
formaterExceptionXhtml
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$e</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">Exception</span>
<span class="var-name">$e</span><span class="var-description">: l'exception à formater.</span> </li>
</ul>
</div>
<a name="methodgererErreur" id="gererErreur"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static gererErreur</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__GestionnaireException.php.html#a110">110</a></span>)
<span class="method-title">static gererErreur</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__GestionnaireException.php.html#a107">107</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
238,11 → 379,12
<div class="oddrow">
<div class="method-header">
<span class="method-title">static gererException</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__GestionnaireException.php.html#a92">92</a></span>)
<span class="method-title">static gererException</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__GestionnaireException.php.html#a91">91</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Fonction de gestion des exceptions, remplace le handler par défaut</p>
<p class="short-description">Fonction de gestion des exceptions, remplace le handler par défaut.</p>
<p class="description"><p>Si une boucle génère de multiple exception (ou erreur) identique une seule sera stockée.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
267,17 → 409,18
<div class="evenrow">
<div class="method-header">
<span class="method-title">static getContexte</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__GestionnaireException.php.html#a64">64</a></span>)
<span class="method-title">static getContexte</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__GestionnaireException.php.html#a74">74</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Renvoie le booleen définissant si l'on affiche le contexte ou non</p>
<ul class="tags">
<li><span class="field">return:</span> true si on affiche le contexte sinon false.</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static <span class="method-result">void</span>
static <span class="method-result">bool</span>
<span class="method-name">
getContexte
</span>
291,18 → 434,21
<div class="oddrow">
<div class="method-header">
<span class="method-title">static getExceptions</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__GestionnaireException.php.html#a131">131</a></span>)
<span class="method-title">static getExceptions</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__GestionnaireException.php.html#a123">123</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Renvoie les exceptions au format (X)HTML</p>
<p class="description"><p>ou bien au format texte suivant le mode d'utilisation de PHP</p></p>
<p class="short-description">Renvoie les exceptions au format (X)HTML ou bien au format texte suivant le mode d'utilisation de PHP.</p>
<ul class="tags">
<li><span class="field">return:</span> les exceptions formatées en texte ou (X)HTML.</li>
<li><span class="field">see:</span> <a href="../Framework/GestionnaireException.html#methodgetExceptionsFormatees">GestionnaireException::getExceptionsFormatees()</a></li>
<li><span class="field">deprecated:</span> </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">void</span>
static <span class="method-result">string</span>
<span class="method-name">
getExceptions
</span>
312,24 → 458,25
</div>
<a name="methodgetInstance" id="getInstance"><!-- --></a>
<a name="methodgetExceptionsFormatees" id="getExceptionsFormatees"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static getInstance</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__GestionnaireException.php.html#a79">79</a></span>)
<span class="method-title">static getExceptionsFormatees</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__GestionnaireException.php.html#a132">132</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Fonction d'accès au singleton</p>
<p class="short-description">Renvoie les exceptions au format (X)HTML ou bien au format texte suivant le mode d'utilisation de PHP.</p>
<ul class="tags">
<li><span class="field">return:</span> le gestionnaire d'exceptions courant</li>
<li><span class="field">return:</span> les exceptions formatées en texte ou (X)HTML.</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">GestionnaireErreur</span>
static <span class="method-result">string</span>
<span class="method-name">
getInstance
getExceptionsFormatees
</span>
()
</div>
337,51 → 484,53
</div>
<a name="method__construct" id="__construct"><!-- --></a>
<a name="methodgetExceptionsNbre" id="getExceptionsNbre"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__GestionnaireException.php.html#a51">51</a></span>)
<span class="method-title">static getExceptionsNbre</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__GestionnaireException.php.html#a66">66</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructeur avec paramètres optionnel</p>
<p class="short-description">Renvoie le nombre d'exceptions et d'erreurs levées.</p>
<ul class="tags">
<li><span class="field">return:</span> le nombre d'exception actuellement levées</li>
<li><span class="field">see:</span> getExceptions() pour obtenir les exceptions formatées.</li>
<li><span class="field">since:</span> 0.3</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">GestionnaireException</span>
static <span class="method-result">int</span>
<span class="method-name">
__construct
getExceptionsNbre
</span>
(<span class="var-type">bool</span>&nbsp;<span class="var-name">0</span>)
()
</div>
<ul class="parameters">
<li>
<span class="var-type">bool</span>
<span class="var-name">0</span><span class="var-description">: indique si l'on veut afficher ou non le contexte des exceptions (i.e. la trace)</span> </li>
</ul>
</div>
<a name="method__destruct" id="__destruct"><!-- --></a>
<a name="methodgetExceptionsTriees" id="getExceptionsTriees"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">Destructor __destruct</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__GestionnaireException.php.html#a178">178</a></span>)
<span class="method-title">static getExceptionsTriees</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__GestionnaireException.php.html#a159">159</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Renvoie le tableau d'objets Exception générées par le script PHP triées du niveau de sévérité le plus élevé au moins élevé.</p>
<p class="description"><p>Format du tableau : array{sévérité_1 = array{Exception1, Exception2, Exception3,...}, sévérité_1 = array{Exception1, Exception2, ...}, ...}; ATTENTION : si vous utilisez cette méthode, c'est à vous de gérer l'affichage des Exceptions. Le gestionnaire d'exception n'enverra plus rien au navigateur ou à la console.</p></p>
<ul class="tags">
<li><span class="field">return:</span> le tableau trié d'objet Exception.</li>
<li><span class="field">since:</span> 0.3</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
static <span class="method-result">array</span>
<span class="method-name">
__destruct
getExceptionsTriees
</span>
()
</div>
389,14 → 538,38
</div>
<a name="methodsetContexte" id="setContexte"><!-- --></a>
<a name="methodinitialiser" id="initialiser"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setContexte</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__GestionnaireException.php.html#a72">72</a></span>)
<span class="method-title">static initialiser</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__GestionnaireException.php.html#a41">41</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Initialise le Gestionnaire d'exceptions et d'erreur sans tenir comptes des paramêtres de config.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static <span class="method-result">void</span>
<span class="method-name">
initialiser
</span>
()
</div>
</div>
<a name="methodsetContexte" id="setContexte"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static setContexte</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__GestionnaireException.php.html#a82">82</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Definit si l'on veut afficher le contexte ou non</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
403,7 → 576,7
</ul>
<div class="method-signature">
<span class="method-result">void</span>
static <span class="method-result">void</span>
<span class="method-name">
setContexte
</span>
418,13 → 591,69
</div>
<a name="method__destruct" id="__destruct"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">Destructor __destruct</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__GestionnaireException.php.html#a224">224</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Lors de la destruction de la classe si des exceptions n'ont pas été affichées, et si le débogage est à true, elles sont affichées.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
__destruct
</span>
()
</div>
</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-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<a name="constMODE_CLI" id="MODE_CLI"><!-- --></A>
<div class="evenrow">
 
<div class="const-header">
<img src="../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">MODE_CLI</span>
= <span class="const-default"> 'cli'</span>
(line <span class="line-number"><a href="../__filesource/fsource_Framework__GestionnaireException.php.html#a20">20</a></span>)
</span>
</div>
 
<!-- ========== Info from phpDoc block ========= -->
</div>
</div>
</div>
 
<p class="notes" id="credit">
Documentation generated on Thu, 04 Mar 2010 19:27:23 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Tue, 18 Jan 2011 15:01:34 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>