Subversion Repositories Applications.framework

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
464 jpm 1
<!DOCTYPE html>
2
<html lang="en">
3
<head>
4
    <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
5
    <meta charset="utf-8"/>
6
    <title>TBFramework - v0.4</title>
7
    <meta name="author" content=""/>
8
    <meta name="description" content=""/>
9
 
10
    <link href="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/css/bootstrap-combined.no-icons.min.css" rel="stylesheet">
11
    <link href="https://netdna.bootstrapcdn.com/font-awesome/3.2.1/css/font-awesome.min.css" rel="stylesheet">
12
    <link href="../css/prism.css" rel="stylesheet" media="all"/>
13
    <link href="../css/template.css" rel="stylesheet" media="all"/>
14
 
15
    <!--[if lt IE 9]>
16
    <script src="https://html5shim.googlecode.com/svn/trunk/html5.js" type="text/javascript"></script>
17
    <![endif]-->
18
    <script src="https://code.jquery.com/jquery-1.10.2.min.js" type="text/javascript"></script>
19
    <script src="https://code.jquery.com/ui/1.10.3/jquery-ui.min.js" type="text/javascript"></script>
20
    <script src="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/js/bootstrap.min.js"></script>
21
    <script src="../js/jquery.smooth-scroll.js"></script>
22
    <script src="../js/prism.min.js"></script>
23
    <!-- TODO: Add http://jscrollpane.kelvinluck.com/ to style the scrollbars for browsers not using webkit-->
24
    <script type="text/javascript">
25
    function loadExternalCodeSnippets() {
26
        Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach(function (pre) {
27
            var src = pre.getAttribute('data-src');
28
            var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
29
            var language = 'php';
30
 
31
            var code = document.createElement('code');
32
            code.className = 'language-' + language;
33
 
34
            pre.textContent = '';
35
 
36
            code.textContent = 'Loading…';
37
 
38
            pre.appendChild(code);
39
 
40
            var xhr = new XMLHttpRequest();
41
 
42
            xhr.open('GET', src, true);
43
 
44
            xhr.onreadystatechange = function () {
45
                if (xhr.readyState == 4) {
46
 
47
                    if (xhr.status < 400 && xhr.responseText) {
48
                        code.textContent = xhr.responseText;
49
 
50
                        Prism.highlightElement(code);
51
                    }
52
                    else if (xhr.status >= 400) {
53
                        code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
54
                    }
55
                    else {
56
                        code.textContent = '✖ Error: File does not exist or is empty';
57
                    }
58
                }
59
            };
60
 
61
            xhr.send(null);
62
        });
63
    }
64
 
65
    $(document).ready(function(){
66
        loadExternalCodeSnippets();
67
    });
68
    $('#source-view').on('shown', function () {
69
        loadExternalCodeSnippets();
70
    })
71
</script>
72
 
73
    <link rel="shortcut icon" href="../images/favicon.ico"/>
74
    <link rel="apple-touch-icon" href="../images/apple-touch-icon.png"/>
75
    <link rel="apple-touch-icon" sizes="72x72" href="../images/apple-touch-icon-72x72.png"/>
76
    <link rel="apple-touch-icon" sizes="114x114" href="../images/apple-touch-icon-114x114.png"/>
77
</head>
78
<body>
79
 
80
<div class="navbar navbar-fixed-top">
81
    <div class="navbar-inner">
82
        <div class="container">
83
            <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
84
                <i class="icon-ellipsis-vertical"></i>
85
            </a>
86
            <a class="brand" href="../index.html">TBFramework - v0.4</a>
87
 
88
            <div class="nav-collapse">
89
                <ul class="nav pull-right">
90
                    <li class="dropdown">
91
                        <a href="../index.html" class="dropdown-toggle" data-toggle="dropdown">
92
                            API Documentation <b class="caret"></b>
93
                        </a>
94
                        <ul class="dropdown-menu">
95
                                                    </ul>
96
                    </li>
97
                    <li class="dropdown" id="charts-menu">
98
                        <a href="#" class="dropdown-toggle" data-toggle="dropdown">
99
                            Charts <b class="caret"></b>
100
                        </a>
101
                        <ul class="dropdown-menu">
102
                            <li>
103
                                <a href="../graphs/class.html">
104
                                    <i class="icon-list-alt"></i>&#160;Class hierarchy diagram
105
                                </a>
106
                            </li>
107
                        </ul>
108
                    </li>
