Subversion Repositories Applications.framework

Rev

Rev 467 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
467 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.2</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.2</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">
476 jpm 116
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        <i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">70</span>
467 jpm 117
                                </a>
118
                            </li>
119
                            <li>
120
                                <a href="../reports/markers.html">
476 jpm 121
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        <i class="icon-list-alt"></i>&#160;Markers <span class="label label-info pull-right">0</span>
467 jpm 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">
476 jpm 141
                                    <a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-211149678"></a>
467 jpm 142
                                <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
143
            </div>
476 jpm 144
            <div id="namespace-211149678" class="accordion-body collapse in">
467 jpm 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/SquelettePhp.html">SquelettePhp</a></li>
153
                                                    <li class="class"><a href="../classes/Controleur.html">Controleur</a></li>
154
                                                    <li class="class"><a href="../classes/GestionnaireException.html">GestionnaireException</a></li>
155
                                                    <li class="class"><a href="../classes/Modele.html">Modele</a></li>
156
                                                    <li class="class"><a href="../classes/Registre.html">Registre</a></li>
476 jpm 157
                                                    <li class="class"><a href="../classes/I18n.html">I18n</a></li>
467 jpm 158
                                                    <li class="class"><a href="../classes/Config.html">Config</a></li>
159
                                                    <li class="class"><a href="../classes/Application.html">Application</a></li>
160
                                                    <li class="class"><a href="../classes/Log.html">Log</a></li>
161
                                            </ul>
162
                </div>
163
            </div>
164
        </div>
165
    </div>
166
 
167
        </div>
168
    </section>
169
    <section class="row-fluid">
170
        <div class="span10 offset2">
171
            <div class="row-fluid">
172
                <div class="span8 content class">
173
                    <nav>
174
                                                <a href="../namespaces/default.html">\</a> <i class="icon-level-up"></i>
175
                                            </nav>
176
                    <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a>
177
 
178
                    <h1><small>\</small>Application</h1>
179
                    <p><em>Classe fournissant des informations au Framework sur l&#039;application.</em></p>
476 jpm 180
 
467 jpm 181
 
182
                    <section id="summary">
183
                        <h2>Summary</h2>
184
                        <section class="row-fluid heading">
185
                            <section class="span4">
186
                                <a href="#methods">Methods</a>
187
                            </section>
188
                            <section class="span4">
189
                                <a href="#properties">Properties</a>
190
                            </section>
191
                            <section class="span4">
192
                                <a href="#constants">Constants</a>
193
                            </section>
194
                        </section>
195
                        <section class="row-fluid public">
196
                            <section class="span4">
197
                                                                    <a href="../classes/Application.html#method_setChemin" class="">setChemin()</a><br />
198
                                                                    <a href="../classes/Application.html#method_getChemin" class="">getChemin()</a><br />
199
                                                                    <a href="../classes/Application.html#method_setInfo" class="">setInfo()</a><br />
200
                                                                    <a href="../classes/Application.html#method_getInfo" class="">getInfo()</a><br />
201
                                                            </section>
202
                            <section class="span4">
203
                                                                    <em>No public properties found</em>
204
                                                            </section>
205
                            <section class="span4">
206
                                                                    <em>No constants found</em>
207
                                                            </section>
208
                        </section>
209
                        <section class="row-fluid protected">
210
                            <section class="span4">
211
                                                                    <em>No protected methods found</em>
212
                                                            </section>
213
                            <section class="span4">
214
                                                                    <em>No protected properties found</em>
215
                                                            </section>
216
                            <section class="span4">
217
                                <em>N/A</em>
218
                            </section>
219
                        </section>
220
                        <section class="row-fluid private">
221
                            <section class="span4">
222
                                                                    <a href="../classes/Application.html#method_initialiser" class="">initialiser()</a><br />
223
                                                            </section>
224
                            <section class="span4">
225
                                                                    <a href="../classes/Application.html#property_info" class="">$info</a><br />
226
                                                                    <a href="../classes/Application.html#property_chemin" class="">$chemin</a><br />
227
                                                            </section>
228
                            <section class="span4">
229
                                <em>N/A</em>
230
                            </section>
231
                        </section>
232
                    </section>
233
                </div>
234
                <aside class="span4 detailsbar">
235
 
236
 
237
                    <dl>
