Subversion Repositories Applications.framework

Rev

Go to most recent revision | Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
464 jpm 1
<!DOCTYPE html>
2
<html>
3
<head>
4
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
5
	<meta name="generator" content="ApiGen 2.8.0">
6
 
7
	<title>Class Controleur | TBFramework - v0.4</title>
8
 
9
	<script type="text/javascript" src="resources/combined.js?4205936287"></script>
10
	<script type="text/javascript" src="elementlist.js?1964084359"></script>
11
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360">
12
 
13
</head>
14
 
15
<body>
16
<div id="left">
17
	<div id="menu">
18
		<a href="index.html" title="Overview"><span>Overview</span></a>
19
 
20
 
21
		<div id="groups">
22
			<h3>Packages</h3>
23
			<ul>
24
				<li class="active"><a href="package-Framework.html">Framework</a>
25
						</li>
26
				<li><a href="package-None.html">None</a>
27
						</li>
28
				<li><a href="package-PHP.html">PHP</a>
29
						</li>
30
				<li><a href="package-Utilitaire.html">Utilitaire</a>
31
						</li>
32
			</ul>
33
		</div>
34
 
35
		<hr>
36
 
37
 
38
		<div id="elements">
39
			<h3>Classes</h3>
40
			<ul>
41
				<li><a href="class-Bdd.html">Bdd</a></li>
42
				<li><a href="class-Cache.html">Cache</a></li>
43
				<li><a href="class-CacheSimple.html">CacheSimple</a></li>
44
				<li><a href="class-Chronometre.html">Chronometre</a></li>
45
				<li><a href="class-Cli.html">Cli</a></li>
46
				<li><a href="class-Config.html">Config</a></li>
47
				<li class="active"><a href="class-Controleur.html">Controleur</a></li>
48
				<li><a href="class-Debug.html">Debug</a></li>
49
				<li><a href="class-Framework.html">Framework</a></li>
50
				<li><a href="class-GestionnaireException.html">GestionnaireException</a></li>
51
				<li><a href="class-I18n.html">I18n</a></li>
52
				<li><a href="class-Log.html">Log</a></li>
53
				<li><a href="class-MonService.html">MonService</a></li>
54
				<li><a href="class-Registre.html">Registre</a></li>
55
				<li><a href="class-RestClient.html">RestClient</a></li>
56
				<li><a href="class-RestServeur.html">RestServeur</a></li>
57
				<li><a href="class-RestService.html">RestService</a></li>
58
				<li><a href="class-Script.html">Script</a></li>
59
				<li><a href="class-ServiceCacheFichier.html">ServiceCacheFichier</a></li>
60
				<li><a href="class-ServiceCacheSimple.html">ServiceCacheSimple</a></li>
61
				<li><a href="class-ServiceCacheSqlite.html">ServiceCacheSqlite</a></li>
62
				<li><a href="class-SquelettePhp.html">SquelettePhp</a></li>
63
				<li><a href="class-Url.html">Url</a></li>
64
			</ul>
65
 
66
 
67
 
68
 
69
 
70
		</div>
71
	</div>
72
</div>
73
 
74
<div id="splitter"></div>
75
 
76
<div id="right">
77
<div id="rightInner">
78
	<form id="search">
79
		<input type="hidden" name="cx" value="">
80
		<input type="hidden" name="ie" value="UTF-8">
81
		<input type="text" name="q" class="text">
82
		<input type="submit" value="Search">
83
	</form>
84
 
85
	<div id="navigation">
86
		<ul>
87
			<li>
88
				<a href="index.html" title="Overview"><span>Overview</span></a>
89
			</li>
90
			<li>
91
				<a href="package-Framework.html" title="Summary of Framework"><span>Package</span></a>
92
			</li>
93
			<li class="active">
94
<span>Class</span>			</li>
95
		</ul>
96
		<ul>
97
			<li>
98
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
99
			</li>
100
			<li>
101
				<a href="deprecated.html" title="List of deprecated elements"><span>Deprecated</span></a>
102
			</li>
103
			<li>
104
				<a href="todo.html" title="Todo list"><span>Todo</span></a>
105
			</li>
106
		</ul>
107
		<ul>
108
		</ul>
109
	</div>
110
 
111
<div id="content" class="class">
112
	<h1>Class Controleur</h1>
113
 
114
 
115
	<div class="description">
116
 