109
                    <li class="dropdown" id="reports-menu">
110
                        <a href="#" class="dropdown-toggle" data-toggle="dropdown">
111
                            Reports <b class="caret"></b>
112
                        </a>
113
                        <ul class="dropdown-menu">
114
                            <li>
115
                                <a href="../reports/errors.html">
116
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    <i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">281</span>
117
                                </a>
118
                            </li>
119
                            <li>
120
                                <a href="../reports/markers.html">
121
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    <i class="icon-list-alt"></i>&#160;Markers <span class="label label-info pull-right">12</span>
122
                                </a>
123
                            </li>
124
                        </ul>
125
                    </li>
126
                </ul>
127
            </div>
128
        </div>
129
    </div>
130
    <!--<div class="go_to_top">-->
131
    <!--<a href="#___" style="color: inherit">Back to top&#160;&#160;<i class="icon-upload icon-white"></i></a>-->
132
    <!--</div>-->
133
</div>
134
 
135
<div id="___" class="container-fluid">
136
        <section class="row-fluid">
137
        <div class="span2 sidebar">
138
                                <div class="accordion" style="margin-bottom: 0">
139
        <div class="accordion-group">
140
            <div class="accordion-heading">
141
                                    <a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1147235730"></a>
142
                                <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
143
            </div>
144
            <div id="namespace-1147235730" class="accordion-body collapse in">
145
                <div class="accordion-inner">
146
 
147
 
148
                    <ul>
149
                                                                                                    <li class="class"><a href="../classes/Url.html">Url</a></li>
150
                                                    <li class="class"><a href="../classes/Debug.html">Debug</a></li>
151
                                                    <li class="class"><a href="../classes/Chronometre.html">Chronometre</a></li>
152
                                                    <li class="class"><a href="../classes/RestServeur.html">RestServeur</a></li>
153
                                                    <li class="class"><a href="../classes/SquelettePhp.html">SquelettePhp</a></li>
154
                                                    <li class="class"><a href="../classes/Controleur.html">Controleur</a></li>
155
                                                    <li class="class"><a href="../classes/Cache.html">Cache</a></li>
156
                                                    <li class="class"><a href="../classes/RestClient.html">RestClient</a></li>
157
                                                    <li class="class"><a href="../classes/GestionnaireException.html">GestionnaireException</a></li>
158
                                                    <li class="class"><a href="../classes/Script.html">Script</a></li>
159
                                                    <li class="class"><a href="../classes/Registre.html">Registre</a></li>
160
                                                    <li class="class"><a href="../classes/RestService.html">RestService</a></li>
161
                                                    <li class="class"><a href="../classes/Cli.html">Cli</a></li>
162
                                                    <li class="class"><a href="../classes/Encodage.html">Encodage</a></li>
163
                                                    <li class="class"><a href="../classes/Tableau.html">Tableau</a></li>
164
                                                    <li class="class"><a href="../classes/Pattern.html">Pattern</a></li>
165
                                                    <li class="class"><a href="../classes/Chaine.html">Chaine</a></li>
166
                                                    <li class="class"><a href="../classes/Fichier.html">Fichier</a></li>
167
                                                    <li class="class"><a href="../classes/I18n.html">I18n</a></li>
168
                                                    <li class="class"><a href="../classes/Config.html">Config</a></li>
169
                                                    <li class="class"><a href="../classes/CacheSqlite.html">CacheSqlite</a></li>
170
                                                    <li class="class"><a href="../classes/Bdd.html">Bdd</a></li>
171
                                                    <li class="class"><a href="../classes/Log.html">Log</a></li>
172
                                                    <li class="class"><a href="../classes/CacheFichier.html">CacheFichier</a></li>
173
                                                    <li class="class"><a href="../classes/Framework.html">Framework</a></li>
174
                                                    <li class="class"><a href="../classes/CacheSimple.html">CacheSimple</a></li>
175
                                            </ul>
176
                </div>
177
            </div>
178
        </div>
179
    </div>
180
 
181
        </div>
182
    </section>
183
    <section class="row-fluid">
184
        <div class="span10 offset2">
185
            <div class="row-fluid">
186
                <div class="span8 content class">
187
                    <nav>
188
                                                <a href="../namespaces/default.html">\</a> <i class="icon-level-up"></i>
189
                                            </nav>
190
                    <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a>
191
 
192
                    <h1><small>\</small>Cli</h1>
