Subversion Repositories Applications.framework

Rev

Rev 300 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
159 jpm 1
<html>
2
<head>
3
<title>Docs For Class Controleur</title>
4
<meta http-equiv='Content-Type' content='text/html; charset=UTF-8'/>
5
<link rel="stylesheet" type="text/css" href="../media/style.css">
6
</head>
7
<body>
8
 
9
<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
10
  <tr>
11
    <td class="header_top">Framework</td>
12
  </tr>
13
  <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
14
  <tr>
15
    <td class="header_menu">
16
 
17
 
297 jpm 18
                                                                      		  [ <a href="../classtrees_Framework.html" class="menu">class tree: Framework</a> ]
159 jpm 19
		  [ <a href="../elementindex_Framework.html" class="menu">index: Framework</a> ]
20
		  	    [ <a href="../elementindex.html" class="menu">all elements</a> ]
21
    </td>
22
  </tr>
23
  <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
24
</table>
25
 
26
<table width="100%" border="0" cellpadding="0" cellspacing="0">
27
  <tr valign="top">
28
    <td width="200" class="menu">
297 jpm 29
	<div id="todolist">
30
			<p><a href="../todolist.html">Todo List</a></p>
31
	</div>
159 jpm 32
      <b>Packages:</b><br />
33
              <a href="../li_Framework.html">Framework</a><br />
297 jpm 34
              <a href="../li_Utilitaire.html">Utilitaire</a><br />
35
              <a href="../li_Zend_OpenId.html">Zend_OpenId</a><br />
159 jpm 36
            <br /><br />
37
                        <b>Files:</b><br />
38
      	  <div class="package">
297 jpm 39
			<a href="../Framework/_Bdd.php.html">		Bdd.php
159 jpm 40
		</a><br>
297 jpm 41
			<a href="../Framework/_Cache.php.html">		Cache.php
159 jpm 42
		</a><br>
297 jpm 43
			<a href="../Framework/_CacheFichier.php.html">		CacheFichier.php
44
		</a><br>
45
			<a href="../Framework/_CacheSimple.php.html">		CacheSimple.php
46
		</a><br>
47
			<a href="../Framework/_CacheSqlite.php.html">		CacheSqlite.php
48
		</a><br>
159 jpm 49
			<a href="../Framework/_Chronometre.php.html">		Chronometre.php
50
		</a><br>
297 jpm 51
			<a href="../Framework/_Cli.php.html">		Cli.php
52
		</a><br>
159 jpm 53
			<a href="../Framework/_Config.php.html">		Config.php
54
		</a><br>
55
			<a href="../Framework/_Controleur.php.html">		Controleur.php
56
		</a><br>
57
			<a href="../Framework/_Debug.php.html">		Debug.php
58
		</a><br>
297 jpm 59
			<a href="../Framework/_utilitaires---DiffieHellmanUtil.php.html">		DiffieHellmanUtil.php
60
		</a><br>
61
			<a href="../Framework/_Framework.php.html">		Framework.php
62
		</a><br>
159 jpm 63
			<a href="../Framework/_GestionnaireException.php.html">		GestionnaireException.php
64
		</a><br>
297 jpm 65
			<a href="../Framework/_I18n.php.html">		I18n.php
66
		</a><br>
159 jpm 67
			<a href="../Framework/_Log.php.html">		Log.php
68
		</a><br>
297 jpm 69
			<a href="../Framework/_OpenIdClient.php.html">		OpenIdClient.php
159 jpm 70
		</a><br>
71
			<a href="../Framework/_Registre.php.html">		Registre.php
72
		</a><br>
297 jpm 73
			<a href="../Framework/_RestClient.php.html">		RestClient.php
74
		</a><br>
75
			<a href="../Framework/_RestServeur.php.html">		RestServeur.php
76
		</a><br>
77
			<a href="../Framework/_RestService.php.html">		RestService.php
78
		</a><br>
79
			<a href="../Framework/_Script.php.html">		Script.php
80
		</a><br>
159 jpm 81
			<a href="../Framework/_SquelettePhp.php.html">		SquelettePhp.php
82
		</a><br>
83
			<a href="../Framework/_Url.php.html">		Url.php
84
		</a><br>
85
	  </div><br />
86
 
87
 
