Subversion Repositories Applications.framework

Rev

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