193
                    <p><em>CLI permet de récupérer les paramètres passés en ligne de commande pour instancier une classe héritant de la classe abstraite
194
Script.</em></p>
195
                    <p>Elle va déclencher l'éxecution du script via l'appel de la méthode executer().
196
C'est une Singleton.</p>
197
 
198
                    <section id="summary">
199
                        <h2>Summary</h2>
200
                        <section class="row-fluid heading">
201
                            <section class="span4">
202
                                <a href="#methods">Methods</a>
203
                            </section>
204
                            <section class="span4">
205
                                <a href="#properties">Properties</a>
206
                            </section>
207
                            <section class="span4">
208
                                <a href="#constants">Constants</a>
209
                            </section>
210
                        </section>
211
                        <section class="row-fluid public">
212
                            <section class="span4">
213
                                                                    <a href="../classes/Cli.html#method_executer" class="">executer()</a><br />
214
                                                            </section>
215
                            <section class="span4">
216
                                                                    <em>No public properties found</em>
217
                                                            </section>
218
                            <section class="span4">
219
                                                                    <em>No constants found</em>
220
                                                            </section>
221
                        </section>
222
                        <section class="row-fluid protected">
223
                            <section class="span4">
224
                                                                    <em>No protected methods found</em>
225
                                                            </section>
226
                            <section class="span4">
227
                                                                    <em>No protected properties found</em>
228
                                                            </section>
229
                            <section class="span4">
230
                                <em>N/A</em>
231
                            </section>
232
                        </section>
233
                        <section class="row-fluid private">
234
                            <section class="span4">
235
                                                                    <a href="../classes/Cli.html#method_charger" class="">charger()</a><br />
236
                                                                    <a href="../classes/Cli.html#method_obtenirNomClasse" class="">obtenirNomClasse()</a><br />
237
                                                                    <a href="../classes/Cli.html#method_getParametres" class="">getParametres()</a><br />
238
                                                            </section>
239
                            <section class="span4">
240
                                                                    <a href="../classes/Cli.html#property_parametres_obligatoires" class="">$parametres_obligatoires</a><br />
241
                                                            </section>
242
                            <section class="span4">
243
                                <em>N/A</em>
244
                            </section>
245
                        </section>
246
                    </section>
247
                </div>
248
                <aside class="span4 detailsbar">
249
 
250
 
251
                    <dl>
252
                        <dt>File</dt>
253
                            <dd><a href="../files/Cli.php.html"><div class="path-wrapper">Cli.php</div></a></dd>
254
                                                <dt>Package</dt>
255
                            <dd><div class="namespace-wrapper">\Framework</div></dd>
256
                                                <dt>Class hierarchy</dt>
257
                            <dd class="hierarchy">
258
                                                                                                                                                                    <div class="namespace-wrapper">\Cli</div>
259
                            </dd>
260
 
261
 
262
 
263
 
264
                                                                            <dt>See also</dt>
265
                                                                                    <dd><a href="/doc/framework/"><div class="namespace-wrapper">/doc/framework/</div></a></dd>
266
 
267
                                                                        </dl>
268
                    <h2>Tags</h2>
269
                    <table class="table table-condensed">
270
                                            <tr>
271
                            <th>
272
                                category
273
                            </th>
274
                            <td>
275
                                                                    <p>PHP 5.2</p>
276
                                                            </td>
277
                        </tr>
278
                                            <tr>
279
                            <th>
280
                                author
281
                            </th>
282
                            <td>
283
                                                                    <p>Jean-Pascal MILCENT <a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a></p>
284
                                                                    <p>Delphine CAUQUIL <a href="mailto:delphine@tela-botanica.org">delphine@tela-botanica.org</a></p>
285
                                                            </td>
286
                        </tr>
287
                                            <tr>
288
                            <th>
289
                                copyright
290
                            </th>
291
                            <td>
292
                                                                    <p>Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</p>
293
                                                            </td>
294
                        </tr>
295
                                            <tr>
296
                            <th>
297
                                license
298
                            </th>
299
                            <td>
300
                                                                    <p><a href="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</a> Licence GNU-GPL-v3</p>
301
                                                                    <p><a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt</a> Licence CECILL-v2</p>
302
                                                            </td>
303
                        </tr>
304
                                            <tr>
305
                            <th>
306
                                since
307
                            </th>
308
                            <td>
309
 
310
                                                            </td>
311
                        </tr>
312
                                            <tr>
313
                            <th>
314
                                version
