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