238
                        <dt>File</dt>
239
                            <dd><a href="../files/Application.php.html"><div class="path-wrapper">Application.php</div></a></dd>
240
                                                <dt>Package</dt>
476 jpm 241
                            <dd><div class="namespace-wrapper">\Framework</div></dd>
467 jpm 242
                                                <dt>Class hierarchy</dt>
243
                            <dd class="hierarchy">
244
                                                                                                                                                                    <div class="namespace-wrapper">\Application</div>
245
                            </dd>
246
 
247
 
248
 
249
 
250
 
251
                                                                        </dl>
252
                    <h2>Tags</h2>
253
                    <table class="table table-condensed">
254
                                            <tr>
255
                            <th>
256
                                category
257
                            </th>
258
                            <td>
476 jpm 259
                                                                    <p>PHP 5.2</p>
467 jpm 260
                                                            </td>
261
                        </tr>
262
                                            <tr>
263
                            <th>
264
                                author
265
                            </th>
266
                            <td>
476 jpm 267
                                                                    <p>Jean-Pascal MILCENT <a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a></p>
467 jpm 268
                                                            </td>
269
                        </tr>
270
                                            <tr>
271
                            <th>
476 jpm 272
                                copyright
467 jpm 273
                            </th>
274
                            <td>
476 jpm 275
                                                                    <p>Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)</p>
467 jpm 276
                                                            </td>
277
                        </tr>
278
                                            <tr>
279
                            <th>
476 jpm 280
                                license
467 jpm 281
                            </th>
282
                            <td>
476 jpm 283
                                                                    <p>GNU-GPL-v3 <a href="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</a></p>
284
                                                                    <p>CECILL-v2 <a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt</a></p>
467 jpm 285
                                                            </td>
286
                        </tr>
287
                                            <tr>
288
                            <th>
289
                                todo
290
                            </th>
291
                            <td>
292
                                                            </td>
293
                        </tr>
294
                                        </table>
295
                </aside>
296
            </div>
297
 
298
 
299
                                    <a id="properties" name="properties"></a>
300
            <div class="row-fluid">
301
                <div class="span8 content class">
302
                    <h2>Properties</h2>
303
                </div>
304
                <aside class="span4 detailsbar"></aside>
305
            </div>
306
 
307
                                                                    <div class="row-fluid">
308
        <div class="span8 content class">
309
            <a id="property_info" name="property_info" class="anchor"></a>
310
            <article class="property">
311
                <h3 class="private ">$info</h3>
312
                <pre class="signature">$info</pre>
313
                <p><em>Tableau d&#039;informations sur l&#039;application</em></p>
314
 
315
 
316
                            </article>
317
        </div>
318
        <aside class="span4 detailsbar">
319
            <h1><i class="icon-arrow-down"></i></h1>
320
                        <dl>
321
                                                            </dl>
322
            <h2>Tags</h2>
323
            <table class="table table-condensed">
324
                                    <tr>
325
                        <th>
326
                            todo
327
                        </th>
328
                        <td>
329
                                                    </td>
330
                    </tr>
331
                            </table>
332
        </aside>
333
    </div>
334
 
335
                                    <div class="row-fluid">
336
        <div class="span8 content class">
337
            <a id="property_chemin" name="property_chemin" class="anchor"></a>
338
            <article class="property">
339
                <h3 class="private ">$chemin</h3>
340
                <pre class="signature">$chemin</pre>
341
                <p><em>Chemin de base de l&#039;application</em></p>
342
 
343
 
344
                            </article>
345
        </div>
346
        <aside class="span4 detailsbar">
347
            <h1><i class="icon-arrow-down"></i></h1>
348
                        <dl>
349
                                                            </dl>
350
            <h2>Tags</h2>
351
            <table class="table table-condensed">
352
                                    <tr>
353
                        <th>
354
                            todo
355
                        </th>
356
                        <td>
357
                                                    </td>
358
                    </tr>
359
                            </table>
360
        </aside>
361
    </div>
362
 
363
 
364
                                    <a id="methods" name="methods"></a>
365
            <div class="row-fluid">
366
                <div class="span8 content class"><h2>Methods</h2></div>
367
                <aside class="span4 detailsbar"></aside>
368
            </div>
369
 
370
                                    <div class="row-fluid">