315
                            </th>
316
                            <td>
317
                                                                    <p>$Id: Cli.php 387 2011-10-28 15:57:40Z jpm $</p>
318
                                                            </td>
319
                        </tr>
320
                                            <tr>
321
                            <th>
322
                                todo
323
                            </th>
324
                            <td>
325
                                                            </td>
326
                        </tr>
327
                                        </table>
328
                </aside>
329
            </div>
330
 
331
 
332
                                    <a id="properties" name="properties"></a>
333
            <div class="row-fluid">
334
                <div class="span8 content class">
335
                    <h2>Properties</h2>
336
                </div>
337
                <aside class="span4 detailsbar"></aside>
338
            </div>
339
 
340
                                                                    <div class="row-fluid">
341
        <div class="span8 content class">
342
            <a id="property_parametres_obligatoires" name="property_parametres_obligatoires" class="anchor"></a>
343
            <article class="property">
344
                <h3 class="private ">$parametres_obligatoires</h3>
345
                <pre class="signature">$parametres_obligatoires</pre>
346
                <p><em>Tableau des noms des paramètres à définir dans le fichier de config car obligatoirement nécessaire à cette classe.</em></p>
347
 
348
 
349
                            </article>
350
        </div>
351
        <aside class="span4 detailsbar">
352
            <h1><i class="icon-arrow-down"></i></h1>
353
                        <dl>
354
                                                            </dl>
355
            <h2>Tags</h2>
356
            <table class="table table-condensed">
357
                                    <tr>
358
                        <th>
359
                            todo
360
                        </th>
361
                        <td>
362
                                                    </td>
363
                    </tr>
364
                            </table>
365
        </aside>
366
    </div>
367
 
368
 
369
                                    <a id="methods" name="methods"></a>
370
            <div class="row-fluid">
371
                <div class="span8 content class"><h2>Methods</h2></div>
372
                <aside class="span4 detailsbar"></aside>
373
            </div>
374
 
375
                                    <div class="row-fluid">
376
        <div class="span8 content class">
377
            <a id="method_executer" name="method_executer" class="anchor"></a>
378
            <article class="method">
379
                <h3 class="public ">executer()</h3>
380
                <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
381
                <pre class="signature" style="margin-right: 54px;">executer() : void</pre>
382
                <p><em>Execute la ligne de commande en récupérant le nom du script à lancer et ses paramètres.</em></p>
383
                <p>Instancie la classe du script à lancer et appelle la méthode executer().</p>
384
 
385
 
386
 
387
                            </article>
388
        </div>
389
        <aside class="span4 detailsbar">
390
            <h1><i class="icon-arrow-down"></i></h1>
391
                            <span class="label label-info">static</span>
392
                                                            <dl>
393
                                                                            </dl>
394
            <h2>Tags</h2>
395
            <table class="table table-condensed">
396
                                    <tr>
397
                        <th>
398
                            todo
399
                        </th>
400
                        <td>
401
                                                    </td>
402
                    </tr>
403
                            </table>
404
        </aside>
405
    </div>
406
 
407
                                                                    <div class="row-fluid">
408
        <div class="span8 content class">
409
            <a id="method_charger" name="method_charger" class="anchor"></a>
410
            <article class="method">
411
                <h3 class="private ">charger()</h3>
412
                <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
413
                <pre class="signature" style="margin-right: 54px;">charger( <span class="argument">$script_nom</span>,  <span class="argument">$parametres</span>)</pre>
414
                <p><em></em></p>
415
 
416
 
417
                                    <h4>Parameters</h4>
418
                    <table class="table table-condensed table-hover">
419
                                                    <tr>
420
                                <td></td>
421
                                <td>$script_nom</td>
422
                                <td></td>
423
                            </tr>
424
                                                    <tr>
425
                                <td></td>
426
                                <td>$parametres</td>
427
                                <td></td>
428
                            </tr>
429
                                            </table>
430
 
431
 
432
                            </article>
433
        </div>
434
        <aside class="span4 detailsbar">
435
            <h1><i class="icon-arrow-down"></i></h1>
436
                            <span class="label label-info">static</span>
437
                                                            <dl>
438
                                                                            </dl>
439
            <h2>Tags</h2>
440
            <table class="table table-condensed">
441
                                    <tr>
442
                        <th>
443
                            todo
444
                        </th>
445
                        <td>
446
                                                    </td>
447
                    </tr>
448
                            </table>
