New file |
0,0 → 1,778 |
<!DOCTYPE html> |
<html> |
<head> |
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
<meta name="generator" content="ApiGen 2.8.0"> |
|
<title>Class Script | TBFramework - v0.3</title> |
|
<script type="text/javascript" src="resources/combined.js?4205936287"></script> |
<script type="text/javascript" src="elementlist.js?4111837732"></script> |
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360"> |
|
</head> |
|
<body> |
<div id="left"> |
<div id="menu"> |
<a href="index.html" title="Overview"><span>Overview</span></a> |
|
|
<div id="groups"> |
<h3>Packages</h3> |
<ul> |
<li class="active"><a href="package-Framework.html">Framework</a> |
</li> |
<li><a href="package-None.html">None</a> |
</li> |
<li><a href="package-PHP.html">PHP</a> |
</li> |
<li><a href="package-Utilitaire.html">Utilitaire</a> |
</li> |
</ul> |
</div> |
|
<hr> |
|
|
<div id="elements"> |
<h3>Classes</h3> |
<ul> |
<li><a href="class-Bdd.html">Bdd</a></li> |
<li><a href="class-Cache.html">Cache</a></li> |
<li><a href="class-CacheSimple.html">CacheSimple</a></li> |
<li><a href="class-Chronometre.html">Chronometre</a></li> |
<li><a href="class-Cli.html">Cli</a></li> |
<li><a href="class-Config.html">Config</a></li> |
<li><a href="class-Controleur.html">Controleur</a></li> |
<li><a href="class-Debug.html">Debug</a></li> |
<li><a href="class-Framework.html">Framework</a></li> |
<li><a href="class-GestionnaireException.html">GestionnaireException</a></li> |
<li><a href="class-I18n.html">I18n</a></li> |
<li><a href="class-Log.html">Log</a></li> |
<li><a href="class-Registre.html">Registre</a></li> |
<li><a href="class-RestClient.html">RestClient</a></li> |
<li><a href="class-RestServeur.html">RestServeur</a></li> |
<li><a href="class-RestService.html">RestService</a></li> |
<li class="active"><a href="class-Script.html">Script</a></li> |
<li><a href="class-SquelettePhp.html">SquelettePhp</a></li> |
<li><a href="class-Url.html">Url</a></li> |
</ul> |
|
|
|
|
|
</div> |
</div> |
</div> |
|
<div id="splitter"></div> |
|
<div id="right"> |
<div id="rightInner"> |
<form id="search"> |
<input type="hidden" name="cx" value=""> |
<input type="hidden" name="ie" value="UTF-8"> |
<input type="text" name="q" class="text"> |
<input type="submit" value="Search"> |
</form> |
|
<div id="navigation"> |
<ul> |
<li> |
<a href="index.html" title="Overview"><span>Overview</span></a> |
</li> |
<li> |
<a href="package-Framework.html" title="Summary of Framework"><span>Package</span></a> |
</li> |
<li class="active"> |
<span>Class</span> </li> |
</ul> |
<ul> |
<li> |
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a> |
</li> |
<li> |
<a href="deprecated.html" title="List of deprecated elements"><span>Deprecated</span></a> |
</li> |
<li> |
<a href="todo.html" title="Todo list"><span>Todo</span></a> |
</li> |
</ul> |
<ul> |
</ul> |
</div> |
|
<div id="content" class="class"> |
<h1>Class Script</h1> |
|
|
<div class="description"> |
|
<p>Script est une classe abstraite qui doit être implémenté par les classes |
éxecutant des scripts en ligne de commande.</p> |
|
</div> |
|
|
|
|
|
|
|
|
|
<div class="info"> |
<b>Abstract</b><br> |
|
|
<b>Package:</b> <a href="package-Framework.html">Framework</a><br> |
|
<b>Category:</b> |
PHP 5.2<br> |
<b>Copyright:</b> |
Copyright (c) 2010, Tela Botanica (<a |
href="mailto:accueil@tela-botanica.org">accueil@<!-- -->tela-botanica.org</a>)<br> |
<b>License:</b> |
<a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL-v3</a><br> |
<b>License:</b> |
<a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL-v2</a><br> |
<b>Author:</b> |
Jean-Pascal MILCENT <<a |
href="mailto:jpm@tela-botanica.org">jpm@<!-- -->tela-botanica.org</a>><br> |
<b>Author:</b> |
Delphine CAUQUIL <<a |
href="mailto:delphine@tela-botanica.org">delphine@<!-- -->tela-botanica.org</a>><br> |
<b>Version:</b> |
$Id: Script.php 299 2011-01-18 14:03:46Z jpm $<br> |
<b>Since:</b> |
0.3<br> |
<b>Link:</b> |
/doc/framework/<br> |
<b>Located at</b> <a href="source-class-Script.html#4-288" title="Go to source code">Script.php</a><br> |
</div> |
|
|
|
<table class="summary" id="methods"> |
<caption>Methods summary</caption> |
<tr data-order="__construct" id="___construct"> |
|
<td class="attributes"><code> |
public |
|
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#___construct">#</a> |
<code><a href="source-class-Script.html#96-107" title="Go to source code">__construct</a>( <span>mixed <var>$script_nom</var></span>, <span>mixed <var>$parametres_cli</var></span> )</code> |
|
<div class="description short"> |
|
</div> |
|
<div class="description detailed hidden"> |
|
|
|
|
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="getScriptNom" id="_getScriptNom"> |
|
<td class="attributes"><code> |
protected |
|
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_getScriptNom">#</a> |
<code><a href="source-class-Script.html#113-115" title="Go to source code">getScriptNom</a>( )</code> |
|
<div class="description short"> |
|
</div> |
|
<div class="description detailed hidden"> |
|
|
|
|
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="getScriptChemin" id="_getScriptChemin"> |
|
<td class="attributes"><code> |
protected |
|
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_getScriptChemin">#</a> |
<code><a href="source-class-Script.html#117-123" title="Go to source code">getScriptChemin</a>( <span>mixed <var>$doit_exister</var> = <span class="php-keyword1">true</span></span> )</code> |
|
<div class="description short"> |
|
</div> |
|
<div class="description detailed hidden"> |
|
|
|
|
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="getParametre" id="_getParametre"> |
|
<td class="attributes"><code> |
protected |
|
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_getParametre">#</a> |
<code><a href="source-class-Script.html#125-137" title="Go to source code">getParametre</a>( <span>mixed <var>$parametre</var></span> )</code> |
|
<div class="description short"> |
|
</div> |
|
<div class="description detailed hidden"> |
|
|
|
|
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="executer" id="_executer"> |
|
<td class="attributes"><code> |
abstract public |
|
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_executer">#</a> |
<code><a href="source-class-Script.html#139" title="Go to source code">executer</a>( )</code> |
|
<div class="description short"> |
|
</div> |
|
<div class="description detailed hidden"> |
|
|
|
|
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="traiterErreur" id="_traiterErreur"> |
|
<td class="attributes"><code> |
protected |
void. |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_traiterErreur">#</a> |
<code><a href="source-class-Script.html#189-199" title="Go to source code">traiterErreur</a>( <span>string <var>$message</var></span>, <span>array <var>$tab_arguments</var> = <span class="php-keyword1">array</span>()</span> )</code> |
|
<div class="description short"> |
|
<p>Affiche un message d'erreur formaté. 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> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Affiche un message d'erreur formaté. 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> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$message</var></dt> |
<dd><code>string</code><br>le message d'erreur avec des %s.</dd> |
<dt><var>$tab_arguments</var></dt> |
<dd><code>array</code><br>le tableau des paramêtres à insérer dans le message d'erreur.</dd> |
</dl></div> |
|
<h4>Returns</h4> |
<div class="list"> |
<code>void.</code><br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="traiterAvertissement" id="_traiterAvertissement"> |
|
<td class="attributes"><code> |
protected |
void. |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_traiterAvertissement">#</a> |
<code><a href="source-class-Script.html#201-212" title="Go to source code">traiterAvertissement</a>( <span>string <var>$message</var></span>, <span>array <var>$tab_arguments</var> = <span class="php-keyword1">array</span>()</span> )</code> |
|
<div class="description short"> |
|
<p>Affiche un message d'avertissement formaté. 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> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Affiche un message d'avertissement formaté. 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> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$message</var></dt> |
<dd><code>string</code><br>le message d'erreur avec des %s.</dd> |
<dt><var>$tab_arguments</var></dt> |
<dd><code>array</code><br>le tableau des paramêtres à insérer dans le message d'erreur.</dd> |
</dl></div> |
|
<h4>Returns</h4> |
<div class="list"> |
<code>void.</code><br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="traiterInfo" id="_traiterInfo"> |
|
<td class="attributes"><code> |
protected |
void. |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_traiterInfo">#</a> |
<code><a href="source-class-Script.html#214-225" title="Go to source code">traiterInfo</a>( <span>string <var>$message</var></span>, <span>array <var>$tab_arguments</var> = <span class="php-keyword1">array</span>()</span> )</code> |
|
<div class="description short"> |
|
<p>Retourne un message d'information formaté. 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> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Retourne un message d'information formaté. 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> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$message</var></dt> |
<dd><code>string</code><br>le message d'information avec des %s.</dd> |
<dt><var>$tab_arguments</var></dt> |
<dd><code>array</code><br>le tableau des paramêtres à insérer dans le message d'erreur.</dd> |
</dl></div> |
|
<h4>Returns</h4> |
<div class="list"> |
<code>void.</code><br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="formaterMsg" id="_formaterMsg"> |
|
<td class="attributes"><code> |
protected |
string |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_formaterMsg">#</a> |
<code><a href="source-class-Script.html#245-258" title="Go to source code">formaterMsg</a>( <span>string <var>$message</var></span>, <span>array <var>$tab_arguments</var> = <span class="php-keyword1">array</span>()</span>, <span>mixed <var>$niveau</var> = <span class="php-keyword1">null</span></span> )</code> |
|
<div class="description short"> |
|
<p>Retourne un message d'information formaté.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Retourne un message d'information formaté.</p> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$message</var></dt> |
<dd><code>string</code><br>le message d'information avec des %s.</dd> |
<dt><var>$tab_arguments</var></dt> |
<dd><code>array</code><br>le tableau des paramêtres à insérer dans le message d'erreur.</dd> |
<dt><var>$niveau</var></dt> |
<dd></dd> |
</dl></div> |
|
<h4>Returns</h4> |
<div class="list"> |
<code>string</code><br>le message d'erreur formaté.<br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="afficherAvancement" id="_afficherAvancement"> |
|
<td class="attributes"><code> |
protected |
|
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_afficherAvancement">#</a> |
<code><a href="source-class-Script.html#260-287" title="Go to source code">afficherAvancement</a>( <span>string <var>$message</var></span>, <span>integer <var>$depart</var> = <span class="php-num">0</span></span> )</code> |
|
<div class="description short"> |
|
<p>Utiliser cette méthode dans une boucle pour afficher un message suivi du |
nombre de tour de boucle effectué. Vous devrez vous même gérer le retour à |
la ligne à la sortie de la boucle.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Utiliser cette méthode dans une boucle pour afficher un message suivi du |
nombre de tour de boucle effectué. Vous devrez vous même gérer le retour à |
la ligne à la sortie de la boucle.</p> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$message</var></dt> |
<dd><code>string</code><br>le message d'information.</dd> |
<dt><var>$depart</var></dt> |
<dd><code>integer</code><br>le nombre de départ à afficher.</dd> |
</dl></div> |
|
<h4>Returns</h4> |
<div class="list"> |
<code></code><br>le message est affiché dans la console.<br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
</table> |
|
|
|
|
|
|
|
|
<table class="summary" id="constants"> |
<caption>Constants summary</caption> |
<tr data-order="MSG_LOG" id="MSG_LOG"> |
|
<td class="attributes"><code>integer</code></td> |
<td class="name"><code> |
<a href="source-class-Script.html#19-20" title="Go to source code"><b>MSG_LOG</b></a> |
</code></td> |
<td class="value"><code><span class="php-num">0</span></code></td> |
<td class="description"><div> |
<a href="#MSG_LOG" class="anchor">#</a> |
|
<div class="description short"> |
|
<p>Niveau de message de type LOG</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Niveau de message de type LOG</p> |
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="MSG_ERREUR" id="MSG_ERREUR"> |
|
<td class="attributes"><code>integer</code></td> |
<td class="name"><code> |
<a href="source-class-Script.html#21-22" title="Go to source code"><b>MSG_ERREUR</b></a> |
</code></td> |
<td class="value"><code><span class="php-num">1</span></code></td> |
<td class="description"><div> |
<a href="#MSG_ERREUR" class="anchor">#</a> |
|
<div class="description short"> |
|
<p>Niveau de message de type ERREUR</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Niveau de message de type ERREUR</p> |
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="MSG_AVERTISSEMENT" id="MSG_AVERTISSEMENT"> |
|
<td class="attributes"><code>integer</code></td> |
<td class="name"><code> |
<a href="source-class-Script.html#23-24" title="Go to source code"><b>MSG_AVERTISSEMENT</b></a> |
</code></td> |
<td class="value"><code><span class="php-num">2</span></code></td> |
<td class="description"><div> |
<a href="#MSG_AVERTISSEMENT" class="anchor">#</a> |
|
<div class="description short"> |
|
<p>Niveau de message de type AVERTISSEMENT</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Niveau de message de type AVERTISSEMENT</p> |
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="MSG_INFO" id="MSG_INFO"> |
|
<td class="attributes"><code>integer</code></td> |
<td class="name"><code> |
<a href="source-class-Script.html#25-26" title="Go to source code"><b>MSG_INFO</b></a> |
</code></td> |
<td class="value"><code><span class="php-num">3</span></code></td> |
<td class="description"><div> |
<a href="#MSG_INFO" class="anchor">#</a> |
|
<div class="description short"> |
|
<p>Niveau de message de type INFORMATION</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Niveau de message de type INFORMATION</p> |
|
|
</div> |
</div></td> |
</tr> |
</table> |
|
|
|
|
<table class="summary" id="properties"> |
<caption>Properties summary</caption> |
<tr data-order="parametres_autorises" id="$parametres_autorises"> |
<td class="attributes"><code> |
protected |
array |
</code></td> |
|
<td class="name"> |
<a href="source-class-Script.html#54-67" title="Go to source code"><var>$parametres_autorises</var></a> |
</td> |
<td class="value"><code><span class="php-keyword1">null</span></code></td> |
<td class="description"><div> |
<a href="#$parametres_autorises" class="anchor">#</a> |
|
<div class="description short"> |
|
<p>Paramêtres autorisés par le script. le tableau est de la forme suivante |
:</p> |
|
<ul> |
<li>clé = nom du paramêtre '-foo'</li> |
|
<li>value = contient un nouveau tableau composé de cette façon : |
<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> |
</li> |
</ul> |
|
<p>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> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Paramêtres autorisés par le script. le tableau est de la forme suivante |
:</p> |
|
<ul> |
<li>clé = nom du paramêtre '-foo'</li> |
|
<li>value = contient un nouveau tableau composé de cette façon : - booléen: |
true si le paramêtre est obligatoire - booléen ou var : true si le paramêtre |
nécessite un valeur à sa suite ou la valeur par défaut - string: description |
du contenu du paramêtre</li> |
</ul> |
|
<p>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> |
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="parametres" id="$parametres"> |
<td class="attributes"><code> |
protected |
array |
</code></td> |
|
<td class="name"> |
<a href="source-class-Script.html#78-85" title="Go to source code"><var>$parametres</var></a> |
</td> |
<td class="value"><code><span class="php-keyword1">null</span></code></td> |
<td class="description"><div> |
<a href="#$parametres" class="anchor">#</a> |
|
<div class="description short"> |
|
<p>Contient le tableau des paramètres disponible après vérification : le |
tableau est de la forme suivante :</p> |
|
<ul> |
<li>clé = nom du paramêtre '-foo'</li> |
|
<li>valeur = la valeur récupérée sur la ligne de commande</li> |
</ul> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Contient le tableau des paramètres disponible après vérification : le |
tableau est de la forme suivante :</p> |
|
<ul> |
<li>clé = nom du paramêtre '-foo'</li> |
|
<li>valeur = la valeur récupérée sur la ligne de commande</li> |
</ul> |
|
|
</div> |
</div></td> |
</tr> |
</table> |
|
|
|
|
|
|
</div> |
|
<div id="footer"> |
TBFramework - v0.3 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a> |
</div> |
</div> |
</div> |
</body> |
</html> |