88
            <b>Classes:</b><br />
89
        <div class="package">
297 jpm 90
		    		<a href="../Framework/Bdd.html">Bdd</a><br />
91
	    		<a href="../Framework/Cache.html">Cache</a><br />
92
	    		<a href="../Framework/CacheFichier.html">CacheFichier</a><br />
93
	    		<a href="../Framework/CacheSimple.html">CacheSimple</a><br />
94
	    		<a href="../Framework/CacheSqlite.html">CacheSqlite</a><br />
159 jpm 95
	    		<a href="../Framework/Chronometre.html">Chronometre</a><br />
297 jpm 96
	    		<a href="../Framework/Cli.html">Cli</a><br />
159 jpm 97
	    		<a href="../Framework/Config.html">Config</a><br />
98
	    		<a href="../Framework/Controleur.html">Controleur</a><br />
99
	    		<a href="../Framework/Debug.html">Debug</a><br />
297 jpm 100
	    		<a href="../Framework/DiffieHellmanUtil.html">DiffieHellmanUtil</a><br />
101
	    		<a href="../Framework/Framework.html">Framework</a><br />
159 jpm 102
	    		<a href="../Framework/GestionnaireException.html">GestionnaireException</a><br />
297 jpm 103
	    		<a href="../Framework/I18n.html">I18n</a><br />
159 jpm 104
	    		<a href="../Framework/Log.html">Log</a><br />
297 jpm 105
	    		<a href="../Framework/OpenIdClient.html">OpenIdClient</a><br />
159 jpm 106
	    		<a href="../Framework/Registre.html">Registre</a><br />
297 jpm 107
	    		<a href="../Framework/RestClient.html">RestClient</a><br />
108
	    		<a href="../Framework/RestServeur.html">RestServeur</a><br />
109
	    		<a href="../Framework/RestService.html">RestService</a><br />
110
	    		<a href="../Framework/Script.html">Script</a><br />
159 jpm 111
	    		<a href="../Framework/SquelettePhp.html">SquelettePhp</a><br />
112
	    		<a href="../Framework/Url.html">Url</a><br />
113
	  </div>
114
                </td>
115
    <td>
116
      <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">
117
 
118
<h1>Class: Controleur</h1>
119
Source Location: /Controleur.php<br /><br />
120
 
121
 
122
<table width="100%" border="0">
123
<tr><td valign="top">
124
 
125
<h3><a href="#class_details">Class Overview</a></h3>
126
<pre></pre><br />
127
<div class="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.</div><br /><br />
128
<h4>Author(s):</h4>
129
<ul>
130
          <li>Jean-Pascal MILCENT &lt;<a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a>&gt;</li>
131
              <li>Aurélien PERONNET &lt;<a href="mailto:aurelien@tela-botanica.org">aurelien@tela-botanica.org</a>&gt;</li>
132
                                          </ul>
133
 
134
 
135
 
136
 
137
 
138
 
139
 
140
<h4>Version:</h4>
141
<ul>
297 jpm 142
  <li>$Id: Controleur.php 241 2010-12-06 15:19:07Z jpm $</li>
159 jpm 143
</ul>
144
 
145
<h4>Copyright:</h4>
146
<ul>
297 jpm 147
  <li>Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)</li>
159 jpm 148
</ul>
149
 
150
</td>
151
 
297 jpm 152
<td valign="top">
153
<h3><a href="#class_vars">Variables</a></h3>
154
<ul>
155
    <li><a href="../Framework/Controleur.html#var$parametres_obligatoires">$parametres_obligatoires</a></li>
156
  </ul>
157
</td>
159 jpm 158
 
159
 
160
<td valign="top">
161
<h3><a href="#class_methods">Methods</a></h3>
162
<ul>
163
    <li><a href="../Framework/Controleur.html#method__construct">__construct</a></li>
164
    <li><a href="../Framework/Controleur.html#methodchargerModele">chargerModele</a></li>
165
    <li><a href="../Framework/Controleur.html#methodgetModele">getModele</a></li>
166
    <li><a href="../Framework/Controleur.html#methodgetVue">getVue</a></li>
297 jpm 167
    <li><a href="../Framework/Controleur.html#methodpreTraiterDonnees">preTraiterDonnees</a></li>
159 jpm 168
  </ul>
