Subversion Repositories Applications.framework

Compare Revisions

Ignore whitespace Rev 302 → Rev 303

/tags/v0.3-aleaume/doc/HTMLframesConverter/Framework/Log.html
New file
0,0 → 1,361
<!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 Log</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 Log</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>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Classe permettant de logger des messages dans les fichier situés dans le dossier de log.</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">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: Log.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="_Log.php.html">/Log.php</a> (line <span class="field"><a href="../__filesource/fsource_Framework__Log.php.html#a16">16</a></span>)
</p>
<pre></pre>
</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>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
static <span class="method-result">void</span>
<a href="#ajouterEntree" title="details" class="method-name">ajouterEntree</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$nomFichier</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$entree</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$mode</span> = <span class="var-default">'a+'</span>])
</div>
<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="#initialiser" title="details" class="method-name">initialiser</a>
()
</div>
<div class="method-definition">
static <span class="method-result">boolean</span>
<a href="#verifierOuvrirFichier" title="details" class="method-name">verifierOuvrirFichier</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$nomFichier</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$mode</span>)
</div>
<div class="method-definition">
static <span class="method-result">void</span>
<a href="#viderLog" title="details" class="method-name">viderLog</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$nomFichier</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-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodajouterEntree" id="ajouterEntree"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static ajouterEntree</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Log.php.html#a71">71</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Ajoute une entrée au log spécifié par le paramètre $nomFichier</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">
ajouterEntree
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$nomFichier</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$entree</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$mode</span> = <span class="var-default">'a+'</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$nomFichier</span><span class="var-description">: le nom du fichier dans lequel écrire</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$entree</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$mode</span> </li>
</ul>
</div>
<a name="methodconfigurer" id="configurer"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static configurer</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Log.php.html#a58">58</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Configure le Log à 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="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__Log.php.html#a46">46</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Initialiser les logs par défaut, 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="methodverifierOuvrirFichier" id="verifierOuvrirFichier"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static verifierOuvrirFichier</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Log.php.html#a98">98</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Vérifie la présence d'un fichier dans le tableau, ses droits d'écriture, l'ouvre si nécessaire.</p>
<ul class="tags">
<li><span class="field">return:</span> true si le fichier est ouvert ou maintenant accessible, false sinon</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static <span class="method-result">boolean</span>
<span class="method-name">
verifierOuvrirFichier
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$nomFichier</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$mode</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$nomFichier</span><span class="var-description">: le nom du fichier dont on doit vérifier la présence</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$mode</span> </li>
</ul>
</div>
<a name="methodviderLog" id="viderLog"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static viderLog</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Log.php.html#a88">88</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Vide un fichier log indiqué</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">
viderLog
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$nomFichier</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$nomFichier</span><span class="var-description">: le nom du fichier à vider</span> </li>
</ul>
</div>
<a name="method__destruct" id="__destruct"><!-- --></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__Log.php.html#a143">143</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Destructeur de classe, ferme les descripteurs ouverts.</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>
 
 
<p class="notes" id="credit">
Documentation generated on Tue, 18 Jan 2011 15:30:52 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>