Subversion Repositories Applications.framework

Rev

Rev 159 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 159 Rev 297
Line 91... Line 91...
91
<a name="sec-description"></a>
91
<a name="sec-description"></a>
92
<div class="info-box">
92
<div class="info-box">
93
	<div class="info-box-title">Description</div>
93
	<div class="info-box-title">Description</div>
94
	<div class="nav-bar">
94
	<div class="nav-bar">
95
					<span class="disabled">Description</span> |
95
					<span class="disabled">Description</span> |
-
 
96
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
96
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
97
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
Line 97... Line 98...
97
						
98
						
98
					</div>
99
					</div>
99
	<div class="info-box-body">
100
	<div class="info-box-body">
100
        		<!-- ========== Info from phpDoc block ========= -->
101
        		<!-- ========== Info from phpDoc block ========= -->
101
<p class="short-description">Classe Controleur, coeur d'une application, c'est normalement la seule classe d'une application  qui devrait être appelée de l'extérieur.</p>
102
<p class="short-description">Classe Controleur, coeur d'une application, c'est normalement la seule classe d'une application  qui devrait être appelée de l'extérieur.</p>
102
<p class="description"><p>Elle est abstraite donc doit obligatoirement être étendue.</p></p>
103
<p class="description"><p>Elle est abstraite donc doit obligatoirement être étendue.</p></p>
103
	<ul class="tags">
104
	<ul class="tags">
104
				<li><span class="field">author:</span> Jean-Pascal MILCENT &lt;<a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a>&gt;</li>
105
				<li><span class="field">author:</span> Jean-Pascal MILCENT &lt;<a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a>&gt;</li>
105
				<li><span class="field">author:</span> Aurélien PERONNET &lt;<a href="mailto:aurelien@tela-botanica.org">aurelien@tela-botanica.org</a>&gt;</li>
106
				<li><span class="field">author:</span> Aurélien PERONNET &lt;<a href="mailto:aurelien@tela-botanica.org">aurelien@tela-botanica.org</a>&gt;</li>
106
				<li><span class="field">version:</span> SVN: $$Id: Controleur.php 158 2010-03-04 17:14:36Z jpm $$</li>
107
				<li><span class="field">version:</span> $Id: Controleur.php 241 2010-12-06 15:19:07Z jpm $</li>
107
				<li><span class="field">copyright:</span> 2009 Tela-Botanica</li>
108
				<li><span class="field">copyright:</span> Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)</li>
108
				<li><span class="field">link:</span> /doc/framework/</li>
109
				<li><span class="field">link:</span> /doc/framework/</li>
109
				<li><span class="field">abstract:</span> </li>
110
				<li><span class="field">abstract:</span> </li>
110
				<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL</a></li>
111
				<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL</a></li>
111
				<li><span class="field">license:</span> <a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL</a></li>
112
				<li><span class="field">license:</span> <a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL</a></li>
Line 120... Line 121...
120
			</div>
121
			</div>
121
</div>
122
</div>
Line -... Line 123...
-
 
123
 
-
 
124
 
-
 
125
 
-
 
126
	<a name="sec-var-summary"></a>
-
 
127
	<div class="info-box">
-
 
128
		<div class="info-box-title">Variable Summary</span></div>
-
 
129
		<div class="nav-bar">
-
 
130
			<a href="#sec-description">Description</a> |
-
 
131
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
-
 
132
							| 
-
 
133
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
-
 
134
							
-
 
135
								</div>
-
 
136
		<div class="info-box-body">
-
 
137
			<div class="var-summary">
-
 
138
																								<div class="var-title">
-
 
139
					<span class="var-type">mixed</span>
-
 
140
					<a href="#$parametres_obligatoires" title="details" class="var-name">$parametres_obligatoires</a>
-
 
141
				</div>
Line 122... Line 142...
122
 
142
											</div>
123
 
143
		</div>
124
 
144
	</div>
125
 
145
 
126
	<a name="sec-method-summary"></a>
146
	<a name="sec-method-summary"></a>
-
 
147
	<div class="info-box">
-
 
148
		<div class="info-box-title">Method Summary</span></div>
-
 
149
		<div class="nav-bar">
127
	<div class="info-box">
150
			<a href="#sec-description">Description</a> |
128
		<div class="info-box-title">Method Summary</span></div>