169
</td>
170
 
171
</tr></table>
172
<hr />
173
 
174
<table width="100%" border="0"><tr>
175
 
176
 
177
 
178
 
179
 
180
 
181
</tr></table>
182
<hr />
183
 
184
<a name="class_details"></a>
185
<h3>Class Details</h3>
186
<div class="tags">
187
[line <a href="../__filesource/fsource_Framework__Controleur.php.html#a19">19</a>]<br />
188
Classe Controleur, coeur d'une application, c'est normalement la seule classe d'une application  qui devrait être appelée de l'extérieur.<br /><br /><p>Elle est abstraite donc doit obligatoirement être étendue.</p><br /><br /><br />
189
<h4>Tags:</h4>
190
<div class="tags">
191
<table border="0" cellspacing="0" cellpadding="0">
192
  <tr>
193
    <td><b>author:</b>&nbsp;&nbsp;</td><td>Jean-Pascal MILCENT &lt;<a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a>&gt;</td>
194
  </tr>
195
  <tr>
196
    <td><b>author:</b>&nbsp;&nbsp;</td><td>Aurélien PERONNET &lt;<a href="mailto:aurelien@tela-botanica.org">aurelien@tela-botanica.org</a>&gt;</td>
197
  </tr>
198
  <tr>
297 jpm 199
    <td><b>version:</b>&nbsp;&nbsp;</td><td>$Id: Controleur.php 241 2010-12-06 15:19:07Z jpm $</td>
159 jpm 200
  </tr>
201
  <tr>
297 jpm 202
    <td><b>copyright:</b>&nbsp;&nbsp;</td><td>Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)</td>
159 jpm 203
  </tr>
204
  <tr>
205
    <td><b>link:</b>&nbsp;&nbsp;</td><td>/doc/framework/</td>
206
  </tr>
207
  <tr>
208
    <td><b>abstract:</b>&nbsp;&nbsp;</td><td></td>
209
  </tr>
210
  <tr>
211
    <td><b>license:</b>&nbsp;&nbsp;</td><td><a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL</a></td>
212
  </tr>
213
  <tr>
214
    <td><b>license:</b>&nbsp;&nbsp;</td><td><a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL</a></td>
215
  </tr>
216
</table>
217
</div>
218
</div><br /><br />
219
<div class="top">[ <a href="#top">Top</a> ]</div><br />
220
 
297 jpm 221
<hr />
222
<a name="class_vars"></a>
223
<h3>Class Variables</h3>
224
<div class="tags">
225
	<a name="var$parametres_obligatoires"></a>
226
	<p></p>
227
	<h4>$parametres_obligatoires = <span class="value">array('chemin_modeles',&nbsp;'chemin_squelettes',&nbsp;'chemin_controleurs',&nbsp;'base_url_application')</span></h4>
228
	<p>[line <a href="../__filesource/fsource_Framework__Controleur.php.html#a36">36</a>]</p>
229
  Tableau des noms des paramètres à définir dans le fichier de config car obligatoirement nécessaire à cette classe.<br /><br /><br /><br />
230
<h4>Tags:</h4>
231
<div class="tags">
232
<table border="0" cellspacing="0" cellpadding="0">
233
  <tr>
234
    <td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
235
  </tr>
236
</table>
237
</div>
159 jpm 238
 
297 jpm 239
  <br />
240
	<div class="tags">
241
  <table border="0" cellspacing="0" cellpadding="0">
242
    <tr>
243
      <td><b>Type:</b>&nbsp;&nbsp;</td>
244
      <td>mixed</td>
245
    </tr>
246
      </table>
247
	</div><br /><br />
248
	<div class="top">[ <a href="#top">Top</a> ]</div><br />
249
</div><br />
250
 
159 jpm 251
<hr />
252
<a name="class_methods"></a>
253
<h3>Class Methods</h3>
254
<div class="tags">
255
 
256
  <hr />
257
	<a name="method__construct"></a>
297 jpm 258
	<h3>constructor __construct <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Controleur.php.html#a41">41</a>]</span></h3>
159 jpm 259
	<div class="function">
260
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
261
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
262
		<code>Controleur __construct(
263
)</code>
264
    </td></tr></table>
265
    </td></tr></table><br />
266
 