371
        <div class="span8 content class">
372
            <a id="method_setChemin" name="method_setChemin" class="anchor"></a>
373
            <article class="method">
374
                <h3 class="public ">setChemin()</h3>
375
                <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>
376
                <pre class="signature" style="margin-right: 54px;">setChemin(string <span class="argument">$chemin_fichier_principal</span>)</pre>
377
                <p><em>Permet d&#039;indiquer le chemin de base de l&#039;Application.</em></p>
378
                <p>Cette méthode doit obligatoirement être utilisée par l'application pour que le Framework fonctionne correctement.</p>
379
 
380
                                    <h4>Parameters</h4>
381
                    <table class="table table-condensed table-hover">
382
                                                    <tr>
383
                                <td>string</td>
384
                                <td>$chemin_fichier_principal</td>
385
                                <td><p>chemin de base</p></td>
386
                            </tr>
387
                                            </table>
388
 
389
 
390
                            </article>
391
        </div>
392
        <aside class="span4 detailsbar">
393
            <h1><i class="icon-arrow-down"></i></h1>
394
                            <span class="label label-info">static</span>
395
                                                            <dl>
396
                                                                            </dl>
397
            <h2>Tags</h2>
398
            <table class="table table-condensed">
399
                                    <tr>
400
                        <th>
401
                            todo
402
                        </th>
403
                        <td>
404
                                                    </td>
405
                    </tr>
406
                            </table>
407
        </aside>
408
    </div>
409
 
410
                                    <div class="row-fluid">
411
        <div class="span8 content class">
412
            <a id="method_getChemin" name="method_getChemin" class="anchor"></a>
413
            <article class="method">
414
                <h3 class="public ">getChemin()</h3>
415
                <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>
416
                <pre class="signature" style="margin-right: 54px;">getChemin() : string</pre>
417
                <p><em>accesseur pour le chemin</em></p>
418
 
419
 
420
 
421
 
422
                                    <h4>Returns</h4>
423
                    string
424
                                            &mdash; <p>le chemin</p>
425
                                                </article>
426
        </div>
427
        <aside class="span4 detailsbar">
428
            <h1><i class="icon-arrow-down"></i></h1>
429
                            <span class="label label-info">static</span>
430
                                                            <dl>
431
                                                                            </dl>
432
            <h2>Tags</h2>
433
            <table class="table table-condensed">
434
                                    <tr>
435
                        <th>
436
                            todo
437
                        </th>
438
                        <td>
439
                                                    </td>
440
                    </tr>
441
                            </table>
442
        </aside>
443
    </div>
444
 
445
                                    <div class="row-fluid">
446
        <div class="span8 content class">
447
            <a id="method_setInfo" name="method_setInfo" class="anchor"></a>
448
            <article class="method">
449
                <h3 class="public ">setInfo()</h3>
450
                <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>
451
                <pre class="signature" style="margin-right: 54px;">setInfo(array <span class="argument">$info</span>) : void</pre>
452
                <p><em>Le tableau des informations sur l&#039;application possède les clés suivantes :
453
- nom : nom de l&#039;application
454
- abr : abréviation de l&#039;application
455
- encodage : encodage de l&#039;application (ISO-8859-15, UTF-8.</em></p>
456
                <p>..)</p>
457
 
458
                                    <h4>Parameters</h4>
459
                    <table class="table table-condensed table-hover">
460
                                                    <tr>
461
                                <td>array</td>
462
                                <td>$info</td>
463
                                <td><p>tableau fournissant des informations sur l'application</p></td>
464
                            </tr>
465
                                            </table>
466
 
467
 
468
                            </article>
469
        </div>
470
        <aside class="span4 detailsbar">
471
            <h1><i class="icon-arrow-down"></i></h1>
472
                            <span class="label label-info">static</span>
473
                                                            <dl>
474
                                                                            </dl>
475
            <h2>Tags</h2>
476
            <table class="table table-condensed">
477
                                    <tr>
478
                        <th>
479
                            todo
480
                        </th>
481
                        <td>
482
                                                    </td>
483
                    </tr>
484
                            </table>
485
        </aside>
486
    </div>
487
 
488
                                    <div class="row-fluid">
489
        <div class="span8 content class">
490
            <a id="method_getInfo" name="method_getInfo" class="anchor"></a>