117
<p>Classe Controleur, coeur d'une application, c'est normalement la seule classe
118
d'une application qui devrait être appelée de l'extérieur. Elle est abstraite
119
donc doit obligatoirement être étendue.</p>
120
 
121
	</div>
122
 
123
 
124
 
125
 
126
 
127
 
128
 
129
 
130
 
131
	<div class="info">
132
		<b>Abstract</b><br>
133
 
134
 
135
		<b>Package:</b> <a href="package-Framework.html">Framework</a><br>
136
 
137
				<b>Category:</b>
138
				php 5.2<br>
139
				<b>Copyright:</b>
140
				Copyright (c) 2009, Tela Botanica (<a
141
href="mailto:accueil&#64;tela-botanica.org">accueil&#64;<!-- -->tela-botanica.org</a>)<br>
142
				<b>License:</b>
143
				<a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL</a><br>
144
				<b>License:</b>
145
				<a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL</a><br>
146
				<b>Author:</b>
147
				Aurélien PERONNET &lt;<a
148
href="mailto:aurelien&#64;tela-botanica.org">aurelien&#64;<!-- -->tela-botanica.org</a>&gt;<br>
149
				<b>Author:</b>
150
				Jean-Pascal MILCENT &lt;<a
151
href="mailto:jpm&#64;tela-botanica.org">jpm&#64;<!-- -->tela-botanica.org</a>&gt;<br>
152
				<b>Version:</b>
153
				$Id: Controleur.php 415 2012-04-04 09:05:55Z jpm $<br>
154
				<b>Link:</b>
155
				/doc/framework/<br>
156
		<b>Located at</b> <a href="source-class-Controleur.html#3-154" title="Go to source code">framework/Controleur.php</a><br>
157
	</div>
158
 
159
 
160
 
161
	<table class="summary" id="methods">
162
	<caption>Methods summary</caption>
163
	<tr data-order="__construct" id="___construct">
164
 
165
		<td class="attributes"><code>
166
			 public
167
 
168
 
169
			</code>
170
		</td>
171
 
172
		<td class="name"><div>
173
		<a class="anchor" href="#___construct">#</a>
174
		<code><a href="source-class-Controleur.html#38-60" title="Go to source code">__construct</a>( )</code>
175
 
176
		<div class="description short">
177
 
178
<p>Constructeur par défaut</p>
179
 
180
		</div>
181
 
182
		<div class="description detailed hidden">
183
 
184
<p>Constructeur par défaut</p>
185
 
186
 
187
 
188
 
189
 
190
 
191
 
192
 
193
		</div>
194
		</div></td>
195
	</tr>
196
	<tr data-order="getCheminSquelette" id="_getCheminSquelette">
197
 
198
		<td class="attributes"><code>
199
			 protected
200
			String
201
 
202
			</code>
203
		</td>
204
 
205
		<td class="name"><div>
206
		<a class="anchor" href="#_getCheminSquelette">#</a>
207
		<code><a href="source-class-Controleur.html#62-69" title="Go to source code">getCheminSquelette</a>( )</code>
208
 
209
		<div class="description short">
210
 
211
<p>Permet de récupérer le chemin vers les squelettes.</p>
212
 
213
		</div>
214
 
215
		<div class="description detailed hidden">
216
 
217
<p>Permet de récupérer le chemin vers les squelettes.</p>
218
 
219
 
220
 
221
 
222
				<h4>Returns</h4>
223
				<div class="list">
224
					<code>String</code><br>$chemin chemin vers les squelettes<br>
225
				</div>
226
 
227
 
228
 
229
 
230
		</div>
231
		</div></td>
232
	</tr>
233
	<tr data-order="setCheminSquelette" id="_setCheminSquelette">
234
 
235
		<td class="attributes"><code>
236
			 protected
237
 
238
 
239
			</code>
240
		</td>
241
 
242
		<td class="name"><div>
243
		<a class="anchor" href="#_setCheminSquelette">#</a>
244
		<code><a href="source-class-Controleur.html#71-78" title="Go to source code">setCheminSquelette</a>( <span>String <var>$chemin</var></span> )</code>
245
 
246
		<div class="description short">
247
 
248
<p>Permet de définir dynamiquement le chemin vers les squelettes.</p>
249
 
250
		</div>
251
 
252
		<div class="description detailed hidden">
253
 
254
<p>Permet de définir dynamiquement le chemin vers les squelettes.</p>
255
 
256
 
257
 
258
				<h4>Parameters</h4>
259
				<div class="list"><dl>
260
					<dt><var>$chemin</var></dt>
261
					<dd><code>String</code><br>$chemin chemin vers les squelettes</dd>
262
				</dl></div>
263
 
264
 
265
 
266
 
267
 
268
		</div>
269
		</div></td>
270
	</tr>
271
	<tr data-order="chargerModele" id="_chargerModele">
272
 
273
		<td class="attributes"><code>
274
			 public
275
			boolean
276
 
277
			</code>
278
		</td>
279
 
280
		<td class="name"><div>
281
		<a class="anchor" href="#_chargerModele">#</a>
282
		<code><a href="source-class-Controleur.html#80-98" title="Go to source code">chargerModele</a>( <span>string <var>$nom_modele</var></span> )</code>
283
 
284
		<div class="description short">
285
 
286
<p>Charge un modele donné et le rend disponible sous la forme
287
$this-&gt;nom_modele</p>
288
 
289
		</div>
290
 
291
		<div class="description detailed hidden">
292
 
293
<p>Charge un modele donné et le rend disponible sous la forme
294
$this-&gt;nom_modele</p>
295
 
296
 
297
 
298
				<h4>Parameters</h4>
299
				<div class="list"><dl>
300
					<dt><var>$nom_modele</var></dt>
301
					<dd><code>string</code><br>$nom_modele le nom du modèle à  charger</dd>
302
				</dl></div>
303
 
304
				<h4>Returns</h4>
305
				<div class="list">
306
					<code>boolean</code><br>false si le chargement a échoué, sinon true.<br>
307
				</div>
308
 
309
 
310
 
311
 
312
		</div>
313
		</div></td>
314
	</tr>
315
	<tr data-order="getModele" id="_getModele">
316
 
317
		<td class="attributes"><code>
318
			 protected
319
			mixed
320
 
321
			</code>
322
		</td>
323
 
324
		<td class="name"><div>
325
		<a class="anchor" href="#_getModele">#</a>
326
		<code><a href="source-class-Controleur.html#100-119" title="Go to source code">getModele</a>( <span>string <var>$nom_modele</var></span>, <span>String <var>$ext</var> = <span class="php-quote">'.php'</span></span> )</code>
327
 
328
		<div class="description short">
329
 
330
<p>Retourne un modele donné</p>
331
 
332
		</div>
333
 
334
		<div class="description detailed hidden">
335
 
336
<p>Retourne un modele donné</p>
337
 
338
 
339
 
340
				<h4>Parameters</h4>
341
				<div class="list"><dl>
342
					<dt><var>$nom_modele</var></dt>
343
					<dd><code>string</code><br>$nom_modele le nom du fichier modèle à charger sans son extension</dd>
344
					<dt><var>$ext</var></dt>
345
					<dd><code>String</code><br>$ext l'extension du fichier du modèle (par défaut : ".php")</dd>
346
				</dl></div>
347
 
348
				<h4>Returns</h4>
349
				<div class="list">
350
					<code>mixed</code><br>false si le chargement a échoué, sinon l'objet du modèle demandé.<br>
351
				</div>
352
 
353
 
354
 
355
 
356
		</div>
357
		</div></td>
358
	</tr>
359
	<tr data-order="getVue" id="_getVue">
360
 
361
		<td class="attributes"><code>
362
			 protected
363
			boolean
364
 
365
			</code>
366
		</td>
367
 
368
		<td class="name"><div>
369
		<a class="anchor" href="#_getVue">#</a>
370
		<code><a href="source-class-Controleur.html#121-140" title="Go to source code">getVue</a>( <span>String <var>$nom_squelette</var></span>, <span>Array <var>$donnees</var> = <span class="php-keyword1">array</span>()</span> )</code>
371
 
372
		<div class="description short">
373
 
374
<p>Fonction prenant en paramètre le nom d'un squelette et un tableau associatif
375
de données, en extrait les variables, charge le squelette et retourne le
376
résultat des deux combinés.</p>
377
 
378
		</div>
379
 
380
		<div class="description detailed hidden">
381
 
382
<p>Fonction prenant en paramètre le nom d'un squelette et un tableau associatif
383
de données, en extrait les variables, charge le squelette et retourne le
384
résultat des deux combinés.</p>
385
 
386
 
387
 
388
				<h4>Parameters</h4>
389
				<div class="list"><dl>
390
					<dt><var>$nom_squelette</var></dt>
391
					<dd><code>String</code><br>$nom_squelette le nom du squelette sans son extension si elle vaut ".tpl.html"</dd>
392
					<dt><var>$donnees</var></dt>
393
					<dd><code>Array</code><br>$donnees un tableau associatif contenant les variables a injecter dans la vue</dd>
394
				</dl></div>
395
 
396
				<h4>Returns</h4>
397
				<div class="list">
398
					<code>boolean</code><br>false si la vue n'existe pas, sinon la chaine résultat.<br>
399
				</div>
400
 
401
 
402
				<h4>Since</h4>
403
				<div class="list">
404
						0.4 suppression du paramètre 'ext' =&gt; le mettre directement dans le nom du
405
squelette<br>
406
				</div>
407
 
408
 
409
		</div>
410
		</div></td>
411
	</tr>
412
	<tr data-order="preTraiterDonnees" id="_preTraiterDonnees">
413
 
414
		<td class="attributes"><code>
415
			 protected
416
			Array
417
 
418
			</code>
419
		</td>
420
 
421
		<td class="name"><div>
422
		<a class="anchor" href="#_preTraiterDonnees">#</a>
423
		<code><a href="source-class-Controleur.html#142-153" title="Go to source code">preTraiterDonnees</a>( <span>Array <var>&amp; $donnees</var></span> )</code>
424
 
425
		<div class="description short">
426
 
427
<p>Fonction prenant en paramètre un tableau de données et effectuant un
428
traitement dessus. Cette fonction est à surcharger dans les classes filles pour
429
automatiser un traitement avant chaque chargement de vue.</p>
430
 
431
		</div>
432
 
433
		<div class="description detailed hidden">
434
 
435
<p>Fonction prenant en paramètre un tableau de données et effectuant un
436
traitement dessus. Cette fonction est à surcharger dans les classes filles pour
437
automatiser un traitement avant chaque chargement de vue.</p>
438
 
439
 
440
 
441
				<h4>Parameters</h4>
442
				<div class="list"><dl>
443
					<dt><var>$donnees</var></dt>
444
					<dd><code>Array</code><br>$donnees Le tableau de données à traiter</dd>
445
				</dl></div>
446
 
447
				<h4>Returns</h4>
448
				<div class="list">
449
					<code>Array</code><br>$donnees Le tableau de données traité<br>
450
				</div>
451
 
452
 
453
 
454
 
455
		</div>
456
		</div></td>
457
	</tr>
458
	</table>
459
 
460
 
461
 
462
 
463
 
464
 
465
 
466
 
467
 
468
 
469
 
470
 
471
	<table class="summary" id="properties">
472
	<caption>Properties summary</caption>
473
	<tr data-order="parametres_obligatoires" id="$parametres_obligatoires">
474
		<td class="attributes"><code>
475
			protected
476
			array
477
		</code></td>
478
 
479
		<td class="name">
480
				<a href="source-class-Controleur.html#35-36" title="Go to source code"><var>$parametres_obligatoires</var></a>
481
		</td>
482
		<td class="value"><code><span class="php-keyword1">array</span>(<span class="php-quote">'chemin_modeles'</span>, <span class="php-quote">'chemin_squelettes'</span>, <span class="php-quote">'chemin_controleurs'</span>, <span class="php-quote">'base_url_application'</span>)</code></td>
483
		<td class="description"><div>
484
			<a href="#$parametres_obligatoires" class="anchor">#</a>
485
 
486
			<div class="description short">
487
 
488
<p>Tableau des noms des paramètres à définir dans le fichier de config car
489
obligatoirement nécessaire à cette classe.</p>
490
 
491
			</div>
492
 
493
			<div class="description detailed hidden">
494
 
495
<p>Tableau des noms des paramètres à définir dans le fichier de config car
496
obligatoirement nécessaire à cette classe.</p>
497
 
498
 
499
			</div>
500
		</div></td>
501
	</tr>
502
	</table>
503
 
504
 
505
 
506
 
507
 
508
 
509
</div>
510
 
511
	<div id="footer">
512
		TBFramework - v0.4 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
513
	</div>
514
</div>
515
</div>
516
</body>
517
</html>