Subversion Repositories Applications.framework

Compare Revisions

Ignore whitespace Rev 302 → Rev 303

/tags/v0.3-aleaume/doc/HTMLframesConverter/Framework/GestionnaireException.html
New file
0,0 → 1,658
<!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 GestionnaireException</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 GestionnaireException</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-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 de gestion des exceptions.</p>
<p class="description"><p>C'est un Singleton.</p></p>
<ul class="tags">
<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#a18">18</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-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> |
<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>
<div class="method-definition">
static <span class="method-result">void</span>
<a href="#gererException" title="details" class="method-name">gererException</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$e</span>)
</div>
<div class="method-definition">
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">string</span>
<a href="#getExceptions" title="details" class="method-name">getExceptions</a>
()
</div>
<div class="method-definition">
static <span class="method-result">string</span>
<a href="#getExceptionsFormatees" title="details" class="method-name">getExceptionsFormatees</a>
()
</div>
<div class="method-definition">
static <span class="method-result">int</span>
<a href="#getExceptionsNbre" title="details" class="method-name">getExceptionsNbre</a>
()
</div>
<div class="method-definition">
static <span class="method-result">array</span>
<a href="#getExceptionsTriees" title="details" class="method-name">getExceptionsTriees</a>
()
</div>
<div class="method-definition">
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 class="method-definition">
<span class="method-result">void</span>
<a href="#__destruct" title="details" class="method-name">__destruct</a>
()
</div>
</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-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#a107">107</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gère les erreurs en les convertissant en exceptions (remplace la fonction gestion d'erreurs native de php)</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">
gererErreur
</span>
(<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>
<ul class="parameters">
<li>
<span class="var-type">int</span>
<span class="var-name">$niveau</span><span class="var-description">: le niveau de l'erreur</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$message</span><span class="var-description">: le message associé à l'erreur</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$fichier</span><span class="var-description">: le nom du fichier où l'erreur s'est produite</span> </li>
<li>
<span class="var-type">int</span>
<span class="var-name">$ligne</span><span class="var-description">: la ligne où l'erreur s'est produite</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$contexte</span><span class="var-description">: le contexte associé à l'erreur</span> </li>
</ul>
</div>
<a name="methodgererException" id="gererException"><!-- --></a>
<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#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="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>
<div class="method-signature">
static <span class="method-result">void</span>
<span class="method-name">
gererException
</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 à traiter</span> </li>
</ul>
</div>
<a name="methodgetContexte" id="getContexte"><!-- --></a>
<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#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">bool</span>
<span class="method-name">
getContexte
</span>
()
</div>
</div>
<a name="methodgetExceptions" id="getExceptions"><!-- --></a>
<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#a123">123</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<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">string</span>
<span class="method-name">
getExceptions
</span>
()
</div>
</div>
<a name="methodgetExceptionsFormatees" id="getExceptionsFormatees"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<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">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">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">
getExceptionsFormatees
</span>
()
</div>
</div>
<a name="methodgetExceptionsNbre" id="getExceptionsNbre"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<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">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">
static <span class="method-result">int</span>
<span class="method-name">
getExceptionsNbre
</span>
()
</div>
</div>
<a name="methodgetExceptionsTriees" id="getExceptionsTriees"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<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">
static <span class="method-result">array</span>
<span class="method-name">
getExceptionsTriees
</span>
()
</div>
</div>
<a name="methodinitialiser" id="initialiser"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<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>
</ul>
<div class="method-signature">
static <span class="method-result">void</span>
<span class="method-name">
setContexte
</span>
(<span class="var-type">bool</span>&nbsp;<span class="var-name">$contexte</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">bool</span>
<span class="var-name">$contexte</span><span class="var-description">: true si on veut afficher le contexte, false sinon, par défaut vaut false</span> </li>
</ul>
</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 Tue, 18 Jan 2011 15:30:50 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>