491
            <article class="method">
492
                <h3 class="public ">getInfo()</h3>
493
                <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>
494
                <pre class="signature" style="margin-right: 54px;">getInfo(string <span class="argument">$cle</span>)</pre>
495
                <p><em>accesseur pour le tableau d&#039;infos</em></p>
496
 
497
 
498
                                    <h4>Parameters</h4>
499
                    <table class="table table-condensed table-hover">
500
                                                    <tr>
501
                                <td>string</td>
502
                                <td>$cle</td>
503
                                <td><p>la clé à laquelle on veut accéder</p></td>
504
                            </tr>
505
                                            </table>
506
 
507
 
508
                            </article>
509
        </div>
510
        <aside class="span4 detailsbar">
511
            <h1><i class="icon-arrow-down"></i></h1>
512
                            <span class="label label-info">static</span>
513
                                                            <dl>
514
                                                                            </dl>
515
            <h2>Tags</h2>
516
            <table class="table table-condensed">
517
                                    <tr>
518
                        <th>
519
                            todo
520
                        </th>
521
                        <td>
522
                                                    </td>
523
                    </tr>
524
                            </table>
525
        </aside>
526
    </div>
527
 
528
                                                                    <div class="row-fluid">
529
        <div class="span8 content class">
530
            <a id="method_initialiser" name="method_initialiser" class="anchor"></a>
531
            <article class="method">
532
                <h3 class="private ">initialiser()</h3>
533
                <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>
534
                <pre class="signature" style="margin-right: 54px;">initialiser()</pre>
535
                <p><em>Initialise différentes classes du Framework nécessaires pour le fonctionnement de l&#039;application.</em></p>
536
                <p>Ces classes sont ensuites controlées via les fichiers de config.ini.
537
Elle est appelée automatiquement suite à la définition du chemin de l'application via Application::setChemin().</p>
538
 
539
 
540
 
541
                            </article>
542
        </div>
543
        <aside class="span4 detailsbar">
544
            <h1><i class="icon-arrow-down"></i></h1>
545
                            <span class="label label-info">static</span>
546
                                                            <dl>
547
                                                                            </dl>
548
            <h2>Tags</h2>
549
            <table class="table table-condensed">
550
                                    <tr>
551
                        <th>
552
                            todo
553
                        </th>
554
                        <td>
555
                                                    </td>
556
                    </tr>
557
                            </table>
558
        </aside>
559
    </div>
560
 
561
                                    </div>
562
    </section>
563
 
564
    <div id="source-view" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="source-view-label" aria-hidden="true">
565
        <div class="modal-header">
566
            <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
567
            <h3 id="source-view-label">Application.php</h3>
568
        </div>
569
        <div class="modal-body">
570
            <pre data-src="../files/Application.php.txt" class="language-php line-numbers"></pre>
571
        </div>
572
    </div>
573
 
574
    <footer class="row-fluid">
575
        <section class="span10 offset2">
576
            <section class="row-fluid">
577
                <section class="span10 offset1">
578
                    <section class="row-fluid footer-sections">
579
                        <section class="span4">
580
                                                        <h1><i class="icon-code"></i></h1>
581
                            <div>
582
                                <ul>
583
                                                                    </ul>
584
                            </div>
585
                        </section>
586
                        <section class="span4">
587
                                                        <h1><i class="icon-bar-chart"></i></h1>
588
                            <div>
589
                                <ul>
590
                                    <li><a href="../graphs/class.html">Class Hierarchy Diagram</a></li>
591
                                </ul>
592
                            </div>
593
                        </section>
594
                        <section class="span4">
595
                                                        <h1><i class="icon-pushpin"></i></h1>
596
                            <div>
597
                                <ul>
598
                                    <li><a href="../reports/errors.html">Errors</a></li>
599
                                    <li><a href="../reports/markers.html">Markers</a></li>
600
                                </ul>
601
                            </div>
602
                        </section>
603
                    </section>
604
                </section>
605
            </section>
606
            <section class="row-fluid">
607
                <section class="span10 offset1">
608
                    <hr />
609
                    Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
476 jpm 610
                    on March 18th, 2014 at 19:19.
467 jpm 611
                </section>
612
            </section>
613
        </section>
614
    </footer>
615
</div>
616
 
617
</body>
618
</html>