267
		Constructeur par défaut<br /><br /><br /><br />
268
<h4>Tags:</h4>
269
<div class="tags">
270
<table border="0" cellspacing="0" cellpadding="0">
271
  <tr>
272
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
273
  </tr>
274
</table>
275
</div>
276
<br /><br />
277
 
278
 
279
        <div class="top">[ <a href="#top">Top</a> ]</div>
280
  </div>
281
  <hr />
282
	<a name="methodchargerModele"></a>
297 jpm 283
	<h3>method chargerModele <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Controleur.php.html#a56">56</a>]</span></h3>
159 jpm 284
	<div class="function">
285
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
286
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
287
		<code>boolean chargerModele(
288
string
289
$nom_modele)</code>
290
    </td></tr></table>
291
    </td></tr></table><br />
292
 
293
		Charge un modele donné et le rend disponible sous la forme $this-&gt;nom_modele<br /><br /><br /><br />
294
<h4>Tags:</h4>
295
<div class="tags">
296
<table border="0" cellspacing="0" cellpadding="0">
297
  <tr>
298
    <td><b>return:</b>&nbsp;&nbsp;</td><td>false si le chargement a échoué, sinon true.</td>
299
  </tr>
300
  <tr>
297 jpm 301
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
159 jpm 302
  </tr>
303
</table>
304
</div>
305
<br /><br />
306
 
307
 
308
        <h4>Parameters:</h4>
309
    <div class="tags">
310
    <table border="0" cellspacing="0" cellpadding="0">
311
          <tr>
312
        <td class="type">string&nbsp;&nbsp;</td>
313
        <td><b>$nom_modele</b>&nbsp;&nbsp;</td>
297 jpm 314
        <td>le nom du modèle à  charger</td>
159 jpm 315
      </tr>
316
        </table>
317
    </div><br />
318
        <div class="top">[ <a href="#top">Top</a> ]</div>
319
  </div>
320
  <hr />
297 jpm 321
	<a name="methodgetModele"></a>
322
	<h3>method getModele <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Controleur.php.html#a77">77</a>]</span></h3>
159 jpm 323
	<div class="function">
324
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
325
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
297 jpm 326
		<code>mixed getModele(
327
string
328
$nom_modele, [String
329
$ext = '.php'])</code>
159 jpm 330
    </td></tr></table>
331
    </td></tr></table><br />
332
 
297 jpm 333
		Retourne un modele donné<br /><br /><br /><br />
159 jpm 334
<h4>Tags:</h4>
335
<div class="tags">
336
<table border="0" cellspacing="0" cellpadding="0">
337
  <tr>
297 jpm 338
    <td><b>return:</b>&nbsp;&nbsp;</td><td>false si le chargement a échoué, sinon l'objet du modèle demandé.</td>
159 jpm 339
  </tr>
340
  <tr>
341
    <td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
342
  </tr>
343
</table>
344
</div>
345
<br /><br />
346
 
347
 
348
        <h4>Parameters:</h4>
349
    <div class="tags">
350
    <table border="0" cellspacing="0" cellpadding="0">
351
          <tr>
297 jpm 352
        <td class="type">string&nbsp;&nbsp;</td>
353
        <td><b>$nom_modele</b>&nbsp;&nbsp;</td>
354
        <td>le nom du fichier modèle à charger sans son extension</td>
159 jpm 355
      </tr>
356
          <tr>
297 jpm 357
        <td class="type">String&nbsp;&nbsp;</td>
358
        <td><b>$ext</b>&nbsp;&nbsp;</td>
359
        <td>l'extension du fichier du modèel (par défaut : &quot;.php&quot;</td>
159 jpm 360
      </tr>
361
        </table>
362
    </div><br />
363
        <div class="top">[ <a href="#top">Top</a> ]</div>
364
  </div>
365
  <hr />
297 jpm 366
	<a name="methodgetVue"></a>
367
	<h3>method getVue <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Controleur.php.html#a100">100</a>]</span></h3>
159 jpm 368
	<div class="function">
369
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
370
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
297 jpm 371
		<code>boolean getVue(
372
String
373
$nom_squelette, [
374
&$donnees = array()], [String
375
$ext = '.tpl.html'], Array
376
$donnees)</code>
159 jpm 377
    </td></tr></table>
