Subversion Repositories Applications.framework

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
469 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.3</title>
8
 
9
	<script type="text/javascript" src="resources/combined.js?4205936287"></script>
10
	<script type="text/javascript" src="elementlist.js?4111837732"></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-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 332 2011-03-22 16:54:23Z delphine $<br>
150
				<b>Link:</b>
151
				/doc/framework/<br>
152
		<b>Located at</b> <a href="source-class-Controleur.html#3-121" title="Go to source code">Controleur.php</a><br>
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-47" 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="chargerModele" id="_chargerModele">
193
 
194
		<td class="attributes"><code>
195
			final public
196
			boolean
197
 
198
			</code>
199
		</td>
200
 
201
		<td class="name"><div>
202
		<a class="anchor" href="#_chargerModele">#</a>
203
		<code><a href="source-class-Controleur.html#49-67" title="Go to source code">chargerModele</a>( <span>string <var>$nom_modele</var></span> )</code>
204
 
205
		<div class="description short">
206
 
207
<p>Charge un modele donné et le rend disponible sous la forme
208
$this-&gt;nom_modele</p>
209
 
210
		</div>
211
 
212
		<div class="description detailed hidden">
213
 
214
<p>Charge un modele donné et le rend disponible sous la forme
215
$this-&gt;nom_modele</p>
216
 
217
 
218
 
219
				<h4>Parameters</h4>
220
				<div class="list"><dl>
221
					<dt><var>$nom_modele</var></dt>
222
					<dd><code>string</code><br>$nom_modele le nom du modèle à  charger</dd>
223
				</dl></div>
224
 
225
				<h4>Returns</h4>
226
				<div class="list">
227
					<code>boolean</code><br>false si le chargement a échoué, sinon true.<br>
228
				</div>
229
 
230
 
231
 
232
 
233
		</div>
234
		</div></td>
235
	</tr>
236
	<tr data-order="getModele" id="_getModele">
237
 
238
		<td class="attributes"><code>
239
			final protected
240
			mixed
241
 
242
			</code>
243
		</td>
244
 
245
		<td class="name"><div>
246
		<a class="anchor" href="#_getModele">#</a>
247
		<code><a href="source-class-Controleur.html#69-88" 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>
248
 
249
		<div class="description short">
250
 
251
<p>Retourne un modele donné</p>
252
 
253
		</div>
254
 
255
		<div class="description detailed hidden">
256
 
257
<p>Retourne un modele donné</p>
258
 
259
 
260
 
261
				<h4>Parameters</h4>
262
				<div class="list"><dl>
263
					<dt><var>$nom_modele</var></dt>
264
					<dd><code>string</code><br>$nom_modele le nom du fichier modèle à charger sans son extension</dd>
265
					<dt><var>$ext</var></dt>
266
					<dd><code>String</code><br>$ext l'extension du fichier du modèel (par défaut : ".php"</dd>
267
				</dl></div>
268
 
269
				<h4>Returns</h4>
270
				<div class="list">
271
					<code>mixed</code><br>false si le chargement a échoué, sinon l'objet du modèle demandé.<br>
272
				</div>
273
 
274
 
275
 
276
 
277
		</div>
278
		</div></td>
279
	</tr>
280
	<tr data-order="getVue" id="_getVue">
281
 
282
		<td class="attributes"><code>
283
			final protected
284
			boolean
285
 
286
			</code>
287
		</td>
288
 
289
		<td class="name"><div>
290
		<a class="anchor" href="#_getVue">#</a>
291
		<code><a href="source-class-Controleur.html#90-107" title="Go to source code">getVue</a>( <span>String <var>$nom_squelette</var></span>, <span>Array <var>&amp; $donnees</var> = <span class="php-keyword1">array</span>()</span>, <span>String <var>$ext</var> = <span class="php-quote">'.tpl.html'</span></span> )</code>
292
 
293
		<div class="description short">
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
		</div>
300
 
301
		<div class="description detailed hidden">