151
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
129
		<div class="nav-bar">
152
				 
130
			<a href="#sec-description">Description</a> |
153
				|
Line 131... Line 154...
131
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
154
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
Line 144... Line 167...
144
										<a href="#chargerModele" title="details" class="method-name">chargerModele</a>
167
										<a href="#chargerModele" title="details" class="method-name">chargerModele</a>
145
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$nom_modele</span>)
168
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$nom_modele</span>)
146
									</div>
169
									</div>
Line 147... Line 170...
147
														
170
														
148
				<div class="method-definition">
-
 
149
											<span class="method-result">boolean</span>
-
 
150
										<a href="#chargerVue" title="details" class="method-name">chargerVue</a>
-
 
151
											(<span class="var-type">String</span>&nbsp;<span class="var-name">$nom_squelette</span>, [<span class="var-type">Array</span>&nbsp;<span class="var-name">$donnees</span> = <span class="var-default">array()</span>])
-
 
152
									</div>
-
 
153
														
-
 
154
				<div class="method-definition">
171
				<div class="method-definition">
155
											<span class="method-result">mixed</span>
172
											<span class="method-result">mixed</span>
156
										<a href="#getModele" title="details" class="method-name">getModele</a>
173
										<a href="#getModele" title="details" class="method-name">getModele</a>
157
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$nom_modele</span>)
174
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$nom_modele</span>, [<span class="var-type">String</span>&nbsp;<span class="var-name">$ext</span> = <span class="var-default">'.php'</span>])
Line 158... Line 175...
158
									</div>
175
									</div>
159
														
176
														
160
				<div class="method-definition">
177
				<div class="method-definition">
161
											<span class="method-result">boolean</span>
178
											<span class="method-result">boolean</span>
-
 
179
										<a href="#getVue" title="details" class="method-name">getVue</a>
-
 