378
    </td></tr></table><br />
379
 
297 jpm 380
		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.<br /><br /><br /><br />
159 jpm 381
<h4>Tags:</h4>
382
<div class="tags">
383
<table border="0" cellspacing="0" cellpadding="0">
384
  <tr>
297 jpm 385
    <td><b>return:</b>&nbsp;&nbsp;</td><td>false si la vue n'existe pas, sinon la chaine résultat.</td>
159 jpm 386
  </tr>
387
  <tr>
388
    <td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
389
  </tr>
390
</table>
391
</div>
392
<br /><br />
393
 
394
 
395
        <h4>Parameters:</h4>
396
    <div class="tags">
397
    <table border="0" cellspacing="0" cellpadding="0">
398
          <tr>
297 jpm 399
        <td class="type">String&nbsp;&nbsp;</td>
400
        <td><b>$nom_squelette</b>&nbsp;&nbsp;</td>
401
        <td>le nom du squelette sans son extension</td>
159 jpm 402
      </tr>
297 jpm 403
          <tr>
404
        <td class="type">Array&nbsp;&nbsp;</td>
405
        <td><b>$donnees</b>&nbsp;&nbsp;</td>
406
        <td>un tableau associatif contenant les variables a injecter dans la vue</td>
407
      </tr>
408
          <tr>
409
        <td class="type">String&nbsp;&nbsp;</td>
410
        <td><b>$ext</b>&nbsp;&nbsp;</td>
411
        <td>l'extension du fichier du squelette (par défaut : &quot;.tpl.html&quot;</td>
412
      </tr>
413
          <tr>
414
        <td class="type">&nbsp;&nbsp;</td>
415
        <td><b>&$donnees</b>&nbsp;&nbsp;</td>
416
        <td></td>
417
      </tr>
159 jpm 418
        </table>
419
    </div><br />
420
        <div class="top">[ <a href="#top">Top</a> ]</div>
421
  </div>
422
  <hr />
297 jpm 423
	<a name="methodpreTraiterDonnees"></a>
424
	<h3>method preTraiterDonnees <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Controleur.php.html#a118">118</a>]</span></h3>
159 jpm 425
	<div class="function">
426
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
427
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
297 jpm 428
		<code>Array preTraiterDonnees(
429
 
430
&$donnees, Array
431
$donnees)</code>
159 jpm 432
    </td></tr></table>
433
    </td></tr></table><br />
434
 
297 jpm 435
		Fonction prenant en paramètre un tableau de données et effectuant un traitement dessus.<br /><br /><p>Cette fonction est à surcharger dans les classes filles pour automatiser un traitement  avant chaque chargement de vue.</p><br /><br /><br />
159 jpm 436
<h4>Tags:</h4>
437
<div class="tags">
438
<table border="0" cellspacing="0" cellpadding="0">
439
  <tr>
297 jpm 440
    <td><b>return:</b>&nbsp;&nbsp;</td><td>Le tableau de données traité</td>
159 jpm 441
  </tr>
442
  <tr>
443
    <td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
444
  </tr>
445
</table>
446
</div>
447
<br /><br />
448
 
449
 
450
        <h4>Parameters:</h4>
451
    <div class="tags">
452
    <table border="0" cellspacing="0" cellpadding="0">
453
          <tr>
454
        <td class="type">Array&nbsp;&nbsp;</td>
455
        <td><b>$donnees</b>&nbsp;&nbsp;</td>
297 jpm 456
        <td>Le tableau de données à traiter</td>
159 jpm 457
      </tr>
297 jpm 458
          <tr>
459
        <td class="type">&nbsp;&nbsp;</td>
460
        <td><b>&$donnees</b>&nbsp;&nbsp;</td>
461
        <td></td>
462
      </tr>
159 jpm 463
        </table>
464
    </div><br />
465
        <div class="top">[ <a href="#top">Top</a> ]</div>
466
  </div>
467
</div><br />
468
 
469
 
470
        <div class="credit">
471
		    <hr />
302 jpm 472
		    Documentation generated on Tue, 18 Jan 2011 15:31:15 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.3</a>
159 jpm 473
	      </div>
474
      </td></tr></table>
475
    </td>
476
  </tr>
477
</table>
478
 
479
</body>
480
</html>