Blame | Last modification | View Log | RSS feed
<!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 MonScript | TBFramework - v0.4</title>
<script type="text/javascript" src="resources/combined.js?4205936287"></script>
<script type="text/javascript" src="elementlist.js?1964084359"></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><a href="package-Framework.html">Framework</a>
</li>
<li class="active"><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-CacheFichier.html">CacheFichier</a></li>
<li><a href="class-CacheSqlite.html">CacheSqlite</a></li>
<li class="active"><a href="class-MonScript.html">MonScript</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-None.html" title="Summary of None"><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 MonScript</h1>
<div class="description">
<p>Exemple de script utilisable avec le TBFramework. Pour le lancer, taper en
ligne de commande, en vous plaçant dans le dossier /framework/exemple/scripts/
: <code>/opt/lampp/bin/php cli.php mon_script -a test</code></p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-Script.html"><span>Script</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by">
<b><span>MonScript</span></b>
</dd>
</dl>
<div class="info">
<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>Version:</b>
$Id$<br>
<b>Located at</b> <a href="source-class-MonScript.html#3-65" title="Go to source code">exemples/scripts/modules/mon_script/MonScript.php</a><br>
</div>
<table class="summary" id="methods">
<caption>Methods summary</caption>
<tr data-order="executer" id="_executer">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_executer">#</a>
<code><a href="source-class-MonScript.html#19-31" title="Go to source code">executer</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
</table>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Script.html#methods">Script</a></caption>
<tr>
<td><code>
<a href="class-Script.html#___construct">__construct()</a>,
<a href="class-Script.html#_afficherAvancement">afficherAvancement()</a>,
<a href="class-Script.html#_formaterMsg">formaterMsg()</a>,
<a href="class-Script.html#_getParametre">getParametre()</a>,
<a href="class-Script.html#_getScriptChemin">getScriptChemin()</a>,
<a href="class-Script.html#_getScriptNom">getScriptNom()</a>,
<a href="class-Script.html#_traiterAvertissement">traiterAvertissement()</a>,
<a href="class-Script.html#_traiterErreur">traiterErreur()</a>,
<a href="class-Script.html#_traiterInfo">traiterInfo()</a>
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Constants inherited from <a href="class-Script.html#constants">Script</a></caption>
<tr>
<td><code>
<a href="class-Script.html#MSG_AVERTISSEMENT"><b>MSG_AVERTISSEMENT</b></a>,
<a href="class-Script.html#MSG_ERREUR"><b>MSG_ERREUR</b></a>,
<a href="class-Script.html#MSG_INFO"><b>MSG_INFO</b></a>,
<a href="class-Script.html#MSG_LOG"><b>MSG_LOG</b></a>
</code></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-MonScript.html#16-17" title="Go to source code"><var>$parametres_autorises</var></a>
</td>
<td class="value"><code><span class="php-keyword1">array</span>(
<span class="php-quote">'-y'</span> => <span class="php-keyword1">array</span>(<span class="php-keyword1">false</span>, <span class="php-quote">'exemple de valeur par défaut'</span>, <span class="php-quote">'Un parametre supplémentaire de test'</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>
</table>
<table class="summary inherited">
<caption>Properties inherited from <a href="class-Script.html#properties">Script</a></caption>
<tr>
<td><code>
<a href="class-Script.html#$parametres"><var>$parametres</var></a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
TBFramework - v0.4 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>