180
											(<span class="var-type">String</span>&nbsp;<span class="var-name">$nom_squelette</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">&$donnees</span> = <span class="var-default">array()</span>], [<span class="var-type">String</span>&nbsp;<span class="var-name">$ext</span> = <span class="var-default">'.tpl.html'</span>], <span class="var-type">Array</span>&nbsp;<span class="var-name">$donnees</span>)
-
 
181
									</div>
-
 
182
														
-
 
183
				<div class="method-definition">
-
 
184
											<span class="method-result">Array</span>
162
										<a href="#getVue" title="details" class="method-name">getVue</a>
185
										<a href="#preTraiterDonnees" title="details" class="method-name">preTraiterDonnees</a>
163
											(<span class="var-type">String</span>&nbsp;<span class="var-name">$nom_squelette</span>, [<span class="var-type">Array</span>&nbsp;<span class="var-name">$donnees</span> = <span class="var-default">array()</span>])
186
											(<span class="var-type"></span>&nbsp;<span class="var-name">&$donnees</span>, <span class="var-type">Array</span>&nbsp;<span class="var-name">$donnees</span>)
164
									</div>
187
									</div>
165
											</div>
188
											</div>
Line -... Line 189...
-
 
189
		</div>
-
 
190
	</div>		
-
 
191
 
-
 
192
	<a name="sec-vars"></a>
-
 
193
	<div class="info-box">
-
 
194
		<div class="info-box-title">Variables</div>
-
 
195
		<div class="nav-bar">
-
 
196
			<a href="#sec-description">Description</a> |
-
 
197
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
-
 
198
						
-
 
199
			
-
 
200
										| 
-
 
201
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
-
 
202
							
-
 
203
					</div>
-
 
204
		<div class="info-box-body">
-
 
205
			
-
 
206
<a name="var$parametres_obligatoires" id="$parametres_obligatoires"><!-- --></A>
-
 
207
<div class="oddrow">
-
 
208
 
-
 
209
	<div class="var-header">
-
 
210
		<span class="var-title">
-
 
211
			<span class="var-type">mixed</span>
-
 
212
			<span class="var-name">$parametres_obligatoires</span>
-
 
213
			 = <span class="var-default">array('chemin_modeles', 'chemin_squelettes', 'chemin_controleurs', 'base_url_application')</span>			(line <span class="line-number"><a href="../__filesource/fsource_Framework__Controleur.php.html#a36">36</a></span>)
-
 
214
		</span>
-
 
215
	</div>
-
 
216
 
-
 
217
	<!-- ========== Info from phpDoc block ========= -->
-
 
218
<p class="short-description">Tableau des noms des paramètres à définir dans le fichier de config car obligatoirement nécessaire à cette classe.</p>
-
 
219
	<ul class="tags">
-
 
220
				<li><span class="field">access:</span> protected</li>
-
 
221
			</ul>
-
 
222
	
-
 
223
	
-
 
224
		
-
 
225
		
-
 
226
 
-
 
227
</div>
Line 166... Line 228...
166
		</div>
228
						
167
	</div>		
229
		</div>
168
 
230
	</div>
169
	
231
	
170
	<a name="sec-methods"></a>
232
	<a name="sec-methods"></a>
-
 
233
	<div class="info-box">
171
	<div class="info-box">
234
		<div class="info-box-title">Methods</div>
Line 172... Line 235...
172
		<div class="info-box-title">Methods</div>
235
		<div class="nav-bar">
173
		<div class="nav-bar">
236
			<a href="#sec-description">Description</a> |
174
			<a href="#sec-description">Description</a> |
237
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
175
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
238
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
176
						
239
						
Line 177... Line 240...
177
		</div>
240
		</div>
178
		<div class="info-box-body">
241
		<div class="info-box-body">
179
			<A NAME='method_detail'></A>
242
			<A NAME='method_detail'></A>
Line 180... Line 243...
180
<a name="method__construct" id="__construct"><!-- --></a>
243
<a name="method__construct" id="__construct"><!-- --></a>
181
<div class="oddrow">
244
<div class="evenrow">
182
	
245
	
Line 200... Line 263...
200
	
263
	
201
		
264
		
202
			
265
			
Line 203... Line 266...
203
	</div>
266
	</div>
204
<a name="methodchargerModele" id="chargerModele"><!-- --></a>
267
<a name="methodchargerModele" id="chargerModele"><!-- --></a>
205
<div class="evenrow">
268
<div class="oddrow">
Line 206... Line 269...
206
	
269
	
207
	<div class="method-header">
270
	<div class="method-header">
208
		<span class="method-title">chargerModele</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Controleur.php.html#a47">47</a></span>)
271
		<span class="method-title">chargerModele</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Controleur.php.html#a56">56</a></span>)
209
	</div> 
272
	</div> 
210
	
273
	
211
	<!-- ========== Info from phpDoc block ========= -->
274
	<!-- ========== Info from phpDoc block ========= -->
Line 212... Line 275...
212
<p class="short-description">Charge un modele donné et le rend disponible sous la forme $this-&gt;nom_modele</p>
275
<p class="short-description">Charge un modele donné et le rend disponible sous la forme $this-&gt;nom_modele</p>
213
	<ul class="tags">
276
	<ul class="tags">
214
				<li><span class="field">return:</span> false si le chargement a échoué, sinon true.</li>
277
				<li><span class="field">return:</span> false si le chargement a échoué, sinon true.</li>
Line 224... Line 287...
224
			</div>
287
			</div>
Line 225... Line 288...
225
	
288
	
226
			<ul class="parameters">
289
			<ul class="parameters">
227
					<li>
290
					<li>
228
				<span class="var-type">string</span>
291
				<span class="var-type">string</span>
229
				<span class="var-name">$nom_modele</span><span class="var-description">: le nom du modèle à charger</span>			</li>
292
				<span class="var-name">$nom_modele</span><span class="var-description">: le nom du modèle à  charger</span>			</li>
Line 230... Line 293...
230
				</ul>
293
				</ul>
231
		
294
		
232
			
295
			
Line 233... Line 296...
233
	</div>
296
	</div>
234
<a name="methodchargerVue" id="chargerVue"><!-- --></a>
297
<a name="methodgetModele" id="getModele"><!-- --></a>
235
<div class="oddrow">
298
<div class="evenrow">
Line 236... Line 299...
236
	
299
	
237
	<div class="method-header">
300
	<div class="method-header">
238
		<span class="method-title">chargerVue</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Controleur.php.html#a102">102</a></span>)
301
		<span class="method-title">getModele</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Controleur.php.html#a77">77</a></span>)
239
	</div> 
302
	</div> 
240
	
303
	
241
	<!-- ========== Info from phpDoc block ========= -->
304
	<!-- ========== Info from phpDoc block ========= -->
Line 242... Line 305...
242
<p class="short-description">Fonction prenant en paramètre le nom d'un squelette et un tableau associatif de données,  en extrait les variables, charge le squelette et crée une variable de classe portant le nom du squelette  contenant les deux combinés.</p>
305
<p class="short-description">Retourne un modele donné</p>
243
	<ul class="tags">
306
	<ul class="tags">
244
				<li><span class="field">return:</span> false si la vue n'existe pas, sinon true.</li>
307
				<li><span class="field">return:</span> false si le chargement a échoué, sinon l'objet du modèle demandé.</li>
245
				<li><span class="field">access:</span> protected</li>
308
				<li><span class="field">access:</span> protected</li>
246
			</ul>
309
			</ul>
247
	
310
	
248
	<div class="method-signature">
311
	<div class="method-signature">
Line 249... Line 312...
249
		<span class="method-result">boolean</span>
312
		<span class="method-result">mixed</span>
250
		<span class="method-name">
313
		<span class="method-name">
251
			chargerVue
314
			getModele
252
		</span>
315
		</span>
253
					(<span class="var-type">String</span>&nbsp;<span class="var-name">$nom_squelette</span>, [<span class="var-type">Array</span>&nbsp;<span class="var-name">$donnees</span> = <span class="var-default">array()</span>])
316
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$nom_modele</span>, [<span class="var-type">String</span>&nbsp;<span class="var-name">$ext</span> = <span class="var-default">'.php'</span>])
254
			</div>
