Rev 300 | Blame | Last modification | View Log | RSS feed
<!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 Script</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 Script</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">Script est une classe abstraite qui doit être implémenté par les classes éxecutant des scripts en ligne de commande.</p><ul class="tags"><li><span class="field">author:</span> Delphine CAUQUIL <<a href="mailto:delphine@tela-botanica.org">delphine@tela-botanica.org</a>></li><li><span class="field">author:</span> Jean-Pascal MILCENT <<a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a>></li><li><span class="field">version:</span> $Id: Script.php 299 2011-01-18 14:03:46Z jpm $</li><li><span class="field">copyright:</span> Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</li><li><span class="field">link:</span> /doc/framework/</li><li><span class="field">abstract:</span> </li><li><span class="field">since:</span> 0.3</li><li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL-v3</a></li><li><span class="field">license:</span> <a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL-v2</a></li></ul><p class="notes">Located in <a class="field" href="_Script.php.html">/Script.php</a> (line <span class="field"><a href="../__filesource/fsource_Framework__Script.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-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="#MSG_AVERTISSEMENT" title="details" class="const-name">MSG_AVERTISSEMENT</a> = <span class="var-type"> 2</span></div><div class="const-title"><img src="../media/images/Constant.png" alt=" " /><a href="#MSG_ERREUR" title="details" class="const-name">MSG_ERREUR</a> = <span class="var-type"> 1</span></div><div class="const-title"><img src="../media/images/Constant.png" alt=" " /><a href="#MSG_INFO" title="details" class="const-name">MSG_INFO</a> = <span class="var-type"> 3</span></div><div class="const-title"><img src="../media/images/Constant.png" alt=" " /><a href="#MSG_LOG" title="details" class="const-name">MSG_LOG</a> = <span class="var-type"> 0</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"><span class="var-type">array</span><a href="#$parametres" title="details" class="var-name">$parametres</a></div><div class="var-title"><span class="var-type">array</span><a href="#$parametres_autorises" title="details" class="var-name">$parametres_autorises</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"><span class="method-result">Script</span><a href="#__construct" title="details" class="method-name">__construct</a>(<span class="var-type"></span> <span class="var-name">$script_nom</span>, <span class="var-type"></span> <span class="var-name">$parametres_cli</span>)</div><div class="method-definition"><span class="method-result">void</span><a href="#afficherAvancement" title="details" class="method-name">afficherAvancement</a>(<span class="var-type">string</span> <span class="var-name">$message</span>, [<span class="var-type">int</span> <span class="var-name">$depart</span> = <span class="var-default">0</span>])</div><div class="method-definition"><span class="method-result">void</span><a href="#executer" title="details" class="method-name">executer</a>()</div><div class="method-definition"><span class="method-result">string</span><a href="#formaterMsg" title="details" class="method-name">formaterMsg</a>(<span class="var-type">string</span> <span class="var-name">$message</span>, [<span class="var-type">array</span> <span class="var-name">$tab_arguments</span> = <span class="var-default">array()</span>], [<span class="var-type"></span> <span class="var-name">$niveau</span> = <span class="var-default">null</span>])</div><div class="method-definition"><span class="method-result">void</span><a href="#getParametre" title="details" class="method-name">getParametre</a>(<span class="var-type"></span> <span class="var-name">$parametre</span>)</div><div class="method-definition"><span class="method-result">void</span><a href="#getScriptChemin" title="details" class="method-name">getScriptChemin</a>([<span class="var-type"></span> <span class="var-name">$doit_exister</span> = <span class="var-default">true</span>])</div><div class="method-definition"><span class="method-result">void</span><a href="#getScriptNom" title="details" class="method-name">getScriptNom</a>()</div><div class="method-definition"><span class="method-result">void.</span><a href="#traiterAvertissement" title="details" class="method-name">traiterAvertissement</a>(<span class="var-type">string</span> <span class="var-name">$message</span>, [<span class="var-type">array</span> <span class="var-name">$tab_arguments</span> = <span class="var-default">array()</span>])</div><div class="method-definition"><span class="method-result">void.</span><a href="#traiterErreur" title="details" class="method-name">traiterErreur</a>(<span class="var-type">string</span> <span class="var-name">$message</span>, [<span class="var-type">array</span> <span class="var-name">$tab_arguments</span> = <span class="var-default">array()</span>])</div><div class="method-definition"><span class="method-result">void.</span><a href="#traiterInfo" title="details" class="method-name">traiterInfo</a>(<span class="var-type">string</span> <span class="var-name">$message</span>, [<span class="var-type">array</span> <span class="var-name">$tab_arguments</span> = <span class="var-default">array()</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$parametres" id="$parametres"><!-- --></A><div class="evenrow"><div class="var-header"><span class="var-title"><span class="var-type">array</span><span class="var-name">$parametres</span>= <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Script.php.html#a85">85</a></span>)</span></div><!-- ========== Info from phpDoc block ========= --><p class="short-description">Contient le tableau des paramètres disponible après vérification :</p><p class="description"><p>le tableau est de la forme suivante : <ul><li>clé = nom du paramêtre '-foo'</li><li>valeur = la valeur récupérée sur la ligne de commande</li></ul></p></p><ul class="tags"><li><span class="field">access:</span> protected</li></ul></div><a name="var$parametres_autorises" id="$parametres_autorises"><!-- --></A><div class="oddrow"><div class="var-header"><span class="var-title"><span class="var-type">array</span><span class="var-name">$parametres_autorises</span>= <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Script.php.html#a67">67</a></span>)</span></div><!-- ========== Info from phpDoc block ========= --><p class="short-description">Paramêtres autorisés par le script.</p><p class="description"><p>le tableau est de la forme suivante : <ul><li>clé = nom du paramêtre '-foo'</li></ul><ul><li>booléen: true si le paramêtre est obligatoire</li><li>booléen ou var : true si le paramêtre nécessite un valeur à sa suite ou la valeur par défaut</li><li>string: description du contenu du paramêtre</li></ul> Les paramêtres optionels devraient être déclaré à la fin du tableau. Le dernier parametre du tableau peut avoir la valeur '...', il contiendra alors l'ensemble des paramêtres suivant trouvés sur la ligne de commande.</p></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="method__construct" id="__construct"><!-- --></a><div class="evenrow"><div class="method-header"><span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Script.php.html#a96">96</a></span>)</div><!-- ========== Info from phpDoc block ========= --><ul class="tags"><li><span class="field">access:</span> public</li></ul><div class="method-signature"><span class="method-result">Script</span><span class="method-name">__construct</span>(<span class="var-type"></span> <span class="var-name">$script_nom</span>, <span class="var-type"></span> <span class="var-name">$parametres_cli</span>)</div><ul class="parameters"><li><span class="var-type"></span><span class="var-name">$script_nom</span> </li><li><span class="var-type"></span><span class="var-name">$parametres_cli</span> </li></ul></div><a name="methodafficherAvancement" id="afficherAvancement"><!-- --></a><div class="oddrow"><div class="method-header"><span class="method-title">afficherAvancement</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Script.php.html#a268">268</a></span>)</div><!-- ========== Info from phpDoc block ========= --><p class="short-description">Utiliser cette méthode dans une boucle pour afficher un message suivi du nombre de tour de boucle effectué.</p><p class="description"><p>Vous devrez vous même gérer le retour à la ligne à la sortie de la boucle.</p></p><ul class="tags"><li><span class="field">return:</span> le message est affiché dans la console.</li><li><span class="field">access:</span> protected</li></ul><div class="method-signature"><span class="method-result">void</span><span class="method-name">afficherAvancement</span>(<span class="var-type">string</span> <span class="var-name">$message</span>, [<span class="var-type">int</span> <span class="var-name">$depart</span> = <span class="var-default">0</span>])</div><ul class="parameters"><li><span class="var-type">string</span><span class="var-name">$message</span><span class="var-description">: le message d'information.</span> </li><li><span class="var-type">int</span><span class="var-name">$depart</span><span class="var-description">: le nombre de départ à afficher.</span> </li></ul></div><a name="methodexecuter" id="executer"><!-- --></a><div class="evenrow"><div class="method-header"><span class="method-title">executer</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Script.php.html#a139">139</a></span>)</div><!-- ========== Info from phpDoc block ========= --><ul class="tags"><li><span class="field">abstract:</span> </li><li><span class="field">access:</span> public</li></ul><div class="method-signature"><span class="method-result">void</span><span class="method-name">executer</span>()</div></div><a name="methodformaterMsg" id="formaterMsg"><!-- --></a><div class="oddrow"><div class="method-header"><span class="method-title">formaterMsg</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Script.php.html#a252">252</a></span>)</div><!-- ========== Info from phpDoc block ========= --><p class="short-description">Retourne un message d'information formaté.</p><ul class="tags"><li><span class="field">return:</span> le message d'erreur formaté.</li><li><span class="field">access:</span> protected</li></ul><div class="method-signature"><span class="method-result">string</span><span class="method-name">formaterMsg</span>(<span class="var-type">string</span> <span class="var-name">$message</span>, [<span class="var-type">array</span> <span class="var-name">$tab_arguments</span> = <span class="var-default">array()</span>], [<span class="var-type"></span> <span class="var-name">$niveau</span> = <span class="var-default">null</span>])</div><ul class="parameters"><li><span class="var-type">string</span><span class="var-name">$message</span><span class="var-description">: le message d'information avec des %s.</span> </li><li><span class="var-type">array</span><span class="var-name">$tab_arguments</span><span class="var-description">: le tableau des paramêtres à insérer dans le message d'erreur.</span> </li><li><span class="var-type"></span><span class="var-name">$niveau</span> </li></ul></div><a name="methodgetParametre" id="getParametre"><!-- --></a><div class="evenrow"><div class="method-header"><span class="method-title">getParametre</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Script.php.html#a125">125</a></span>)</div><!-- ========== Info from phpDoc block ========= --><ul class="tags"><li><span class="field">access:</span> protected</li></ul><div class="method-signature"><span class="method-result">void</span><span class="method-name">getParametre</span>(<span class="var-type"></span> <span class="var-name">$parametre</span>)</div><ul class="parameters"><li><span class="var-type"></span><span class="var-name">$parametre</span> </li></ul></div><a name="methodgetScriptChemin" id="getScriptChemin"><!-- --></a><div class="oddrow"><div class="method-header"><span class="method-title">getScriptChemin</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Script.php.html#a117">117</a></span>)</div><!-- ========== Info from phpDoc block ========= --><ul class="tags"><li><span class="field">access:</span> protected</li></ul><div class="method-signature"><span class="method-result">void</span><span class="method-name">getScriptChemin</span>([<span class="var-type"></span> <span class="var-name">$doit_exister</span> = <span class="var-default">true</span>])</div><ul class="parameters"><li><span class="var-type"></span><span class="var-name">$doit_exister</span> </li></ul></div><a name="methodgetScriptNom" id="getScriptNom"><!-- --></a><div class="evenrow"><div class="method-header"><span class="method-title">getScriptNom</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Script.php.html#a113">113</a></span>)</div><!-- ========== Info from phpDoc block ========= --><ul class="tags"><li><span class="field">access:</span> protected</li></ul><div class="method-signature"><span class="method-result">void</span><span class="method-name">getScriptNom</span>()</div></div><a name="methodtraiterAvertissement" id="traiterAvertissement"><!-- --></a><div class="oddrow"><div class="method-header"><span class="method-title">traiterAvertissement</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Script.php.html#a210">210</a></span>)</div><!-- ========== Info from phpDoc block ========= --><p class="short-description">Affiche un message d'avertissement formaté.</p><p class="description"><p>Si le paramétre de verbosité (-v) vaut 1, le message est écrit dans le fichier de log. Si le paramétre de verbosité (-v) vaut 2 ou plus, le message est écrit dans le fichier de log et afficher dans la console.</p></p><ul class="tags"><li><span class="field">access:</span> protected</li></ul><div class="method-signature"><span class="method-result">void.</span><span class="method-name">traiterAvertissement</span>(<span class="var-type">string</span> <span class="var-name">$message</span>, [<span class="var-type">array</span> <span class="var-name">$tab_arguments</span> = <span class="var-default">array()</span>])</div><ul class="parameters"><li><span class="var-type">string</span><span class="var-name">$message</span><span class="var-description">: le message d'erreur avec des %s.</span> </li><li><span class="var-type">array</span><span class="var-name">$tab_arguments</span><span class="var-description">: le tableau des paramêtres à insérer dans le message d'erreur.</span> </li></ul></div><a name="methodtraiterErreur" id="traiterErreur"><!-- --></a><div class="evenrow"><div class="method-header"><span class="method-title">traiterErreur</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Script.php.html#a197">197</a></span>)</div><!-- ========== Info from phpDoc block ========= --><p class="short-description">Affiche un message d'erreur formaté.</p><p class="description"><p>Si le paramétre de verbosité (-v) vaut 1 ou plus, le message est écrit dans le fichier de log et afficher dans la console.</p></p><ul class="tags"><li><span class="field">access:</span> protected</li></ul><div class="method-signature"><span class="method-result">void.</span><span class="method-name">traiterErreur</span>(<span class="var-type">string</span> <span class="var-name">$message</span>, [<span class="var-type">array</span> <span class="var-name">$tab_arguments</span> = <span class="var-default">array()</span>])</div><ul class="parameters"><li><span class="var-type">string</span><span class="var-name">$message</span><span class="var-description">: le message d'erreur avec des %s.</span> </li><li><span class="var-type">array</span><span class="var-name">$tab_arguments</span><span class="var-description">: le tableau des paramêtres à insérer dans le message d'erreur.</span> </li></ul></div><a name="methodtraiterInfo" id="traiterInfo"><!-- --></a><div class="oddrow"><div class="method-header"><span class="method-title">traiterInfo</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Script.php.html#a223">223</a></span>)</div><!-- ========== Info from phpDoc block ========= --><p class="short-description">Retourne un message d'information formaté.</p><p class="description"><p>Si le paramétre de verbosité (-v) vaut 1 ou 2 , le message est écrit dans le fichier de log. Si le paramétre de verbosité (-v) vaut 3 ou plus, le message est écrit dans le fichier de log et afficher dans la console.</p></p><ul class="tags"><li><span class="field">access:</span> protected</li></ul><div class="method-signature"><span class="method-result">void.</span><span class="method-name">traiterInfo</span>(<span class="var-type">string</span> <span class="var-name">$message</span>, [<span class="var-type">array</span> <span class="var-name">$tab_arguments</span> = <span class="var-default">array()</span>])</div><ul class="parameters"><li><span class="var-type">string</span><span class="var-name">$message</span><span class="var-description">: le message d'information avec des %s.</span> </li><li><span class="var-type">array</span><span class="var-name">$tab_arguments</span><span class="var-description">: le tableau des paramêtres à insérer dans le message d'erreur.</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="constMSG_AVERTISSEMENT" id="MSG_AVERTISSEMENT"><!-- --></A><div class="evenrow"><div class="const-header"><img src="../media/images/Variable.png" /><span class="const-title"><span class="const-name">MSG_AVERTISSEMENT</span>= <span class="const-default"> 2</span>(line <span class="line-number"><a href="../__filesource/fsource_Framework__Script.php.html#a24">24</a></span>)</span></div><!-- ========== Info from phpDoc block ========= --><p class="short-description">Niveau de message de type AVERTISSEMENT</p></div><a name="constMSG_ERREUR" id="MSG_ERREUR"><!-- --></A><div class="oddrow"><div class="const-header"><img src="../media/images/Variable.png" /><span class="const-title"><span class="const-name">MSG_ERREUR</span>= <span class="const-default"> 1</span>(line <span class="line-number"><a href="../__filesource/fsource_Framework__Script.php.html#a22">22</a></span>)</span></div><!-- ========== Info from phpDoc block ========= --><p class="short-description">Niveau de message de type ERREUR</p></div><a name="constMSG_INFO" id="MSG_INFO"><!-- --></A><div class="evenrow"><div class="const-header"><img src="../media/images/Variable.png" /><span class="const-title"><span class="const-name">MSG_INFO</span>= <span class="const-default"> 3</span>(line <span class="line-number"><a href="../__filesource/fsource_Framework__Script.php.html#a26">26</a></span>)</span></div><!-- ========== Info from phpDoc block ========= --><p class="short-description">Niveau de message de type INFORMATION</p></div><a name="constMSG_LOG" id="MSG_LOG"><!-- --></A><div class="oddrow"><div class="const-header"><img src="../media/images/Variable.png" /><span class="const-title"><span class="const-name">MSG_LOG</span>= <span class="const-default"> 0</span>(line <span class="line-number"><a href="../__filesource/fsource_Framework__Script.php.html#a20">20</a></span>)</span></div><!-- ========== Info from phpDoc block ========= --><p class="short-description">Niveau de message de type LOG</p></div></div></div><p class="notes" id="credit">Documentation generated on Tue, 18 Jan 2011 15:30:59 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a></p></div></body></html>