| 297 |
jpm |
1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
2 |
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
|
3 |
<head>
|
|
|
4 |
<!-- template designed by Marco Von Ballmoos -->
|
|
|
5 |
<title>Docs For Class Script</title>
|
|
|
6 |
<meta http-equiv='Content-Type' content='text/html; charset=UTF-8'/>
|
|
|
7 |
<link rel="stylesheet" href="../media/stylesheet.css" />
|
|
|
8 |
<script src="../media/lib/classTree.js"></script>
|
|
|
9 |
<script language="javascript" type="text/javascript">
|
|
|
10 |
var imgPlus = new Image();
|
|
|
11 |
var imgMinus = new Image();
|
|
|
12 |
imgPlus.src = "../media/images/plus.png";
|
|
|
13 |
imgMinus.src = "../media/images/minus.png";
|
|
|
14 |
|
|
|
15 |
function showNode(Node){
|
|
|
16 |
switch(navigator.family){
|
|
|
17 |
case 'nn4':
|
|
|
18 |
// Nav 4.x code fork...
|
|
|
19 |
var oTable = document.layers["span" + Node];
|
|
|
20 |
var oImg = document.layers["img" + Node];
|
|
|
21 |
break;
|
|
|
22 |
case 'ie4':
|
|
|
23 |
// IE 4/5 code fork...
|
|
|
24 |
var oTable = document.all["span" + Node];
|
|
|
25 |
var oImg = document.all["img" + Node];
|
|
|
26 |
break;
|
|
|
27 |
case 'gecko':
|
|
|
28 |
// Standards Compliant code fork...
|
|
|
29 |
var oTable = document.getElementById("span" + Node);
|
|
|
30 |
var oImg = document.getElementById("img" + Node);
|
|
|
31 |
break;
|
|
|
32 |
}
|
|
|
33 |
oImg.src = imgMinus.src;
|
|
|
34 |
oTable.style.display = "block";
|
|
|
35 |
}
|
|
|
36 |
|
|
|
37 |
function hideNode(Node){
|
|
|
38 |
switch(navigator.family){
|
|
|
39 |
case 'nn4':
|
|
|
40 |
// Nav 4.x code fork...
|
|
|
41 |
var oTable = document.layers["span" + Node];
|
|
|
42 |
var oImg = document.layers["img" + Node];
|
|
|
43 |
break;
|
|
|
44 |
case 'ie4':
|
|
|
45 |
// IE 4/5 code fork...
|
|
|
46 |
var oTable = document.all["span" + Node];
|
|
|
47 |
var oImg = document.all["img" + Node];
|
|
|
48 |
break;
|
|
|
49 |
case 'gecko':
|
|
|
50 |
// Standards Compliant code fork...
|
|
|
51 |
var oTable = document.getElementById("span" + Node);
|
|
|
52 |
var oImg = document.getElementById("img" + Node);
|
|
|
53 |
break;
|
|
|
54 |
}
|
|
|
55 |
oImg.src = imgPlus.src;
|
|
|
56 |
oTable.style.display = "none";
|
|
|
57 |
}
|
|
|
58 |
|
|
|
59 |
function nodeIsVisible(Node){
|
|
|
60 |
switch(navigator.family){
|
|
|
61 |
case 'nn4':
|
|
|
62 |
// Nav 4.x code fork...
|
|
|
63 |
var oTable = document.layers["span" + Node];
|
|
|
64 |
break;
|
|
|
65 |
case 'ie4':
|
|
|
66 |
// IE 4/5 code fork...
|
|
|
67 |
var oTable = document.all["span" + Node];
|
|
|
68 |
break;
|
|
|
69 |
case 'gecko':
|
|
|
70 |
// Standards Compliant code fork...
|
|
|
71 |
var oTable = document.getElementById("span" + Node);
|
|
|
72 |
break;
|
|
|
73 |
}
|
|
|
74 |
return (oTable && oTable.style.display == "block");
|
|
|
75 |
}
|
|
|
76 |
|
|
|
77 |
function toggleNodeVisibility(Node){
|
|
|
78 |
if (nodeIsVisible(Node)){
|
|
|
79 |
hideNode(Node);
|
|
|
80 |
}else{
|
|
|
81 |
showNode(Node);
|
|
|
82 |
}
|
|
|
83 |
}
|
|
|
84 |
</script>
|
|
|
85 |
</head>
|
|
|
86 |
<body>
|
|
|
87 |
<div class="page-body">
|
|
|
88 |
<h2 class="class-name">Class Script</h2>
|
|
|
89 |
|
|
|
90 |
<a name="sec-description"></a>
|
|
|
91 |
<div class="info-box">
|
|
|
92 |
<div class="info-box-title">Description</div>
|
|
|
93 |
<div class="nav-bar">
|
|
|
94 |
<span class="disabled">Description</span> |
|
|
|
95 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
|
|
96 |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
97 |
|
|
|
98 |
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
|
|
|
99 |
|
|
|
100 |
</div>
|
|
|
101 |
<div class="info-box-body">
|
|
|
102 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
103 |
<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>
|
|
|
104 |
<ul class="tags">
|
|
|
105 |
<li><span class="field">author:</span> Delphine CAUQUIL <<a href="mailto:delphine@tela-botanica.org">delphine@tela-botanica.org</a>></li>
|
|
|
106 |
<li><span class="field">author:</span> Jean-Pascal MILCENT <<a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a>></li>
|
| 300 |
jpm |
107 |
<li><span class="field">version:</span> $Id: Script.php 299 2011-01-18 14:03:46Z jpm $</li>
|
| 297 |
jpm |
108 |
<li><span class="field">copyright:</span> Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</li>
|
|
|
109 |
<li><span class="field">link:</span> /doc/framework/</li>
|
|
|
110 |
<li><span class="field">abstract:</span> </li>
|
|
|
111 |
<li><span class="field">since:</span> 0.3</li>
|
|
|
112 |
<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL-v3</a></li>
|
|
|
113 |
<li><span class="field">license:</span> <a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL-v2</a></li>
|
|
|
114 |
</ul>
|
|
|
115 |
<p class="notes">
|
|
|
116 |
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>)
|
|
|
117 |
</p>
|
|
|
118 |
|
|
|
119 |
|
|
|
120 |
<pre></pre>
|
|
|
121 |
|
|
|
122 |
</div>
|
|
|
123 |
</div>
|
|
|
124 |
|
|
|
125 |
|
|
|
126 |
<a name="sec-const-summary"></a>
|
|
|
127 |
<div class="info-box">
|
|
|
128 |
<div class="info-box-title">Class Constant Summary</span></div>
|
|
|
129 |
<div class="nav-bar">
|
|
|
130 |
<a href="#sec-description">Description</a> |
|
|
|
131 |
<span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
|
|
|
132 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
|
|
133 |
|
|
|
134 |
|
|
|
|
135 |
|
|
|
|
136 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
137 |
|
|
|
138 |
</div>
|
|
|
139 |
<div class="info-box-body">
|
|
|
140 |
<div class="const-summary">
|
|
|
141 |
<div class="const-title">
|
|
|
142 |
<img src="../media/images/Constant.png" alt=" " />
|
|
|
143 |
<a href="#MSG_AVERTISSEMENT" title="details" class="const-name">MSG_AVERTISSEMENT</a> = <span class="var-type"> 2</span>
|
|
|
144 |
|
|
|
145 |
</div>
|
|
|
146 |
<div class="const-title">
|
|
|
147 |
<img src="../media/images/Constant.png" alt=" " />
|
|
|
148 |
<a href="#MSG_ERREUR" title="details" class="const-name">MSG_ERREUR</a> = <span class="var-type"> 1</span>
|
|
|
149 |
|
|
|
150 |
</div>
|
|
|
151 |
<div class="const-title">
|
|
|
152 |
<img src="../media/images/Constant.png" alt=" " />
|
|
|
153 |
<a href="#MSG_INFO" title="details" class="const-name">MSG_INFO</a> = <span class="var-type"> 3</span>
|
|
|
154 |
|
|
|
155 |
</div>
|
|
|
156 |
<div class="const-title">
|
|
|
157 |
<img src="../media/images/Constant.png" alt=" " />
|
|
|
158 |
<a href="#MSG_LOG" title="details" class="const-name">MSG_LOG</a> = <span class="var-type"> 0</span>
|
|
|
159 |
|
|
|
160 |
</div>
|
|
|
161 |
</div>
|
|
|
162 |
</div>
|
|
|
163 |
</div>
|
|
|
164 |
|
|
|
165 |
<a name="sec-var-summary"></a>
|
|
|
166 |
<div class="info-box">
|
|
|
167 |
<div class="info-box-title">Variable Summary</span></div>
|
|
|
168 |
<div class="nav-bar">
|
|
|
169 |
<a href="#sec-description">Description</a> |
|
|
|
170 |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
|
|
171 |
|
|
|
|
172 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
173 |
|
|
|
174 |
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
|
|
|
175 |
|
|
|
176 |
</div>
|
|
|
177 |
<div class="info-box-body">
|
|
|
178 |
<div class="var-summary">
|
|
|
179 |
<div class="var-title">
|
|
|
180 |
<span class="var-type">array</span>
|
|
|
181 |
<a href="#$parametres" title="details" class="var-name">$parametres</a>
|
|
|
182 |
</div>
|
|
|
183 |
<div class="var-title">
|
|
|
184 |
<span class="var-type">array</span>
|
|
|
185 |
<a href="#$parametres_autorises" title="details" class="var-name">$parametres_autorises</a>
|
|
|
186 |
</div>
|
|
|
187 |
</div>
|
|
|
188 |
</div>
|
|
|
189 |
</div>
|
|
|
190 |
|
|
|
191 |
<a name="sec-method-summary"></a>
|
|
|
192 |
<div class="info-box">
|
|
|
193 |
<div class="info-box-title">Method Summary</span></div>
|
|
|
194 |
<div class="nav-bar">
|
|
|
195 |
<a href="#sec-description">Description</a> |
|
|
|
196 |
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
|
|
|
197 |
|
|
|
198 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
|
|
199 |
|
|
|
200 |
|
|
|
|
201 |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
|
|
202 |
</div>
|
|
|
203 |
<div class="info-box-body">
|
|
|
204 |
<div class="method-summary">
|
|
|
205 |
|
|
|
206 |
<div class="method-definition">
|
|
|
207 |
<span class="method-result">Script</span>
|
|
|
208 |
<a href="#__construct" title="details" class="method-name">__construct</a>
|
|
|
209 |
(<span class="var-type"></span> <span class="var-name">$script_nom</span>, <span class="var-type"></span> <span class="var-name">$parametres_cli</span>)
|
|
|
210 |
</div>
|
|
|
211 |
|
|
|
212 |
<div class="method-definition">
|
|
|
213 |
<span class="method-result">void</span>
|
|
|
214 |
<a href="#afficherAvancement" title="details" class="method-name">afficherAvancement</a>
|
|
|
215 |
(<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>])
|
|
|
216 |
</div>
|
|
|
217 |
|
|
|
218 |
<div class="method-definition">
|
|
|
219 |
<span class="method-result">void</span>
|
|
|
220 |
<a href="#executer" title="details" class="method-name">executer</a>
|
|
|
221 |
()
|
|
|
222 |
</div>
|
|
|
223 |
|
|
|
224 |
<div class="method-definition">
|
|
|
225 |
<span class="method-result">string</span>
|
|
|
226 |
<a href="#formaterMsg" title="details" class="method-name">formaterMsg</a>
|
|
|
227 |
(<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>])
|
|
|
228 |
</div>
|
|
|
229 |
|
|
|
230 |
<div class="method-definition">
|
|
|
231 |
<span class="method-result">void</span>
|
|
|
232 |
<a href="#getParametre" title="details" class="method-name">getParametre</a>
|
|
|
233 |
(<span class="var-type"></span> <span class="var-name">$parametre</span>)
|
|
|
234 |
</div>
|
|
|
235 |
|
|
|
236 |
<div class="method-definition">
|
|
|
237 |
<span class="method-result">void</span>
|
|
|
238 |
<a href="#getScriptChemin" title="details" class="method-name">getScriptChemin</a>
|
|
|
239 |
([<span class="var-type"></span> <span class="var-name">$doit_exister</span> = <span class="var-default">true</span>])
|
|
|
240 |
</div>
|
|
|
241 |
|
|
|
242 |
<div class="method-definition">
|
|
|
243 |
<span class="method-result">void</span>
|
|
|
244 |
<a href="#getScriptNom" title="details" class="method-name">getScriptNom</a>
|
|
|
245 |
()
|
|
|
246 |
</div>
|
|
|
247 |
|
|
|
248 |
<div class="method-definition">
|
|
|
249 |
<span class="method-result">void.</span>
|
|
|
250 |
<a href="#traiterAvertissement" title="details" class="method-name">traiterAvertissement</a>
|
|
|
251 |
(<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>])
|
|
|
252 |
</div>
|
|
|
253 |
|
|
|
254 |
<div class="method-definition">
|
|
|
255 |
<span class="method-result">void.</span>
|
|
|
256 |
<a href="#traiterErreur" title="details" class="method-name">traiterErreur</a>
|
|
|
257 |
(<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>])
|
|
|
258 |
</div>
|
|
|
259 |
|
|
|
260 |
<div class="method-definition">
|
|
|
261 |
<span class="method-result">void.</span>
|
|
|
262 |
<a href="#traiterInfo" title="details" class="method-name">traiterInfo</a>
|
|
|
263 |
(<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>])
|
|
|
264 |
</div>
|
|
|
265 |
</div>
|
|
|
266 |
</div>
|
|
|
267 |
</div>
|
|
|
268 |
|
|
|
269 |
<a name="sec-vars"></a>
|
|
|
270 |
<div class="info-box">
|
|
|
271 |
<div class="info-box-title">Variables</div>
|
|
|
272 |
<div class="nav-bar">
|
|
|
273 |
<a href="#sec-description">Description</a> |
|
|
|
274 |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
|
|
275 |
|
|
|
276 |
|
|
|
277 |
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
|
|
|
278 |
|
|
|
279 |
|
|
|
|
280 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
281 |
|
|
|
282 |
</div>
|
|
|
283 |
<div class="info-box-body">
|
|
|
284 |
|
|
|
285 |
<a name="var$parametres" id="$parametres"><!-- --></A>
|
|
|
286 |
<div class="evenrow">
|
|
|
287 |
|
|
|
288 |
<div class="var-header">
|
|
|
289 |
<span class="var-title">
|
|
|
290 |
<span class="var-type">array</span>
|
|
|
291 |
<span class="var-name">$parametres</span>
|
|
|
292 |
= <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Script.php.html#a85">85</a></span>)
|
|
|
293 |
</span>
|
|
|
294 |
</div>
|
|
|
295 |
|
|
|
296 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
297 |
<p class="short-description">Contient le tableau des paramètres disponible après vérification :</p>
|
|
|
298 |
<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>
|
|
|
299 |
<ul class="tags">
|
|
|
300 |
<li><span class="field">access:</span> protected</li>
|
|
|
301 |
</ul>
|
|
|
302 |
|
|
|
303 |
|
|
|
304 |
|
|
|
305 |
|
|
|
306 |
|
|
|
307 |
</div>
|
|
|
308 |
<a name="var$parametres_autorises" id="$parametres_autorises"><!-- --></A>
|
|
|
309 |
<div class="oddrow">
|
|
|
310 |
|
|
|
311 |
<div class="var-header">
|
|
|
312 |
<span class="var-title">
|
|
|
313 |
<span class="var-type">array</span>
|
|
|
314 |
<span class="var-name">$parametres_autorises</span>
|
|
|
315 |
= <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Script.php.html#a67">67</a></span>)
|
|
|
316 |
</span>
|
|
|
317 |
</div>
|
|
|
318 |
|
|
|
319 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
320 |
<p class="short-description">Paramêtres autorisés par le script.</p>
|
|
|
321 |
<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>
|
|
|
322 |
<ul class="tags">
|
|
|
323 |
<li><span class="field">access:</span> protected</li>
|
|
|
324 |
</ul>
|
|
|
325 |
|
|
|
326 |
|
|
|
327 |
|
|
|
328 |
|
|
|
329 |
|
|
|
330 |
</div>
|
|
|
331 |
|
|
|
332 |
</div>
|
|
|
333 |
</div>
|
|
|
334 |
|
|
|
335 |
<a name="sec-methods"></a>
|
|
|
336 |
<div class="info-box">
|
|
|
337 |
<div class="info-box-title">Methods</div>
|
|
|
338 |
<div class="nav-bar">
|
|
|
339 |
<a href="#sec-description">Description</a> |
|
|
|
340 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
|
|
341 |
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
|
|
|
342 |
|
|
|
343 |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
|
|
344 |
|
|
|
345 |
</div>
|
|
|
346 |
<div class="info-box-body">
|
|
|
347 |
<A NAME='method_detail'></A>
|
|
|
348 |
<a name="method__construct" id="__construct"><!-- --></a>
|
|
|
349 |
<div class="evenrow">
|
|
|
350 |
|
|
|
351 |
<div class="method-header">
|
|
|
352 |
<span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Script.php.html#a96">96</a></span>)
|
|
|
353 |
</div>
|
|
|
354 |
|
|
|
355 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
356 |
<ul class="tags">
|
|
|
357 |
<li><span class="field">access:</span> public</li>
|
|
|
358 |
</ul>
|
|
|
359 |
|
|
|
360 |
<div class="method-signature">
|
|
|
361 |
<span class="method-result">Script</span>
|
|
|
362 |
<span class="method-name">
|
|
|
363 |
__construct
|
|
|
364 |
</span>
|
|
|
365 |
(<span class="var-type"></span> <span class="var-name">$script_nom</span>, <span class="var-type"></span> <span class="var-name">$parametres_cli</span>)
|
|
|
366 |
</div>
|
|
|
367 |
|
|
|
368 |
<ul class="parameters">
|
|
|
369 |
<li>
|
|
|
370 |
<span class="var-type"></span>
|
|
|
371 |
<span class="var-name">$script_nom</span> </li>
|
|
|
372 |
<li>
|
|
|
373 |
<span class="var-type"></span>
|
|
|
374 |
<span class="var-name">$parametres_cli</span> </li>
|
|
|
375 |
</ul>
|
|
|
376 |
|
|
|
377 |
|
|
|
378 |
</div>
|
|
|
379 |
<a name="methodafficherAvancement" id="afficherAvancement"><!-- --></a>
|
|
|
380 |
<div class="oddrow">
|
|
|
381 |
|
|
|
382 |
<div class="method-header">
|
|
|
383 |
<span class="method-title">afficherAvancement</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Script.php.html#a268">268</a></span>)
|
|
|
384 |
</div>
|
|
|
385 |
|
|
|
386 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
387 |
<p class="short-description">Utiliser cette méthode dans une boucle pour afficher un message suivi du nombre de tour de boucle effectué.</p>
|
|
|
388 |
<p class="description"><p>Vous devrez vous même gérer le retour à la ligne à la sortie de la boucle.</p></p>
|
|
|
389 |
<ul class="tags">
|
|
|
390 |
<li><span class="field">return:</span> le message est affiché dans la console.</li>
|
|
|
391 |
<li><span class="field">access:</span> protected</li>
|
|
|
392 |
</ul>
|
|
|
393 |
|
|
|
394 |
<div class="method-signature">
|
|
|
395 |
<span class="method-result">void</span>
|
|
|
396 |
<span class="method-name">
|
|
|
397 |
afficherAvancement
|
|
|
398 |
</span>
|
|
|
399 |
(<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>])
|
|
|
400 |
</div>
|
|
|
401 |
|
|
|
402 |
<ul class="parameters">
|
|
|
403 |
<li>
|
|
|
404 |
<span class="var-type">string</span>
|
|
|
405 |
<span class="var-name">$message</span><span class="var-description">: le message d'information.</span> </li>
|
|
|
406 |
<li>
|
|
|
407 |
<span class="var-type">int</span>
|
|
|
408 |
<span class="var-name">$depart</span><span class="var-description">: le nombre de départ à afficher.</span> </li>
|
|
|
409 |
</ul>
|
|
|
410 |
|
|
|
411 |
|
|
|
412 |
</div>
|
|
|
413 |
<a name="methodexecuter" id="executer"><!-- --></a>
|
|
|
414 |
<div class="evenrow">
|
|
|
415 |
|
|
|
416 |
<div class="method-header">
|
|
|
417 |
<span class="method-title">executer</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Script.php.html#a139">139</a></span>)
|
|
|
418 |
</div>
|
|
|
419 |
|
|
|
420 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
421 |
<ul class="tags">
|
|
|
422 |
<li><span class="field">abstract:</span> </li>
|
|
|
423 |
<li><span class="field">access:</span> public</li>
|
|
|
424 |
</ul>
|
|
|
425 |
|
|
|
426 |
<div class="method-signature">
|
|
|
427 |
<span class="method-result">void</span>
|
|
|
428 |
<span class="method-name">
|
|
|
429 |
executer
|
|
|
430 |
</span>
|
|
|
431 |
()
|
|
|
432 |
</div>
|
|
|
433 |
|
|
|
434 |
|
|
|
435 |
|
|
|
436 |
</div>
|
|
|
437 |
<a name="methodformaterMsg" id="formaterMsg"><!-- --></a>
|
|
|
438 |
<div class="oddrow">
|
|
|
439 |
|
|
|
440 |
<div class="method-header">
|
|
|
441 |
<span class="method-title">formaterMsg</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Script.php.html#a252">252</a></span>)
|
|
|
442 |
</div>
|
|
|
443 |
|
|
|
444 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
445 |
<p class="short-description">Retourne un message d'information formaté.</p>
|
|
|
446 |
<ul class="tags">
|
|
|
447 |
<li><span class="field">return:</span> le message d'erreur formaté.</li>
|
|
|
448 |
<li><span class="field">access:</span> protected</li>
|
|
|
449 |
</ul>
|
|
|
450 |
|
|
|
451 |
<div class="method-signature">
|
|
|
452 |
<span class="method-result">string</span>
|
|
|
453 |
<span class="method-name">
|
|
|
454 |
formaterMsg
|
|
|
455 |
</span>
|
|
|
456 |
(<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>])
|
|
|
457 |
</div>
|
|
|
458 |
|
|
|
459 |
<ul class="parameters">
|
|
|
460 |
<li>
|
|
|
461 |
<span class="var-type">string</span>
|
|
|
462 |
<span class="var-name">$message</span><span class="var-description">: le message d'information avec des %s.</span> </li>
|
|
|
463 |
<li>
|
|
|
464 |
<span class="var-type">array</span>
|
|
|
465 |
<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>
|
|
|
466 |
<li>
|
|
|
467 |
<span class="var-type"></span>
|
|
|
468 |
<span class="var-name">$niveau</span> </li>
|
|
|
469 |
</ul>
|
|
|
470 |
|
|
|
471 |
|
|
|
472 |
</div>
|
|
|
473 |
<a name="methodgetParametre" id="getParametre"><!-- --></a>
|
|
|
474 |
<div class="evenrow">
|
|
|
475 |
|
|
|
476 |
<div class="method-header">
|
|
|
477 |
<span class="method-title">getParametre</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Script.php.html#a125">125</a></span>)
|
|
|
478 |
</div>
|
|
|
479 |
|
|
|
480 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
481 |
<ul class="tags">
|
|
|
482 |
<li><span class="field">access:</span> protected</li>
|
|
|
483 |
</ul>
|
|
|
484 |
|
|
|
485 |
<div class="method-signature">
|
|
|
486 |
<span class="method-result">void</span>
|
|
|
487 |
<span class="method-name">
|
|
|
488 |
getParametre
|
|
|
489 |
</span>
|
|
|
490 |
(<span class="var-type"></span> <span class="var-name">$parametre</span>)
|
|
|
491 |
</div>
|
|
|
492 |
|
|
|
493 |
<ul class="parameters">
|
|
|
494 |
<li>
|
|
|
495 |
<span class="var-type"></span>
|
|
|
496 |
<span class="var-name">$parametre</span> </li>
|
|
|
497 |
</ul>
|
|
|
498 |
|
|
|
499 |
|
|
|
500 |
</div>
|
|
|
501 |
<a name="methodgetScriptChemin" id="getScriptChemin"><!-- --></a>
|
|
|
502 |
<div class="oddrow">
|
|
|
503 |
|
|
|
504 |
<div class="method-header">
|
|
|
505 |
<span class="method-title">getScriptChemin</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Script.php.html#a117">117</a></span>)
|
|
|
506 |
</div>
|
|
|
507 |
|
|
|
508 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
509 |
<ul class="tags">
|
|
|
510 |
<li><span class="field">access:</span> protected</li>
|
|
|
511 |
</ul>
|
|
|
512 |
|
|
|
513 |
<div class="method-signature">
|
|
|
514 |
<span class="method-result">void</span>
|
|
|
515 |
<span class="method-name">
|
|
|
516 |
getScriptChemin
|
|
|
517 |
</span>
|
|
|
518 |
([<span class="var-type"></span> <span class="var-name">$doit_exister</span> = <span class="var-default">true</span>])
|
|
|
519 |
</div>
|
|
|
520 |
|
|
|
521 |
<ul class="parameters">
|
|
|
522 |
<li>
|
|
|
523 |
<span class="var-type"></span>
|
|
|
524 |
<span class="var-name">$doit_exister</span> </li>
|
|
|
525 |
</ul>
|
|
|
526 |
|
|
|
527 |
|
|
|
528 |
</div>
|
|
|
529 |
<a name="methodgetScriptNom" id="getScriptNom"><!-- --></a>
|
|
|
530 |
<div class="evenrow">
|
|
|
531 |
|
|
|
532 |
<div class="method-header">
|
|
|
533 |
<span class="method-title">getScriptNom</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Script.php.html#a113">113</a></span>)
|
|
|
534 |
</div>
|
|
|
535 |
|
|
|
536 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
537 |
<ul class="tags">
|
|
|
538 |
<li><span class="field">access:</span> protected</li>
|
|
|
539 |
</ul>
|
|
|
540 |
|
|
|
541 |
<div class="method-signature">
|
|
|
542 |
<span class="method-result">void</span>
|
|
|
543 |
<span class="method-name">
|
|
|
544 |
getScriptNom
|
|
|
545 |
</span>
|
|
|
546 |
()
|
|
|
547 |
</div>
|
|
|
548 |
|
|
|
549 |
|
|
|
550 |
|
|
|
551 |
</div>
|
|
|
552 |
<a name="methodtraiterAvertissement" id="traiterAvertissement"><!-- --></a>
|
|
|
553 |
<div class="oddrow">
|
|
|
554 |
|
|
|
555 |
<div class="method-header">
|
|
|
556 |
<span class="method-title">traiterAvertissement</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Script.php.html#a210">210</a></span>)
|
|
|
557 |
</div>
|
|
|
558 |
|
|
|
559 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
560 |
<p class="short-description">Affiche un message d'avertissement formaté.</p>
|
|
|
561 |
<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>
|
|
|
562 |
<ul class="tags">
|
|
|
563 |
<li><span class="field">access:</span> protected</li>
|
|
|
564 |
</ul>
|
|
|
565 |
|
|
|
566 |
<div class="method-signature">
|
|
|
567 |
<span class="method-result">void.</span>
|
|
|
568 |
<span class="method-name">
|
|
|
569 |
traiterAvertissement
|
|
|
570 |
</span>
|
|
|
571 |
(<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>])
|
|
|
572 |
</div>
|
|
|
573 |
|
|
|
574 |
<ul class="parameters">
|
|
|
575 |
<li>
|
|
|
576 |
<span class="var-type">string</span>
|
|
|
577 |
<span class="var-name">$message</span><span class="var-description">: le message d'erreur avec des %s.</span> </li>
|
|
|
578 |
<li>
|
|
|
579 |
<span class="var-type">array</span>
|
|
|
580 |
<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>
|
|
|
581 |
</ul>
|
|
|
582 |
|
|
|
583 |
|
|
|
584 |
</div>
|
|
|
585 |
<a name="methodtraiterErreur" id="traiterErreur"><!-- --></a>
|
|
|
586 |
<div class="evenrow">
|
|
|
587 |
|
|
|
588 |
<div class="method-header">
|
|
|
589 |
<span class="method-title">traiterErreur</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Script.php.html#a197">197</a></span>)
|
|
|
590 |
</div>
|
|
|
591 |
|
|
|
592 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
593 |
<p class="short-description">Affiche un message d'erreur formaté.</p>
|
|
|
594 |
<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>
|
|
|
595 |
<ul class="tags">
|
|
|
596 |
<li><span class="field">access:</span> protected</li>
|
|
|
597 |
</ul>
|
|
|
598 |
|
|
|
599 |
<div class="method-signature">
|
|
|
600 |
<span class="method-result">void.</span>
|
|
|
601 |
<span class="method-name">
|
|
|
602 |
traiterErreur
|
|
|
603 |
</span>
|
|
|
604 |
(<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>])
|
|
|
605 |
</div>
|
|
|
606 |
|
|
|
607 |
<ul class="parameters">
|
|
|
608 |
<li>
|
|
|
609 |
<span class="var-type">string</span>
|
|
|
610 |
<span class="var-name">$message</span><span class="var-description">: le message d'erreur avec des %s.</span> </li>
|
|
|
611 |
<li>
|
|
|
612 |
<span class="var-type">array</span>
|
|
|
613 |
<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>
|
|
|
614 |
</ul>
|
|
|
615 |
|
|
|
616 |
|
|
|
617 |
</div>
|
|
|
618 |
<a name="methodtraiterInfo" id="traiterInfo"><!-- --></a>
|
|
|
619 |
<div class="oddrow">
|
|
|
620 |
|
|
|
621 |
<div class="method-header">
|
|
|
622 |
<span class="method-title">traiterInfo</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Script.php.html#a223">223</a></span>)
|
|
|
623 |
</div>
|
|
|
624 |
|
|
|
625 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
626 |
<p class="short-description">Retourne un message d'information formaté.</p>
|
|
|
627 |
<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>
|
|
|
628 |
<ul class="tags">
|
|
|
629 |
<li><span class="field">access:</span> protected</li>
|
|
|
630 |
</ul>
|
|
|
631 |
|
|
|
632 |
<div class="method-signature">
|
|
|
633 |
<span class="method-result">void.</span>
|
|
|
634 |
<span class="method-name">
|
|
|
635 |
traiterInfo
|
|
|
636 |
</span>
|
|
|
637 |
(<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>])
|
|
|
638 |
</div>
|
|
|
639 |
|
|
|
640 |
<ul class="parameters">
|
|
|
641 |
<li>
|
|
|
642 |
<span class="var-type">string</span>
|
|
|
643 |
<span class="var-name">$message</span><span class="var-description">: le message d'information avec des %s.</span> </li>
|
|
|
644 |
<li>
|
|
|
645 |
<span class="var-type">array</span>
|
|
|
646 |
<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>
|
|
|
647 |
</ul>
|
|
|
648 |
|
|
|
649 |
|
|
|
650 |
</div>
|
|
|
651 |
|
|
|
652 |
</div>
|
|
|
653 |
</div>
|
|
|
654 |
|
|
|
655 |
<a name="sec-consts"></a>
|
|
|
656 |
<div class="info-box">
|
|
|
657 |
<div class="info-box-title">Class Constants</div>
|
|
|
658 |
<div class="nav-bar">
|
|
|
659 |
<a href="#sec-description">Description</a> |
|
|
|
660 |
<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
|
|
|
661 |
|
|
|
662 |
|
|
|
663 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
|
|
664 |
|
|
|
|
665 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
666 |
|
|
|
667 |
</div>
|
|
|
668 |
<div class="info-box-body">
|
|
|
669 |
<a name="constMSG_AVERTISSEMENT" id="MSG_AVERTISSEMENT"><!-- --></A>
|
|
|
670 |
<div class="evenrow">
|
|
|
671 |
|
|
|
672 |
<div class="const-header">
|
|
|
673 |
<img src="../media/images/Variable.png" />
|
|
|
674 |
<span class="const-title">
|
|
|
675 |
<span class="const-name">MSG_AVERTISSEMENT</span>
|
|
|
676 |
= <span class="const-default"> 2</span>
|
|
|
677 |
(line <span class="line-number"><a href="../__filesource/fsource_Framework__Script.php.html#a24">24</a></span>)
|
|
|
678 |
</span>
|
|
|
679 |
</div>
|
|
|
680 |
|
|
|
681 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
682 |
<p class="short-description">Niveau de message de type AVERTISSEMENT</p>
|
|
|
683 |
|
|
|
684 |
|
|
|
685 |
</div>
|
|
|
686 |
<a name="constMSG_ERREUR" id="MSG_ERREUR"><!-- --></A>
|
|
|
687 |
<div class="oddrow">
|
|
|
688 |
|
|
|
689 |
<div class="const-header">
|
|
|
690 |
<img src="../media/images/Variable.png" />
|
|
|
691 |
<span class="const-title">
|
|
|
692 |
<span class="const-name">MSG_ERREUR</span>
|
|
|
693 |
= <span class="const-default"> 1</span>
|
|
|
694 |
(line <span class="line-number"><a href="../__filesource/fsource_Framework__Script.php.html#a22">22</a></span>)
|
|
|
695 |
</span>
|
|
|
696 |
</div>
|
|
|
697 |
|
|
|
698 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
699 |
<p class="short-description">Niveau de message de type ERREUR</p>
|
|
|
700 |
|
|
|
701 |
|
|
|
702 |
</div>
|
|
|
703 |
<a name="constMSG_INFO" id="MSG_INFO"><!-- --></A>
|
|
|
704 |
<div class="evenrow">
|
|
|
705 |
|
|
|
706 |
<div class="const-header">
|
|
|
707 |
<img src="../media/images/Variable.png" />
|
|
|
708 |
<span class="const-title">
|
|
|
709 |
<span class="const-name">MSG_INFO</span>
|
|
|
710 |
= <span class="const-default"> 3</span>
|
|
|
711 |
(line <span class="line-number"><a href="../__filesource/fsource_Framework__Script.php.html#a26">26</a></span>)
|
|
|
712 |
</span>
|
|
|
713 |
</div>
|
|
|
714 |
|
|
|
715 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
716 |
<p class="short-description">Niveau de message de type INFORMATION</p>
|
|
|
717 |
|
|
|
718 |
|
|
|
719 |
</div>
|
|
|
720 |
<a name="constMSG_LOG" id="MSG_LOG"><!-- --></A>
|
|
|
721 |
<div class="oddrow">
|
|
|
722 |
|
|
|
723 |
<div class="const-header">
|
|
|
724 |
<img src="../media/images/Variable.png" />
|
|
|
725 |
<span class="const-title">
|
|
|
726 |
<span class="const-name">MSG_LOG</span>
|
|
|
727 |
= <span class="const-default"> 0</span>
|
|
|
728 |
(line <span class="line-number"><a href="../__filesource/fsource_Framework__Script.php.html#a20">20</a></span>)
|
|
|
729 |
</span>
|
|
|
730 |
</div>
|
|
|
731 |
|
|
|
732 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
733 |
<p class="short-description">Niveau de message de type LOG</p>
|
|
|
734 |
|
|
|
735 |
|
|
|
736 |
</div>
|
|
|
737 |
|
|
|
738 |
</div>
|
|
|
739 |
</div>
|
|
|
740 |
|
|
|
741 |
<p class="notes" id="credit">
|
| 302 |
jpm |
742 |
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>
|
| 297 |
jpm |
743 |
</p>
|
|
|
744 |
</div></body>
|
|
|
745 |
</html>
|