317
			</div>
255
	
318
	
256
			<ul class="parameters">
319
			<ul class="parameters">
Line 257... Line 320...
257
					<li>
320
					<li>
258
				<span class="var-type">String</span>
321
				<span class="var-type">string</span>
259
				<span class="var-name">$nom_squelette</span><span class="var-description">: le nom du squelette</span>			</li>
322
				<span class="var-name">$nom_modele</span><span class="var-description">: le nom du fichier modèle à charger sans son extension</span>			</li>
Line 260... Line 323...
260
					<li>
323
					<li>
261
				<span class="var-type">Array</span>
324
				<span class="var-type">String</span>
262
				<span class="var-name">$donnees</span><span class="var-description">: un tableau associatif contenant les variables a injecter dans la vue</span>			</li>
325
				<span class="var-name">$ext</span><span class="var-description">: l'extension du fichier du modèel (par défaut : &quot;.php&quot;</span>			</li>
Line 263... Line 326...
263
				</ul>
326
				</ul>
264
		
327
		
265
			
328
			
266
	</div>
329
	</div>
267
<a name="methodgetModele" id="getModele"><!-- --></a>
330
<a name="methodgetVue" id="getVue"><!-- --></a>
268
<div class="evenrow">
331
<div class="oddrow">
Line 269... Line 332...
269
	
332
	
270
	<div class="method-header">
333
	<div class="method-header">
271
		<span class="method-title">getModele</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Controleur.php.html#a65">65</a></span>)
334
		<span class="method-title">getVue</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Controleur.php.html#a100">100</a></span>)
272
	</div> 
335
	</div> 
273
	
336
	
274
	<!-- ========== Info from phpDoc block ========= -->
337
	<!-- ========== Info from phpDoc block ========= -->
275
<p class="short-description">Retourne un modele donné</p>
338
<p class="short-description">Fonction prenant en paramètre le nom d'un squelette et un tableau associatif de données,  en extrait les variables, charge le squelette et retourne le résultat des deux combinés.</p>
Line 276... Line 339...
276
	<ul class="tags">
339
	<ul class="tags">
277
				<li><span class="field">return:</span> false si le chargement a échoué, sinon l'objet du modèle demandé.</li>
340
				<li><span class="field">return:</span> false si la vue n'existe pas, sinon la chaine résultat.</li>
278
				<li><span class="field">access:</span> protected</li>
341
				<li><span class="field">access:</span> protected</li>
279
			</ul>
342
			</ul>
-
 
343
	
-
 
344
	<div class="method-signature">
-
 
345
		<span class="method-result">boolean</span>
-
 
346
		<span class="method-name">
-
 
347
			getVue
-
 
348
		</span>
-
 
