Subversion Repositories Applications.framework

Rev

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