449
        </aside>
450
    </div>
451
 
452
                                    <div class="row-fluid">
453
        <div class="span8 content class">
454
            <a id="method_obtenirNomClasse" name="method_obtenirNomClasse" class="anchor"></a>
455
            <article class="method">
456
                <h3 class="private ">obtenirNomClasse()</h3>
457
                <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
458
                <pre class="signature" style="margin-right: 54px;">obtenirNomClasse( <span class="argument">$script_nom</span>)</pre>
459
                <p><em></em></p>
460
 
461
 
462
                                    <h4>Parameters</h4>
463
                    <table class="table table-condensed table-hover">
464
                                                    <tr>
465
                                <td></td>
466
                                <td>$script_nom</td>
467
                                <td></td>
468
                            </tr>
469
                                            </table>
470
 
471
 
472
                            </article>
473
        </div>
474
        <aside class="span4 detailsbar">
475
            <h1><i class="icon-arrow-down"></i></h1>
476
                            <span class="label label-info">static</span>
477
                                                            <dl>
478
                                                                            </dl>
479
            <h2>Tags</h2>
480
            <table class="table table-condensed">
481
                                    <tr>
482
                        <th>
483
                            todo
484
                        </th>
485
                        <td>
486
                                                    </td>
487
                    </tr>
488
                            </table>
489
        </aside>
490
    </div>
491
 
492
                                    <div class="row-fluid">
493
        <div class="span8 content class">
494
            <a id="method_getParametres" name="method_getParametres" class="anchor"></a>
495
            <article class="method">
496
                <h3 class="private ">getParametres()</h3>
497
                <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
498
                <pre class="signature" style="margin-right: 54px;">getParametres( <span class="argument">$argv</span>)</pre>
499
                <p><em></em></p>
500
 
501
 
502
                                    <h4>Parameters</h4>
503
                    <table class="table table-condensed table-hover">
504
                                                    <tr>
505
                                <td></td>
506
                                <td>$argv</td>
507
                                <td></td>
508
                            </tr>
509
                                            </table>
510
 
511
 
512
                            </article>
513
        </div>
514
        <aside class="span4 detailsbar">
515
            <h1><i class="icon-arrow-down"></i></h1>
516
                            <span class="label label-info">static</span>
517
                                                            <dl>
518
                                                                            </dl>
519
            <h2>Tags</h2>
520
            <table class="table table-condensed">
521
                                    <tr>
522
                        <th>
523
                            todo
524
                        </th>
525
                        <td>
526
                                                    </td>
527
                    </tr>
528
                            </table>
529
        </aside>
530
    </div>
531
 
532
                                    </div>
533
    </section>
534
 
535
    <div id="source-view" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="source-view-label" aria-hidden="true">
536
        <div class="modal-header">
537
            <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
538
            <h3 id="source-view-label">Cli.php</h3>
539
        </div>
540
        <div class="modal-body">
541
            <pre data-src="../files/Cli.php.txt" class="language-php line-numbers"></pre>
542
        </div>
543
    </div>
544
 
545
    <footer class="row-fluid">
546
        <section class="span10 offset2">
547
            <section class="row-fluid">
548
                <section class="span10 offset1">
549
                    <section class="row-fluid footer-sections">
550
                        <section class="span4">
551
                                                        <h1><i class="icon-code"></i></h1>
552
                            <div>
553
                                <ul>
554
                                                                    </ul>
555
                            </div>
556
                        </section>
557
                        <section class="span4">
558
                                                        <h1><i class="icon-bar-chart"></i></h1>
559
                            <div>
560
                                <ul>
561
                                    <li><a href="../graphs/class.html">Class Hierarchy Diagram</a></li>
562
                                </ul>
563
                            </div>
564
                        </section>
565
                        <section class="span4">
566
                                                        <h1><i class="icon-pushpin"></i></h1>
567
                            <div>
568
                                <ul>
569
                                    <li><a href="../reports/errors.html">Errors</a></li>
570
                                    <li><a href="../reports/markers.html">Markers</a></li>
571
                                </ul>
572
                            </div>
573
                        </section>
574
                    </section>
575
                </section>
576
            </section>
577
            <section class="row-fluid">
578
                <section class="span10 offset1">
579
                    <hr />
580
                    Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
581
                    on March 12th, 2014 at 15:57.
582
                </section>
583
            </section>
584
        </section>
585
    </footer>
586
</div>
587
 
588
</body>
589
</html>