Rev 467 | Blame | Compare with Previous | Last modification | View Log | RSS feed
<!DOCTYPE html><html lang="en"><head><meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/><meta charset="utf-8"/><title>TBFramework - v0.2</title><meta name="author" content=""/><meta name="description" content=""/><link href="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/css/bootstrap-combined.no-icons.min.css" rel="stylesheet"><link href="https://netdna.bootstrapcdn.com/font-awesome/3.2.1/css/font-awesome.min.css" rel="stylesheet"><link href="../css/prism.css" rel="stylesheet" media="all"/><link href="../css/template.css" rel="stylesheet" media="all"/><!--[if lt IE 9]><script src="https://html5shim.googlecode.com/svn/trunk/html5.js" type="text/javascript"></script><![endif]--><script src="https://code.jquery.com/jquery-1.10.2.min.js" type="text/javascript"></script><script src="https://code.jquery.com/ui/1.10.3/jquery-ui.min.js" type="text/javascript"></script><script src="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/js/bootstrap.min.js"></script><script src="../js/jquery.smooth-scroll.js"></script><script src="../js/prism.min.js"></script><!-- TODO: Add http://jscrollpane.kelvinluck.com/ to style the scrollbars for browsers not using webkit--><script type="text/javascript">function loadExternalCodeSnippets() {Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach(function (pre) {var src = pre.getAttribute('data-src');var extension = (src.match(/\.(\w+)$/) || [, ''])[1];var language = 'php';var code = document.createElement('code');code.className = 'language-' + language;pre.textContent = '';code.textContent = 'Loading…';pre.appendChild(code);var xhr = new XMLHttpRequest();xhr.open('GET', src, true);xhr.onreadystatechange = function () {if (xhr.readyState == 4) {if (xhr.status < 400 && xhr.responseText) {code.textContent = xhr.responseText;Prism.highlightElement(code);}else if (xhr.status >= 400) {code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;}else {code.textContent = '✖ Error: File does not exist or is empty';}}};xhr.send(null);});}$(document).ready(function(){loadExternalCodeSnippets();});$('#source-view').on('shown', function () {loadExternalCodeSnippets();})</script><link rel="shortcut icon" href="../images/favicon.ico"/><link rel="apple-touch-icon" href="../images/apple-touch-icon.png"/><link rel="apple-touch-icon" sizes="72x72" href="../images/apple-touch-icon-72x72.png"/><link rel="apple-touch-icon" sizes="114x114" href="../images/apple-touch-icon-114x114.png"/></head><body><div class="navbar navbar-fixed-top"><div class="navbar-inner"><div class="container"><a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><i class="icon-ellipsis-vertical"></i></a><a class="brand" href="../index.html">TBFramework - v0.2</a><div class="nav-collapse"><ul class="nav pull-right"><li class="dropdown"><a href="../index.html" class="dropdown-toggle" data-toggle="dropdown">API Documentation <b class="caret"></b></a><ul class="dropdown-menu"></ul></li><li class="dropdown" id="charts-menu"><a href="#" class="dropdown-toggle" data-toggle="dropdown">Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graphs/class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul></li><li class="dropdown" id="reports-menu"><a href="#" class="dropdown-toggle" data-toggle="dropdown">Reports <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../reports/errors.html"><i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">70</span></a></li><li><a href="../reports/markers.html"><i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">0</span></a></li></ul></li></ul></div></div></div><!--<div class="go_to_top">--><!--<a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a>--><!--</div>--></div><div id="___" class="container-fluid"><section class="row-fluid"><div class="span2 sidebar"><div class="accordion" style="margin-bottom: 0"><div class="accordion-group"><div class="accordion-heading"><a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-578982708"></a><a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a></div><div id="namespace-578982708" class="accordion-body collapse in"><div class="accordion-inner"><ul><li class="class"><a href="../classes/Url.html">Url</a></li><li class="class"><a href="../classes/Debug.html">Debug</a></li><li class="class"><a href="../classes/Chronometre.html">Chronometre</a></li><li class="class"><a href="../classes/SquelettePhp.html">SquelettePhp</a></li><li class="class"><a href="../classes/Controleur.html">Controleur</a></li><li class="class"><a href="../classes/GestionnaireException.html">GestionnaireException</a></li><li class="class"><a href="../classes/Modele.html">Modele</a></li><li class="class"><a href="../classes/Registre.html">Registre</a></li><li class="class"><a href="../classes/I18n.html">I18n</a></li><li class="class"><a href="../classes/Config.html">Config</a></li><li class="class"><a href="../classes/Application.html">Application</a></li><li class="class"><a href="../classes/Log.html">Log</a></li></ul></div></div></div></div></div></section><section class="row-fluid"><div class="span10 offset2"><div class="row-fluid"><div class="span8 content class"><nav><a href="../namespaces/default.html">\</a> <i class="icon-level-up"></i></nav><a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a><h1><small>\</small>Log</h1><p><em>Classe permettant de logger des messages dans les fichier situés dans le dossier de log.</em></p><section id="summary"><h2>Summary</h2><section class="row-fluid heading"><section class="span4"><a href="#methods">Methods</a></section><section class="span4"><a href="#properties">Properties</a></section><section class="span4"><a href="#constants">Constants</a></section></section><section class="row-fluid public"><section class="span4"><a href="../classes/Log.html#method_initialiser" class="">initialiser()</a><br /><a href="../classes/Log.html#method_configurer" class="">configurer()</a><br /><a href="../classes/Log.html#method_ajouterEntree" class="">ajouterEntree()</a><br /><a href="../classes/Log.html#method_viderLog" class="">viderLog()</a><br /><a href="../classes/Log.html#method_verifierOuvrirFichier" class="">verifierOuvrirFichier()</a><br /><a href="../classes/Log.html#method___destruct" class="">__destruct()</a><br /></section><section class="span4"><em>No public properties found</em></section><section class="span4"><em>No constants found</em></section></section><section class="row-fluid protected"><section class="span4"><em>No protected methods found</em></section><section class="span4"><em>No protected properties found</em></section><section class="span4"><em>N/A</em></section></section><section class="row-fluid private"><section class="span4"><a href="../classes/Log.html#method_verifierTailleFichierOuArchiver" class="">verifierTailleFichierOuArchiver()</a><br /><a href="../classes/Log.html#method_desactiverEcriture" class="">desactiverEcriture()</a><br /></section><section class="span4"><a href="../classes/Log.html#property_logger" class="">$logger</a><br /><a href="../classes/Log.html#property_fichiersLog" class="">$fichiersLog</a><br /><a href="../classes/Log.html#property_cheminLogs" class="">$cheminLogs</a><br /><a href="../classes/Log.html#property_droitLogger" class="">$droitLogger</a><br /><a href="../classes/Log.html#property_timeZone" class="">$timeZone</a><br /><a href="../classes/Log.html#property_tailleMax" class="">$tailleMax</a><br /><a href="../classes/Log.html#property_sd" class="">$sd</a><br /><a href="../classes/Log.html#property_ext" class="">$ext</a><br /></section><section class="span4"><em>N/A</em></section></section></section></div><aside class="span4 detailsbar"><dl><dt>File</dt><dd><a href="../files/Log.php.html"><div class="path-wrapper">Log.php</div></a></dd><dt>Package</dt><dd><div class="namespace-wrapper">\Framework</div></dd><dt>Class hierarchy</dt><dd class="hierarchy"><div class="namespace-wrapper">\Log</div></dd></dl><h2>Tags</h2><table class="table table-condensed"><tr><th>category</th><td><p>PHP 5.2</p></td></tr><tr><th>author</th><td><p>Aurélien PERONNET <a href="mailto:aurelien@tela-botanica.org">aurelien@tela-botanica.org</a></p></td></tr><tr><th>copyright</th><td><p>Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)</p></td></tr><tr><th>license</th><td><p>GNU-GPL-v3 <a href="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</a></p><p>CECILL-v2 <a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt</a></p></td></tr><tr><th>todo</th><td></td></tr></table></aside></div><a id="properties" name="properties"></a><div class="row-fluid"><div class="span8 content class"><h2>Properties</h2></div><aside class="span4 detailsbar"></aside></div><div class="row-fluid"><div class="span8 content class"><a id="property_logger" name="property_logger" class="anchor"></a><article class="property"><h3 class="private ">$logger</h3><pre class="signature">$logger</pre><p><em>Boolean indiquant si l'on doit utiliser les logs ou pas</em></p></article></div><aside class="span4 detailsbar"><h1><i class="icon-arrow-down"></i></h1><dl></dl><h2>Tags</h2><table class="table table-condensed"><tr><th>todo</th><td></td></tr></table></aside></div><div class="row-fluid"><div class="span8 content class"><a id="property_fichiersLog" name="property_fichiersLog" class="anchor"></a><article class="property"><h3 class="private ">$fichiersLog</h3><pre class="signature">$fichiersLog</pre><p><em>Tableau associatif stockant les descripteurs de fichiers</em></p></article></div><aside class="span4 detailsbar"><h1><i class="icon-arrow-down"></i></h1><dl></dl><h2>Tags</h2><table class="table table-condensed"><tr><th>todo</th><td></td></tr></table></aside></div><div class="row-fluid"><div class="span8 content class"><a id="property_cheminLogs" name="property_cheminLogs" class="anchor"></a><article class="property"><h3 class="private ">$cheminLogs</h3><pre class="signature">$cheminLogs</pre><p><em>Chemin de base du dossier log de l'application</em></p></article></div><aside class="span4 detailsbar"><h1><i class="icon-arrow-down"></i></h1><dl></dl><h2>Tags</h2><table class="table table-condensed"><tr><th>todo</th><td></td></tr></table></aside></div><div class="row-fluid"><div class="span8 content class"><a id="property_droitLogger" name="property_droitLogger" class="anchor"></a><article class="property"><h3 class="private ">$droitLogger</h3><pre class="signature">$droitLogger</pre><p><em>Booleen indiquant si l'on peut correctement écrire dans les fichiers de logs</em></p></article></div><aside class="span4 detailsbar"><h1><i class="icon-arrow-down"></i></h1><dl></dl><h2>Tags</h2><table class="table table-condensed"><tr><th>todo</th><td></td></tr></table></aside></div><div class="row-fluid"><div class="span8 content class"><a id="property_timeZone" name="property_timeZone" class="anchor"></a><article class="property"><h3 class="private ">$timeZone</h3><pre class="signature">$timeZone</pre><p><em>Zone horaire (pour éviter des avertissements dans les dates)</em></p></article></div><aside class="span4 detailsbar"><h1><i class="icon-arrow-down"></i></h1><dl></dl><h2>Tags</h2><table class="table table-condensed"><tr><th>todo</th><td></td></tr></table></aside></div><div class="row-fluid"><div class="span8 content class"><a id="property_tailleMax" name="property_tailleMax" class="anchor"></a><article class="property"><h3 class="private ">$tailleMax</h3><pre class="signature">$tailleMax</pre><p><em>Taille maximum d'un fichier de log avant que celui ne soit archivé (en octets)</em></p></article></div><aside class="span4 detailsbar"><h1><i class="icon-arrow-down"></i></h1><dl></dl><h2>Tags</h2><table class="table table-condensed"><tr><th>todo</th><td></td></tr></table></aside></div><div class="row-fluid"><div class="span8 content class"><a id="property_sd" name="property_sd" class="anchor"></a><article class="property"><h3 class="private ">$sd</h3><pre class="signature">$sd</pre><p><em>séparateur de dossier dans un chemin</em></p></article></div><aside class="span4 detailsbar"><h1><i class="icon-arrow-down"></i></h1><dl></dl><h2>Tags</h2><table class="table table-condensed"><tr><th>todo</th><td></td></tr></table></aside></div><div class="row-fluid"><div class="span8 content class"><a id="property_ext" name="property_ext" class="anchor"></a><article class="property"><h3 class="private ">$ext</h3><pre class="signature">$ext</pre><p><em>Extension des fichiers de log</em></p></article></div><aside class="span4 detailsbar"><h1><i class="icon-arrow-down"></i></h1><dl></dl><h2>Tags</h2><table class="table table-condensed"><tr><th>todo</th><td></td></tr></table></aside></div><a id="methods" name="methods"></a><div class="row-fluid"><div class="span8 content class"><h2>Methods</h2></div><aside class="span4 detailsbar"></aside></div><div class="row-fluid"><div class="span8 content class"><a id="method_initialiser" name="method_initialiser" class="anchor"></a><article class="method"><h3 class="public ">initialiser()</h3><a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a><pre class="signature" style="margin-right: 54px;">initialiser()</pre><p><em>Initialiser les logs par défaut, sans tenir comptes des paramêtres de config.</em></p></article></div><aside class="span4 detailsbar"><h1><i class="icon-arrow-down"></i></h1><span class="label label-info">static</span><dl></dl><h2>Tags</h2><table class="table table-condensed"><tr><th>todo</th><td></td></tr></table></aside></div><div class="row-fluid"><div class="span8 content class"><a id="method_configurer" name="method_configurer" class="anchor"></a><article class="method"><h3 class="public ">configurer()</h3><a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a><pre class="signature" style="margin-right: 54px;">configurer()</pre><p><em>Configure le Log à partir des paramêtres de config.</em></p></article></div><aside class="span4 detailsbar"><h1><i class="icon-arrow-down"></i></h1><span class="label label-info">static</span><dl></dl><h2>Tags</h2><table class="table table-condensed"><tr><th>todo</th><td></td></tr></table></aside></div><div class="row-fluid"><div class="span8 content class"><a id="method_ajouterEntree" name="method_ajouterEntree" class="anchor"></a><article class="method"><h3 class="public ">ajouterEntree()</h3><a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a><pre class="signature" style="margin-right: 54px;">ajouterEntree(string <span class="argument">$nomFichier</span>, <span class="argument">$entree</span>, <span class="argument">$mode</span>)</pre><p><em>Ajoute une entrée au log spécifié par le paramètre $nomFichier</em></p><h4>Parameters</h4><table class="table table-condensed table-hover"><tr><td>string</td><td>$nomFichier</td><td><p>le nom du fichier dans lequel écrire</p></td></tr><tr><td></td><td>$entree</td><td></td></tr><tr><td></td><td>$mode</td><td></td></tr></table></article></div><aside class="span4 detailsbar"><h1><i class="icon-arrow-down"></i></h1><span class="label label-info">static</span><dl></dl><h2>Tags</h2><table class="table table-condensed"><tr><th>todo</th><td></td></tr></table></aside></div><div class="row-fluid"><div class="span8 content class"><a id="method_viderLog" name="method_viderLog" class="anchor"></a><article class="method"><h3 class="public ">viderLog()</h3><a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a><pre class="signature" style="margin-right: 54px;">viderLog(string <span class="argument">$nomFichier</span>)</pre><p><em>Vide un fichier log indiqué</em></p><h4>Parameters</h4><table class="table table-condensed table-hover"><tr><td>string</td><td>$nomFichier</td><td><p>le nom du fichier à vider</p></td></tr></table></article></div><aside class="span4 detailsbar"><h1><i class="icon-arrow-down"></i></h1><span class="label label-info">static</span><dl></dl><h2>Tags</h2><table class="table table-condensed"><tr><th>todo</th><td></td></tr></table></aside></div><div class="row-fluid"><div class="span8 content class"><a id="method_verifierOuvrirFichier" name="method_verifierOuvrirFichier" class="anchor"></a><article class="method"><h3 class="public ">verifierOuvrirFichier()</h3><a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a><pre class="signature" style="margin-right: 54px;">verifierOuvrirFichier(string <span class="argument">$nomFichier</span>, <span class="argument">$mode</span>) : boolean</pre><p><em>Vérifie la présence d'un fichier dans le tableau, ses droits d'écriture, l'ouvre si nécessaire.</em></p><h4>Parameters</h4><table class="table table-condensed table-hover"><tr><td>string</td><td>$nomFichier</td><td><p>le nom du fichier dont on doit vérifier la présence</p></td></tr><tr><td></td><td>$mode</td><td></td></tr></table><h4>Returns</h4>boolean— <p>true si le fichier est ouvert ou maintenant accessible, false sinon</p></article></div><aside class="span4 detailsbar"><h1><i class="icon-arrow-down"></i></h1><span class="label label-info">static</span><dl></dl><h2>Tags</h2><table class="table table-condensed"><tr><th>todo</th><td></td></tr></table></aside></div><div class="row-fluid"><div class="span8 content class"><a id="method___destruct" name="method___destruct" class="anchor"></a><article class="method"><h3 class="public ">__destruct()</h3><a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a><pre class="signature" style="margin-right: 54px;">__destruct()</pre><p><em>destructeur de classe, ferme les descripteurs ouverts</em></p></article></div><aside class="span4 detailsbar"><h1><i class="icon-arrow-down"></i></h1><dl></dl><h2>Tags</h2><table class="table table-condensed"><tr><th>todo</th><td></td></tr></table></aside></div><div class="row-fluid"><div class="span8 content class"><a id="method_verifierTailleFichierOuArchiver" name="method_verifierTailleFichierOuArchiver" class="anchor"></a><article class="method"><h3 class="private ">verifierTailleFichierOuArchiver()</h3><a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a><pre class="signature" style="margin-right: 54px;">verifierTailleFichierOuArchiver(string <span class="argument">$nomFichier</span>)</pre><p><em>Vérifie la taille d'un fichier donné et si celle ci est trop importantearchive le fichier de log</em></p><h4>Parameters</h4><table class="table table-condensed table-hover"><tr><td>string</td><td>$nomFichier</td><td><p>nom du fichier à vérifier</p></td></tr></table></article></div><aside class="span4 detailsbar"><h1><i class="icon-arrow-down"></i></h1><span class="label label-info">static</span><dl></dl><h2>Tags</h2><table class="table table-condensed"><tr><th>todo</th><td></td></tr></table></aside></div><div class="row-fluid"><div class="span8 content class"><a id="method_desactiverEcriture" name="method_desactiverEcriture" class="anchor"></a><article class="method"><h3 class="private ">desactiverEcriture()</h3><a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a><pre class="signature" style="margin-right: 54px;">desactiverEcriture(string <span class="argument">$nomFichier</span>)</pre><p><em>Désactive l'écriture du log et envoie un message au gestionnaire d'erreurs</em></p><h4>Parameters</h4><table class="table table-condensed table-hover"><tr><td>string</td><td>$nomFichier</td><td><p>le nom du fichier qui a causé l'erreur</p></td></tr></table></article></div><aside class="span4 detailsbar"><h1><i class="icon-arrow-down"></i></h1><span class="label label-info">static</span><dl></dl><h2>Tags</h2><table class="table table-condensed"><tr><th>todo</th><td></td></tr></table></aside></div></div></section><div id="source-view" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="source-view-label" aria-hidden="true"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h3 id="source-view-label">Log.php</h3></div><div class="modal-body"><pre data-src="../files/Log.php.txt" class="language-php line-numbers"></pre></div></div><footer class="row-fluid"><section class="span10 offset2"><section class="row-fluid"><section class="span10 offset1"><section class="row-fluid footer-sections"><section class="span4"><h1><i class="icon-code"></i></h1><div><ul></ul></div></section><section class="span4"><h1><i class="icon-bar-chart"></i></h1><div><ul><li><a href="../graphs/class.html">Class Hierarchy Diagram</a></li></ul></div></section><section class="span4"><h1><i class="icon-pushpin"></i></h1><div><ul><li><a href="../reports/errors.html">Errors</a></li><li><a href="../reports/markers.html">Markers</a></li></ul></div></section></section></section></section><section class="row-fluid"><section class="span10 offset1"><hr />Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authoredon March 18th, 2014 at 19:19.</section></section></section></footer></div></body></html>