349
					(<span class="var-type">String</span>&nbsp;<span class="var-name">$nom_squelette</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">&$donnees</span> = <span class="var-default">array()</span>], [<span class="var-type">String</span>&nbsp;<span class="var-name">$ext</span> = <span class="var-default">'.tpl.html'</span>], <span class="var-type">Array</span>&nbsp;<span class="var-name">$donnees</span>)
-
 
350
			</div>
-
 
351
	
280
	
352
			<ul class="parameters">
Line 281... Line 353...
281
	<div class="method-signature">
353
					<li>
282
		<span class="method-result">mixed</span>
354
				<span class="var-type">String</span>
283
		<span class="method-name">
355
				<span class="var-name">$nom_squelette</span><span class="var-description">: le nom du squelette sans son extension</span>			</li>
Line 284... Line 356...
284
			getModele
356
					<li>
285
		</span>
357
				<span class="var-type">Array</span>
286
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$nom_modele</span>)
358
				<span class="var-name">$donnees</span><span class="var-description">: un tableau associatif contenant les variables a injecter dans la vue</span>			</li>
Line 287... Line 359...
287
			</div>
359
					<li>
288
	
360
				<span class="var-type">String</span>
-
 
361
				<span class="var-name">$ext</span><span class="var-description">: l'extension du fichier du squelette (par défaut : &quot;.tpl.html&quot;</span>			</li>
289
			<ul class="parameters">
362
					<li>
290
					<li>
363
				<span class="var-type"></span>
291
				<span class="var-type">string</span>
364
				<span class="var-name">&$donnees</span>			</li>
292
				<span class="var-name">$nom_modele</span><span class="var-description">: le nom du modèle à charger</span>			</li>
365
				</ul>
Line 293... Line 366...
293
				</ul>
366
		
294
		
367
			
295
			
368
	</div>
296
	</div>
369
<a name="methodpreTraiterDonnees" id="preTraiterDonnees"><!-- --></a>
297
<a name="methodgetVue" id="getVue"><!-- --></a>
370
<div class="evenrow">
298
<div class="oddrow">
371
	
299
	
372
	<div class="method-header">
Line 300... Line 373...
300
	<div class="method-header">
373
		<span class="method-title">preTraiterDonnees</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Controleur.php.html#a118">118</a></span>)
301
		<span class="method-title">getVue</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Controleur.php.html#a86">86</a></span>)
374
	</div> 
302
	</div> 
-
 
303
	
-
 
304
	<!-- ========== Info from phpDoc block ========= -->
-
 
305
<p class="short-description">Fonction prenant en paramètre le nom d'un squelette et un tableau associatif de données,  en extrait les variables, charge le squelette et retourne le résultat des deux combinés.</p>
375
	
306
	<ul class="tags">
376
	<!-- ========== Info from phpDoc block ========= -->
-
 
377
<p class="short-description">Fonction prenant en paramètre un tableau de données et effectuant un traitement dessus.</p>
-
 
378
<p class="description"><p>Cette fonction est à surcharger dans les classes filles pour automatiser un traitement  avant chaque chargement de vue.</p></p>
-
 
379
	<ul class="tags">
307
				<li><span class="field">return:</span> false si la vue n'existe pas, sinon la chaine résultat.</li>
380
				<li><span class="field">return:</span> Le tableau de données traité</li>
Line 308... Line 381...
308
				<li><span class="field">access:</span> protected</li>
381
				<li><span class="field">access:</span> protected</li>
Line 309... Line 382...
309
			</ul>
382
			</ul>
310
	
383
	
Line 311... Line 384...
311
	<div class="method-signature">
384
	<div class="method-signature">
312
		<span class="method-result">boolean</span>
385
		<span class="method-result">Array</span>
313
		<span class="method-name">
386
		<span class="method-name">
314
			getVue
387
			preTraiterDonnees
315
		</span>
388
		</span>
316
					(<span class="var-type">String</span>&nbsp;<span class="var-name">$nom_squelette</span>, [<span class="var-type">Array</span>&nbsp;<span class="var-name">$donnees</span> = <span class="var-default">array()</span>])
389
					(<span class="var-type"></span>&nbsp;<span class="var-name">&$donnees</span>, <span class="var-type">Array</span>&nbsp;<span class="var-name">$donnees</span>)