302
 
303
<p>Fonction prenant en paramètre le nom d'un squelette et un tableau associatif
304
de données, en extrait les variables, charge le squelette et retourne le
305
résultat des deux combinés.</p>
306
 
307
 
308
 
309
				<h4>Parameters</h4>
310
				<div class="list"><dl>
311
					<dt><var>$nom_squelette</var></dt>
312
					<dd><code>String</code><br>$nom_squelette le nom du squelette sans son extension</dd>
313
					<dt><var>$donnees</var></dt>
314
					<dd><code>Array</code><br>$donnees un tableau associatif contenant les variables a injecter dans la vue</dd>
315
					<dt><var>$ext</var></dt>
316
					<dd><code>String</code><br>$ext l'extension du fichier du squelette (par défaut : ".tpl.html"</dd>
317
				</dl></div>
318
 
319
				<h4>Returns</h4>
320
				<div class="list">
321
					<code>boolean</code><br>false si la vue n'existe pas, sinon la chaine résultat.<br>
322
				</div>
323
 
324
 
325
 
326
 
327
		</div>
328
		</div></td>
329
	</tr>
330
	<tr data-order="preTraiterDonnees" id="_preTraiterDonnees">
331
 
332
		<td class="attributes"><code>
333
			 protected
334
			Array
335
 
336
			</code>
337
		</td>
338
 
339
		<td class="name"><div>
340
		<a class="anchor" href="#_preTraiterDonnees">#</a>
341
		<code><a href="source-class-Controleur.html#109-120" title="Go to source code">preTraiterDonnees</a>( <span>Array <var>&amp; $donnees</var></span> )</code>
342
 
343
		<div class="description short">
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
		</div>
350
 
351
		<div class="description detailed hidden">
352
 
353
<p>Fonction prenant en paramètre un tableau de données et effectuant un
354
traitement dessus. Cette fonction est à surcharger dans les classes filles pour
355
automatiser un traitement avant chaque chargement de vue.</p>
356
 
357
 
358
 
359
				<h4>Parameters</h4>
360
				<div class="list"><dl>
361
					<dt><var>$donnees</var></dt>
362
					<dd><code>Array</code><br>$donnees Le tableau de données à traiter</dd>
363
				</dl></div>
364
 
365
				<h4>Returns</h4>
366
				<div class="list">
367
					<code>Array</code><br>$donnees Le tableau de données traité<br>
368
				</div>
369
 
370
 
371
 
372
 
373
		</div>
374
		</div></td>
375
	</tr>
376
	</table>
377
 
378
 
379
 
380
 
381
 
382
 
383
 
384
 
385
 
386
 
387
 
388
 
389
	<table class="summary" id="properties">
390
	<caption>Properties summary</caption>
391
	<tr data-order="parametres_obligatoires" id="$parametres_obligatoires">
392
		<td class="attributes"><code>
393
			protected
394
			array
395
		</code></td>
396
 
397
		<td class="name">
398
				<a href="source-class-Controleur.html#35-36" title="Go to source code"><var>$parametres_obligatoires</var></a>
399
		</td>
400
		<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>
401
		<td class="description"><div>
402
			<a href="#$parametres_obligatoires" class="anchor">#</a>
403
 
404
			<div class="description short">
405
 
406
<p>Tableau des noms des paramètres à définir dans le fichier de config car
407
obligatoirement nécessaire à cette classe.</p>
408
 
409
			</div>
410
 
411
			<div class="description detailed hidden">
412
 
413
<p>Tableau des noms des paramètres à définir dans le fichier de config car
414
obligatoirement nécessaire à cette classe.</p>
415
 
416
 
417
			</div>
418
		</div></td>
419
	</tr>
420
	</table>
421
 
422
 
423
 
424
 
425
 
426
 
427
</div>
428
 
429
	<div id="footer">
430
		TBFramework - v0.3 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
431
	</div>
432
</div>
433
</div>
434
</body>
435
</html>