Rev 302 | Blame | Compare with Previous | Last modification | View Log | RSS feed
<html><head><title>Docs For Class Script</title><meta http-equiv='Content-Type' content='text/html; charset=UTF-8'/><link rel="stylesheet" type="text/css" href="../media/style.css"></head><body><table border="0" cellspacing="0" cellpadding="0" height="48" width="100%"><tr><td class="header_top">Framework</td></tr><tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr><tr><td class="header_menu">[ <a href="../classtrees_Framework.html" class="menu">class tree: Framework</a> ][ <a href="../elementindex_Framework.html" class="menu">index: Framework</a> ][ <a href="../elementindex.html" class="menu">all elements</a> ]</td></tr><tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr></table><table width="100%" border="0" cellpadding="0" cellspacing="0"><tr valign="top"><td width="200" class="menu"><div id="todolist"><p><a href="../todolist.html">Todo List</a></p></div><b>Packages:</b><br /><a href="../li_Framework.html">Framework</a><br /><a href="../li_Utilitaire.html">Utilitaire</a><br /><a href="../li_Zend_OpenId.html">Zend_OpenId</a><br /><br /><br /><b>Files:</b><br /><div class="package"><a href="../Framework/_Bdd.php.html"> Bdd.php</a><br><a href="../Framework/_Cache.php.html"> Cache.php</a><br><a href="../Framework/_CacheFichier.php.html"> CacheFichier.php</a><br><a href="../Framework/_CacheSimple.php.html"> CacheSimple.php</a><br><a href="../Framework/_CacheSqlite.php.html"> CacheSqlite.php</a><br><a href="../Framework/_Chronometre.php.html"> Chronometre.php</a><br><a href="../Framework/_Cli.php.html"> Cli.php</a><br><a href="../Framework/_Config.php.html"> Config.php</a><br><a href="../Framework/_Controleur.php.html"> Controleur.php</a><br><a href="../Framework/_Debug.php.html"> Debug.php</a><br><a href="../Framework/_utilitaires---DiffieHellmanUtil.php.html"> DiffieHellmanUtil.php</a><br><a href="../Framework/_Framework.php.html"> Framework.php</a><br><a href="../Framework/_GestionnaireException.php.html"> GestionnaireException.php</a><br><a href="../Framework/_I18n.php.html"> I18n.php</a><br><a href="../Framework/_Log.php.html"> Log.php</a><br><a href="../Framework/_OpenIdClient.php.html"> OpenIdClient.php</a><br><a href="../Framework/_Registre.php.html"> Registre.php</a><br><a href="../Framework/_RestClient.php.html"> RestClient.php</a><br><a href="../Framework/_RestServeur.php.html"> RestServeur.php</a><br><a href="../Framework/_RestService.php.html"> RestService.php</a><br><a href="../Framework/_Script.php.html"> Script.php</a><br><a href="../Framework/_SquelettePhp.php.html"> SquelettePhp.php</a><br><a href="../Framework/_Url.php.html"> Url.php</a><br></div><br /><b>Classes:</b><br /><div class="package"><a href="../Framework/Bdd.html">Bdd</a><br /><a href="../Framework/Cache.html">Cache</a><br /><a href="../Framework/CacheFichier.html">CacheFichier</a><br /><a href="../Framework/CacheSimple.html">CacheSimple</a><br /><a href="../Framework/CacheSqlite.html">CacheSqlite</a><br /><a href="../Framework/Chronometre.html">Chronometre</a><br /><a href="../Framework/Cli.html">Cli</a><br /><a href="../Framework/Config.html">Config</a><br /><a href="../Framework/Controleur.html">Controleur</a><br /><a href="../Framework/Debug.html">Debug</a><br /><a href="../Framework/DiffieHellmanUtil.html">DiffieHellmanUtil</a><br /><a href="../Framework/Framework.html">Framework</a><br /><a href="../Framework/GestionnaireException.html">GestionnaireException</a><br /><a href="../Framework/I18n.html">I18n</a><br /><a href="../Framework/Log.html">Log</a><br /><a href="../Framework/OpenIdClient.html">OpenIdClient</a><br /><a href="../Framework/Registre.html">Registre</a><br /><a href="../Framework/RestClient.html">RestClient</a><br /><a href="../Framework/RestServeur.html">RestServeur</a><br /><a href="../Framework/RestService.html">RestService</a><br /><a href="../Framework/Script.html">Script</a><br /><a href="../Framework/SquelettePhp.html">SquelettePhp</a><br /><a href="../Framework/Url.html">Url</a><br /></div></td><td><table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top"><h1>Class: Script</h1>Source Location: /Script.php<br /><br /><table width="100%" border="0"><tr><td valign="top"><h3><a href="#class_details">Class Overview</a></h3><pre></pre><br /><div class="description">Script est une classe abstraite qui doit être implémenté par les classes éxecutant des scripts en ligne de commande.</div><br /><br /><h4>Author(s):</h4><ul><li>Delphine CAUQUIL <<a href="mailto:delphine@tela-botanica.org">delphine@tela-botanica.org</a>></li><li>Jean-Pascal MILCENT <<a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a>></li></ul><h4>Version:</h4><ul><li>$Id: Script.php 299 2011-01-18 14:03:46Z jpm $</li></ul><h4>Copyright:</h4><ul><li>Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</li></ul></td><td valign="top"><h3><a href="#class_vars">Variables</a></h3><ul><li><a href="../Framework/Script.html#var$parametres">$parametres</a></li><li><a href="../Framework/Script.html#var$parametres_autorises">$parametres_autorises</a></li></ul></td><td valign="top"><h3><a href="#class_consts">Constants</a></h3><ul><li><a href="../Framework/Script.html#constMSG_AVERTISSEMENT">MSG_AVERTISSEMENT</a></li><li><a href="../Framework/Script.html#constMSG_ERREUR">MSG_ERREUR</a></li><li><a href="../Framework/Script.html#constMSG_INFO">MSG_INFO</a></li><li><a href="../Framework/Script.html#constMSG_LOG">MSG_LOG</a></li></ul></td><td valign="top"><h3><a href="#class_methods">Methods</a></h3><ul><li><a href="../Framework/Script.html#method__construct">__construct</a></li><li><a href="../Framework/Script.html#methodafficherAvancement">afficherAvancement</a></li><li><a href="../Framework/Script.html#methodexecuter">executer</a></li><li><a href="../Framework/Script.html#methodformaterMsg">formaterMsg</a></li><li><a href="../Framework/Script.html#methodgetParametre">getParametre</a></li><li><a href="../Framework/Script.html#methodgetScriptChemin">getScriptChemin</a></li><li><a href="../Framework/Script.html#methodgetScriptNom">getScriptNom</a></li><li><a href="../Framework/Script.html#methodtraiterAvertissement">traiterAvertissement</a></li><li><a href="../Framework/Script.html#methodtraiterErreur">traiterErreur</a></li><li><a href="../Framework/Script.html#methodtraiterInfo">traiterInfo</a></li></ul></td></tr></table><hr /><table width="100%" border="0"><tr></tr></table><hr /><a name="class_details"></a><h3>Class Details</h3><div class="tags">[line <a href="../__filesource/fsource_Framework__Script.php.html#a18">18</a>]<br />Script est une classe abstraite qui doit être implémenté par les classes éxecutant des scripts en ligne de commande.<br /><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>author:</b> </td><td>Delphine CAUQUIL <<a href="mailto:delphine@tela-botanica.org">delphine@tela-botanica.org</a>></td></tr><tr><td><b>author:</b> </td><td>Jean-Pascal MILCENT <<a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a>></td></tr><tr><td><b>version:</b> </td><td>$Id: Script.php 299 2011-01-18 14:03:46Z jpm $</td></tr><tr><td><b>copyright:</b> </td><td>Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</td></tr><tr><td><b>link:</b> </td><td>/doc/framework/</td></tr><tr><td><b>abstract:</b> </td><td></td></tr><tr><td><b>since:</b> </td><td>0.3</td></tr><tr><td><b>license:</b> </td><td><a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL-v3</a></td></tr><tr><td><b>license:</b> </td><td><a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL-v2</a></td></tr></table></div></div><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /><hr /><a name="class_vars"></a><h3>Class Variables</h3><div class="tags"><a name="var$parametres"></a><p></p><h4>$parametres = <span class="value"> null</span></h4><p>[line <a href="../__filesource/fsource_Framework__Script.php.html#a85">85</a>]</p>Contient le tableau des paramètres disponible après vérification :<br /><br /><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><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>access:</b> </td><td>protected</td></tr></table></div><br /><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>Type:</b> </td><td>array</td></tr></table></div><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /><a name="var$parametres_autorises"></a><p></p><h4>$parametres_autorises = <span class="value"> null</span></h4><p>[line <a href="../__filesource/fsource_Framework__Script.php.html#a67">67</a>]</p>Paramêtres autorisés par le script.<br /><br /><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><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>access:</b> </td><td>protected</td></tr></table></div><br /><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>Type:</b> </td><td>array</td></tr></table></div><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /></div><br /><hr /><a name="class_methods"></a><h3>Class Methods</h3><div class="tags"><hr /><a name="method__construct"></a><h3>constructor __construct <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Script.php.html#a96">96</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>Script __construct($script_nom,$parametres_cli)</code></td></tr></table></td></tr></table><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>access:</b> </td><td>public</td></tr></table></div><br /><br /><h4>Parameters:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td class="type"> </td><td><b>$script_nom</b> </td><td></td></tr><tr><td class="type"> </td><td><b>$parametres_cli</b> </td><td></td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodafficherAvancement"></a><h3>method afficherAvancement <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Script.php.html#a268">268</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>void afficherAvancement(string$message, [int$depart = 0])</code></td></tr></table></td></tr></table><br />Utiliser cette méthode dans une boucle pour afficher un message suivi du nombre de tour de boucle effectué.<br /><br /><p>Vous devrez vous même gérer le retour à la ligne à la sortie de la boucle.</p><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>return:</b> </td><td>le message est affiché dans la console.</td></tr><tr><td><b>access:</b> </td><td>protected</td></tr></table></div><br /><br /><h4>Parameters:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td class="type">string </td><td><b>$message</b> </td><td>le message d'information.</td></tr><tr><td class="type">int </td><td><b>$depart</b> </td><td>le nombre de départ à afficher.</td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodexecuter"></a><h3>method executer <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Script.php.html#a139">139</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>void executer()</code></td></tr></table></td></tr></table><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>abstract:</b> </td><td></td></tr><tr><td><b>access:</b> </td><td>public</td></tr></table></div><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodformaterMsg"></a><h3>method formaterMsg <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Script.php.html#a252">252</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>string formaterMsg(string$message, [array$tab_arguments = array()], [$niveau = null])</code></td></tr></table></td></tr></table><br />Retourne un message d'information formaté.<br /><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>return:</b> </td><td>le message d'erreur formaté.</td></tr><tr><td><b>access:</b> </td><td>protected</td></tr></table></div><br /><br /><h4>Parameters:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td class="type">string </td><td><b>$message</b> </td><td>le message d'information avec des %s.</td></tr><tr><td class="type">array </td><td><b>$tab_arguments</b> </td><td>le tableau des paramêtres à insérer dans le message d'erreur.</td></tr><tr><td class="type"> </td><td><b>$niveau</b> </td><td></td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodgetParametre"></a><h3>method getParametre <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Script.php.html#a125">125</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>void getParametre($parametre)</code></td></tr></table></td></tr></table><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>access:</b> </td><td>protected</td></tr></table></div><br /><br /><h4>Parameters:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td class="type"> </td><td><b>$parametre</b> </td><td></td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodgetScriptChemin"></a><h3>method getScriptChemin <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Script.php.html#a117">117</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>void getScriptChemin([$doit_exister = true])</code></td></tr></table></td></tr></table><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>access:</b> </td><td>protected</td></tr></table></div><br /><br /><h4>Parameters:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td class="type"> </td><td><b>$doit_exister</b> </td><td></td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodgetScriptNom"></a><h3>method getScriptNom <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Script.php.html#a113">113</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>void getScriptNom()</code></td></tr></table></td></tr></table><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>access:</b> </td><td>protected</td></tr></table></div><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodtraiterAvertissement"></a><h3>method traiterAvertissement <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Script.php.html#a210">210</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>void. traiterAvertissement(string$message, [array$tab_arguments = array()])</code></td></tr></table></td></tr></table><br />Affiche un message d'avertissement formaté.<br /><br /><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><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>access:</b> </td><td>protected</td></tr></table></div><br /><br /><h4>Parameters:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td class="type">string </td><td><b>$message</b> </td><td>le message d'erreur avec des %s.</td></tr><tr><td class="type">array </td><td><b>$tab_arguments</b> </td><td>le tableau des paramêtres à insérer dans le message d'erreur.</td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodtraiterErreur"></a><h3>method traiterErreur <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Script.php.html#a197">197</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>void. traiterErreur(string$message, [array$tab_arguments = array()])</code></td></tr></table></td></tr></table><br />Affiche un message d'erreur formaté.<br /><br /><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><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>access:</b> </td><td>protected</td></tr></table></div><br /><br /><h4>Parameters:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td class="type">string </td><td><b>$message</b> </td><td>le message d'erreur avec des %s.</td></tr><tr><td class="type">array </td><td><b>$tab_arguments</b> </td><td>le tableau des paramêtres à insérer dans le message d'erreur.</td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div><hr /><a name="methodtraiterInfo"></a><h3>method traiterInfo <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Script.php.html#a223">223</a>]</span></h3><div class="function"><table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"><code>void. traiterInfo(string$message, [array$tab_arguments = array()])</code></td></tr></table></td></tr></table><br />Retourne un message d'information formaté.<br /><br /><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><br /><br /><br /><h4>Tags:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td><b>access:</b> </td><td>protected</td></tr></table></div><br /><br /><h4>Parameters:</h4><div class="tags"><table border="0" cellspacing="0" cellpadding="0"><tr><td class="type">string </td><td><b>$message</b> </td><td>le message d'information avec des %s.</td></tr><tr><td class="type">array </td><td><b>$tab_arguments</b> </td><td>le tableau des paramêtres à insérer dans le message d'erreur.</td></tr></table></div><br /><div class="top">[ <a href="#top">Top</a> ]</div></div></div><br /><hr /><a name="class_consts"></a><h3>Class Constants</h3><div class="tags"><a name="constMSG_AVERTISSEMENT"></a><p></p><h4>MSG_AVERTISSEMENT = <span class="value"> 2</span></h4><p>[line <a href="../__filesource/fsource_Framework__Script.php.html#a24">24</a>]</p>Niveau de message de type AVERTISSEMENT<br /><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /><a name="constMSG_ERREUR"></a><p></p><h4>MSG_ERREUR = <span class="value"> 1</span></h4><p>[line <a href="../__filesource/fsource_Framework__Script.php.html#a22">22</a>]</p>Niveau de message de type ERREUR<br /><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /><a name="constMSG_INFO"></a><p></p><h4>MSG_INFO = <span class="value"> 3</span></h4><p>[line <a href="../__filesource/fsource_Framework__Script.php.html#a26">26</a>]</p>Niveau de message de type INFORMATION<br /><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /><a name="constMSG_LOG"></a><p></p><h4>MSG_LOG = <span class="value"> 0</span></h4><p>[line <a href="../__filesource/fsource_Framework__Script.php.html#a20">20</a>]</p>Niveau de message de type LOG<br /><br /><br /><div class="top">[ <a href="#top">Top</a> ]</div><br /></div><br /><div class="credit"><hr />Documentation generated on Tue, 18 Jan 2011 15:31:28 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.3</a></div></td></tr></table></td></tr></table></body></html>