| 464 |
jpm |
1 |
<!DOCTYPE html>
|
|
|
2 |
<html>
|
|
|
3 |
<head>
|
|
|
4 |
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
|
5 |
<meta name="generator" content="ApiGen 2.8.0">
|
|
|
6 |
|
|
|
7 |
<title>Class MonScript | TBFramework - v0.4</title>
|
|
|
8 |
|
|
|
9 |
<script type="text/javascript" src="resources/combined.js?4205936287"></script>
|
|
|
10 |
<script type="text/javascript" src="elementlist.js?1964084359"></script>
|
|
|
11 |
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360">
|
|
|
12 |
|
|
|
13 |
</head>
|
|
|
14 |
|
|
|
15 |
<body>
|
|
|
16 |
<div id="left">
|
|
|
17 |
<div id="menu">
|
|
|
18 |
<a href="index.html" title="Overview"><span>Overview</span></a>
|
|
|
19 |
|
|
|
20 |
|
|
|
21 |
<div id="groups">
|
|
|
22 |
<h3>Packages</h3>
|
|
|
23 |
<ul>
|
|
|
24 |
<li><a href="package-Framework.html">Framework</a>
|
|
|
25 |
</li>
|
|
|
26 |
<li class="active"><a href="package-None.html">None</a>
|
|
|
27 |
</li>
|
|
|
28 |
<li><a href="package-PHP.html">PHP</a>
|
|
|
29 |
</li>
|
|
|
30 |
<li><a href="package-Utilitaire.html">Utilitaire</a>
|
|
|
31 |
</li>
|
|
|
32 |
</ul>
|
|
|
33 |
</div>
|
|
|
34 |
|
|
|
35 |
<hr>
|
|
|
36 |
|
|
|
37 |
|
|
|
38 |
<div id="elements">
|
|
|
39 |
<h3>Classes</h3>
|
|
|
40 |
<ul>
|
|
|
41 |
<li><a href="class-CacheFichier.html">CacheFichier</a></li>
|
|
|
42 |
<li><a href="class-CacheSqlite.html">CacheSqlite</a></li>
|
|
|
43 |
<li class="active"><a href="class-MonScript.html">MonScript</a></li>
|
|
|
44 |
</ul>
|
|
|
45 |
|
|
|
46 |
|
|
|
47 |
|
|
|
48 |
|
|
|
49 |
|
|
|
50 |
</div>
|
|
|
51 |
</div>
|
|
|
52 |
</div>
|
|
|
53 |
|
|
|
54 |
<div id="splitter"></div>
|
|
|
55 |
|
|
|
56 |
<div id="right">
|
|
|
57 |
<div id="rightInner">
|
|
|
58 |
<form id="search">
|
|
|
59 |
<input type="hidden" name="cx" value="">
|
|
|
60 |
<input type="hidden" name="ie" value="UTF-8">
|
|
|
61 |
<input type="text" name="q" class="text">
|
|
|
62 |
<input type="submit" value="Search">
|
|
|
63 |
</form>
|
|
|
64 |
|
|
|
65 |
<div id="navigation">
|
|
|
66 |
<ul>
|
|
|
67 |
<li>
|
|
|
68 |
<a href="index.html" title="Overview"><span>Overview</span></a>
|
|
|
69 |
</li>
|
|
|
70 |
<li>
|
|
|
71 |
<a href="package-None.html" title="Summary of None"><span>Package</span></a>
|
|
|
72 |
</li>
|
|
|
73 |
<li class="active">
|
|
|
74 |
<span>Class</span> </li>
|
|
|
75 |
</ul>
|
|
|
76 |
<ul>
|
|
|
77 |
<li>
|
|
|
78 |
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
|
|
|
79 |
</li>
|
|
|
80 |
<li>
|
|
|
81 |
<a href="deprecated.html" title="List of deprecated elements"><span>Deprecated</span></a>
|
|
|
82 |
</li>
|
|
|
83 |
<li>
|
|
|
84 |
<a href="todo.html" title="Todo list"><span>Todo</span></a>
|
|
|
85 |
</li>
|
|
|
86 |
</ul>
|
|
|
87 |
<ul>
|
|
|
88 |
</ul>
|
|
|
89 |
</div>
|
|
|
90 |
|
|
|
91 |
<div id="content" class="class">
|
|
|
92 |
<h1>Class MonScript</h1>
|
|
|
93 |
|
|
|
94 |
|
|
|
95 |
<div class="description">
|
|
|
96 |
|
|
|
97 |
<p>Exemple de script utilisable avec le TBFramework. Pour le lancer, taper en
|
|
|
98 |
ligne de commande, en vous plaçant dans le dossier /framework/exemple/scripts/
|
|
|
99 |
: <code>/opt/lampp/bin/php cli.php mon_script -a test</code></p>
|
|
|
100 |
|
|
|
101 |
</div>
|
|
|
102 |
|
|
|
103 |
<dl class="tree">
|
|
|
104 |
<dd style="padding-left:0px">
|
|
|
105 |
<a href="class-Script.html"><span>Script</span></a>
|
|
|
106 |
|
|
|
107 |
|
|
|
108 |
|
|
|
109 |
</dd>
|
|
|
110 |
<dd style="padding-left:30px">
|
|
|
111 |
<img src="resources/inherit.png" alt="Extended by">
|
|
|
112 |
<b><span>MonScript</span></b>
|
|
|
113 |
|
|
|
114 |
|
|
|
115 |
</dd>
|
|
|
116 |
</dl>
|
|
|
117 |
|
|
|
118 |
|
|
|
119 |
|
|
|
120 |
|
|
|
121 |
|
|
|
122 |
|
|
|
123 |
|
|
|
124 |
|
|
|
125 |
<div class="info">
|
|
|
126 |
|
|
|
127 |
|
|
|
128 |
|
|
|
129 |
|
|
|
130 |
|
|
|
131 |
<b>Copyright:</b>
|
|
|
132 |
Copyright (c) 2010, Tela Botanica (<a
|
|
|
133 |
href="mailto:accueil@tela-botanica.org">accueil@<!-- -->tela-botanica.org</a>)<br>
|
|
|
134 |
<b>License:</b>
|
|
|
135 |
<a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL-v3</a><br>
|
|
|
136 |
<b>License:</b>
|
|
|
137 |
<a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL-v2</a><br>
|
|
|
138 |
<b>Author:</b>
|
|
|
139 |
Jean-Pascal MILCENT <<a
|
|
|
140 |
href="mailto:jpm@tela-botanica.org">jpm@<!-- -->tela-botanica.org</a>><br>
|
|
|
141 |
<b>Version:</b>
|
|
|
142 |
$Id$<br>
|
|
|
143 |
<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>
|
|
|
144 |
</div>
|
|
|
145 |
|
|
|
146 |
|
|
|
147 |
|
|
|
148 |
<table class="summary" id="methods">
|
|
|
149 |
<caption>Methods summary</caption>
|
|
|
150 |
<tr data-order="executer" id="_executer">
|
|
|
151 |
|
|
|
152 |
<td class="attributes"><code>
|
|
|
153 |
public
|
|
|
154 |
|
|
|
155 |
|
|
|
156 |
</code>
|
|
|
157 |
</td>
|
|
|
158 |
|
|
|
159 |
<td class="name"><div>
|
|
|
160 |
<a class="anchor" href="#_executer">#</a>
|
|
|
161 |
<code><a href="source-class-MonScript.html#19-31" title="Go to source code">executer</a>( )</code>
|
|
|
162 |
|
|
|
163 |
<div class="description short">
|
|
|
164 |
|
|
|
165 |
</div>
|
|
|
166 |
|
|
|
167 |
<div class="description detailed hidden">
|
|
|
168 |
|
|
|
169 |
|
|
|
170 |
|
|
|
171 |
|
|
|
172 |
|
|
|
173 |
|
|
|
174 |
|
|
|
175 |
|
|
|
176 |
</div>
|
|
|
177 |
</div></td>
|
|
|
178 |
</tr>
|
|
|
179 |
</table>
|
|
|
180 |
|
|
|
181 |
<table class="summary inherited">
|
|
|
182 |
<caption>Methods inherited from <a href="class-Script.html#methods">Script</a></caption>
|
|
|
183 |
<tr>
|
|
|
184 |
<td><code>
|
|
|
185 |
<a href="class-Script.html#___construct">__construct()</a>,
|
|
|
186 |
<a href="class-Script.html#_afficherAvancement">afficherAvancement()</a>,
|
|
|
187 |
<a href="class-Script.html#_formaterMsg">formaterMsg()</a>,
|
|
|
188 |
<a href="class-Script.html#_getParametre">getParametre()</a>,
|
|
|
189 |
<a href="class-Script.html#_getScriptChemin">getScriptChemin()</a>,
|
|
|
190 |
<a href="class-Script.html#_getScriptNom">getScriptNom()</a>,
|
|
|
191 |
<a href="class-Script.html#_traiterAvertissement">traiterAvertissement()</a>,
|
|
|
192 |
<a href="class-Script.html#_traiterErreur">traiterErreur()</a>,
|
|
|
193 |
<a href="class-Script.html#_traiterInfo">traiterInfo()</a>
|
|
|
194 |
</code></td>
|
|
|
195 |
</tr>
|
|
|
196 |
</table>
|
|
|
197 |
|
|
|
198 |
|
|
|
199 |
|
|
|
200 |
|
|
|
201 |
|
|
|
202 |
|
|
|
203 |
|
|
|
204 |
|
|
|
205 |
<table class="summary inherited">
|
|
|
206 |
<caption>Constants inherited from <a href="class-Script.html#constants">Script</a></caption>
|
|
|
207 |
<tr>
|
|
|
208 |
<td><code>
|
|
|
209 |
<a href="class-Script.html#MSG_AVERTISSEMENT"><b>MSG_AVERTISSEMENT</b></a>,
|
|
|
210 |
<a href="class-Script.html#MSG_ERREUR"><b>MSG_ERREUR</b></a>,
|
|
|
211 |
<a href="class-Script.html#MSG_INFO"><b>MSG_INFO</b></a>,
|
|
|
212 |
<a href="class-Script.html#MSG_LOG"><b>MSG_LOG</b></a>
|
|
|
213 |
</code></td>
|
|
|
214 |
</tr>
|
|
|
215 |
</table>
|
|
|
216 |
|
|
|
217 |
|
|
|
218 |
|
|
|
219 |
<table class="summary" id="properties">
|
|
|
220 |
<caption>Properties summary</caption>
|
|
|
221 |
<tr data-order="parametres_autorises" id="$parametres_autorises">
|
|
|
222 |
<td class="attributes"><code>
|
|
|
223 |
protected
|
|
|
224 |
array
|
|
|
225 |
</code></td>
|
|
|
226 |
|
|
|
227 |
<td class="name">
|
|
|
228 |
<a href="source-class-MonScript.html#16-17" title="Go to source code"><var>$parametres_autorises</var></a>
|
|
|
229 |
</td>
|
|
|
230 |
<td class="value"><code><span class="php-keyword1">array</span>(
|
|
|
231 |
<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>
|
|
|
232 |
<td class="description"><div>
|
|
|
233 |
<a href="#$parametres_autorises" class="anchor">#</a>
|
|
|
234 |
|
|
|
235 |
<div class="description short">
|
|
|
236 |
|
|
|
237 |
<p>Paramêtres autorisés par le script. le tableau est de la forme suivante
|
|
|
238 |
:</p>
|
|
|
239 |
|
|
|
240 |
<ul>
|
|
|
241 |
<li>clé = nom du paramêtre '-foo'</li>
|
|
|
242 |
|
|
|
243 |
<li>value = contient un nouveau tableau composé de cette façon :
|
|
|
244 |
<ul>
|
|
|
245 |
<li>booléen: true si le paramêtre est obligatoire</li>
|
|
|
246 |
|
|
|
247 |
<li>booléen ou var : true si le paramêtre nécessite un valeur à sa suite ou
|
|
|
248 |
la valeur par défaut</li>
|
|
|
249 |
|
|
|
250 |
<li>string: description du contenu du paramêtre</li>
|
|
|
251 |
</ul>
|
|
|
252 |
</li>
|
|
|
253 |
</ul>
|
|
|
254 |
|
|
|
255 |
<p>Les paramêtres optionels devraient être déclaré à la fin du tableau. Le
|
|
|
256 |
dernier parametre du tableau peut avoir la valeur '...', il contiendra alors
|
|
|
257 |
l'ensemble des paramêtres suivant trouvés sur la ligne de commande.</p>
|
|
|
258 |
|
|
|
259 |
</div>
|
|
|
260 |
|
|
|
261 |
<div class="description detailed hidden">
|
|
|
262 |
|
|
|
263 |
<p>Paramêtres autorisés par le script. le tableau est de la forme suivante
|
|
|
264 |
:</p>
|
|
|
265 |
|
|
|
266 |
<ul>
|
|
|
267 |
<li>clé = nom du paramêtre '-foo'</li>
|
|
|
268 |
|
|
|
269 |
<li>value = contient un nouveau tableau composé de cette façon : - booléen:
|
|
|
270 |
true si le paramêtre est obligatoire - booléen ou var : true si le paramêtre
|
|
|
271 |
nécessite un valeur à sa suite ou la valeur par défaut - string: description
|
|
|
272 |
du contenu du paramêtre</li>
|
|
|
273 |
</ul>
|
|
|
274 |
|
|
|
275 |
<p>Les paramêtres optionels devraient être déclaré à la fin du tableau. Le
|
|
|
276 |
dernier parametre du tableau peut avoir la valeur '...', il contiendra alors
|
|
|
277 |
l'ensemble des paramêtres suivant trouvés sur la ligne de commande.</p>
|
|
|
278 |
|
|
|
279 |
|
|
|
280 |
</div>
|
|
|
281 |
</div></td>
|
|
|
282 |
</tr>
|
|
|
283 |
</table>
|
|
|
284 |
|
|
|
285 |
<table class="summary inherited">
|
|
|
286 |
<caption>Properties inherited from <a href="class-Script.html#properties">Script</a></caption>
|
|
|
287 |
<tr>
|
|
|
288 |
<td><code>
|
|
|
289 |
<a href="class-Script.html#$parametres"><var>$parametres</var></a>
|
|
|
290 |
</code></td>
|
|
|
291 |
</tr>
|
|
|
292 |
</table>
|
|
|
293 |
|
|
|
294 |
|
|
|
295 |
|
|
|
296 |
|
|
|
297 |
|
|
|
298 |
</div>
|
|
|
299 |
|
|
|
300 |
<div id="footer">
|
|
|
301 |
TBFramework - v0.4 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
|
|
302 |
</div>
|
|
|
303 |
</div>
|
|
|
304 |
</div>
|
|
|
305 |
</body>
|
|
|
306 |
</html>
|