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 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 
  <html xmlns="http://www.w3.org/1999/xhtml">
3 
		<head>
4 
			<!-- template designed by Marco Von Ballmoos  -->
5 
			<title>Docs For Class Controleur</title>
6 
			<meta http-equiv='Content-Type' content='text/html; charset=UTF-8'/>
7 
			<link rel="stylesheet" href="../media/stylesheet.css" />
8 
						<script src="../media/lib/classTree.js"></script>
9 
												<script language="javascript" type="text/javascript">
10 
				var imgPlus = new Image();
11 
				var imgMinus = new Image();
12 
				imgPlus.src = "../media/images/plus.png";
13 
				imgMinus.src = "../media/images/minus.png";
14 
 
15 
				function showNode(Node){
16 
							switch(navigator.family){
17 
								case 'nn4':
18 
									// Nav 4.x code fork...
19 
							var oTable = document.layers["span" + Node];
20 
							var oImg = document.layers["img" + Node];
21 
									break;
22 
								case 'ie4':
23 
									// IE 4/5 code fork...
24 
							var oTable = document.all["span" + Node];
25 
							var oImg = document.all["img" + Node];
26 
									break;
27 
								case 'gecko':
28 
									// Standards Compliant code fork...
29 
							var oTable = document.getElementById("span" + Node);
30 
							var oImg = document.getElementById("img" + Node);
31 
									break;
32 
							}
33 
					oImg.src = imgMinus.src;
34 
					oTable.style.display = "block";
35 
				}
36 
 
37 
				function hideNode(Node){
38 
							switch(navigator.family){
39 
								case 'nn4':
40 
									// Nav 4.x code fork...
41 
							var oTable = document.layers["span" + Node];
42 
							var oImg = document.layers["img" + Node];
43 
									break;
44 
								case 'ie4':
45 
									// IE 4/5 code fork...
46 
							var oTable = document.all["span" + Node];
47 
							var oImg = document.all["img" + Node];
48 
									break;
49 
								case 'gecko':
50 
									// Standards Compliant code fork...
51 
							var oTable = document.getElementById("span" + Node);
52 
							var oImg = document.getElementById("img" + Node);
53 
									break;
54 
							}
55 
					oImg.src = imgPlus.src;
56 
					oTable.style.display = "none";
57 
				}
58 
 
59 
				function nodeIsVisible(Node){
60 
							switch(navigator.family){
61 
								case 'nn4':
62 
									// Nav 4.x code fork...
63 
							var oTable = document.layers["span" + Node];
64 
									break;
65 
								case 'ie4':
66 
									// IE 4/5 code fork...
67 
							var oTable = document.all["span" + Node];
68 
									break;
69 
								case 'gecko':
70 
									// Standards Compliant code fork...
71 
							var oTable = document.getElementById("span" + Node);
72 
									break;
73 
							}
74 
					return (oTable && oTable.style.display == "block");
75 
				}
76 
 
77 
				function toggleNodeVisibility(Node){
78 
					if (nodeIsVisible(Node)){
79 
						hideNode(Node);
80 
					}else{
81 
						showNode(Node);
82 
					}
83 
				}
84 
			</script>
85 
					</head>
86 
		<body>
87 
			<div class="page-body">
88 
<h2 class="class-name">Class Controleur</h2>
89 
 
90 
<a name="sec-description"></a>
91 
<div class="info-box">
92 
	<div class="info-box-title">Description</div>
93 
	<div class="nav-bar">
94 
					<span class="disabled">Description</span> |
297 jpm 95 
													<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>)
159 jpm 97 
 
98 
					</div>
99 
	<div class="info-box-body">
100 
        		<!-- ========== 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="description"><p>Elle est abstraite donc doit obligatoirement être étendue.</p></p>
103 
	<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> Aurélien PERONNET &lt;<a href="mailto:aurelien@tela-botanica.org">aurelien@tela-botanica.org</a>&gt;</li>
297 jpm 106 
				<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> Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)</li>
159 jpm 108 
				<li><span class="field">link:</span> /doc/framework/</li>
109 
				<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.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL</a></li>
112 
			</ul>
113 
		<p class="notes">
114 
			Located in <a class="field" href="_Controleur.php.html">/Controleur.php</a> (line <span class="field"><a href="../__filesource/fsource_Framework__Controleur.php.html#a19">19</a></span>)
115 
		</p>
116 
 
117 
 
118 
		<pre></pre>
119 
 
120 
			</div>
121 
</div>
122 
 
123 
 
124 
 
297 jpm 125 
	<a name="sec-var-summary"></a>
126 
	<div class="info-box">
127 
		<div class="info-box-title">Variable Summary</span></div>
128 
		<div class="nav-bar">
129 
			<a href="#sec-description">Description</a> |
130 
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
131 
							|
132 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
133 
 
134 
								</div>
135 
		<div class="info-box-body">
136 
			<div class="var-summary">
137 
																								<div class="var-title">
138 
					<span class="var-type">mixed</span>
139 
					<a href="#$parametres_obligatoires" title="details" class="var-name">$parametres_obligatoires</a>
140 
				</div>
141 
											</div>
142 
		</div>
143 
	</div>
159 jpm 144 
 
145 
	<a name="sec-method-summary"></a>
146 
	<div class="info-box">
147 
		<div class="info-box-title">Method Summary</span></div>
148 
		<div class="nav-bar">
149 
			<a href="#sec-description">Description</a> |
297 jpm 150 
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
151 
 
152 
				|
153 
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
159 jpm 154 
		</div>
155 
		<div class="info-box-body">
156 
			<div class="method-summary">
157 
 
158 
				<div class="method-definition">
159 
											<span class="method-result">Controleur</span>
160 
										<a href="#__construct" title="details" class="method-name">__construct</a>
161 
										()
162 
									</div>
163 
 
164 
				<div class="method-definition">
165 
											<span class="method-result">boolean</span>
166 
										<a href="#chargerModele" title="details" class="method-name">chargerModele</a>
167 
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$nom_modele</span>)
168 
									</div>
169 
 
170 
				<div class="method-definition">
171 
											<span class="method-result">mixed</span>
172 
										<a href="#getModele" title="details" class="method-name">getModele</a>
297 jpm 173 
											(<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>])
159 jpm 174 
									</div>
175 
 
176 
				<div class="method-definition">
177 
											<span class="method-result">boolean</span>
178 
										<a href="#getVue" title="details" class="method-name">getVue</a>
297 jpm 179 
											(<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>)
159 jpm 180 
									</div>
297 jpm 181 
 
182 
				<div class="method-definition">
183 
											<span class="method-result">Array</span>
184 
										<a href="#preTraiterDonnees" title="details" class="method-name">preTraiterDonnees</a>
185 
											(<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>)
186 
									</div>
159 jpm 187 
											</div>
188 
		</div>
189 
	</div>
190 
 
297 jpm 191 
	<a name="sec-vars"></a>
192 
	<div class="info-box">
193 
		<div class="info-box-title">Variables</div>
194 
		<div class="nav-bar">
195 
			<a href="#sec-description">Description</a> |
196 
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
197 
 
198 
 
199 
										|
200 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
201 
 
202 
					</div>
203 
		<div class="info-box-body">
204 
 
205 
<a name="var$parametres_obligatoires" id="$parametres_obligatoires"><!-- --></A>
206 
<div class="oddrow">
207 
 
208 
	<div class="var-header">
209 
		<span class="var-title">
210 
			<span class="var-type">mixed</span>
211 
			<span class="var-name">$parametres_obligatoires</span>
212 
			 = <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>)
213 
		</span>
214 
	</div>
215 
 
216 
	<!-- ========== Info from phpDoc block ========= -->
217 
<p class="short-description">Tableau des noms des paramètres à définir dans le fichier de config car obligatoirement nécessaire à cette classe.</p>
218 
	<ul class="tags">
219 
				<li><span class="field">access:</span> protected</li>
220 
			</ul>
159 jpm 221 
 
297 jpm 222 
 
223 
 
224 
 
225 
 
226 
</div>
227 
 
228 
		</div>
229 
	</div>
230 
 
159 jpm 231 
	<a name="sec-methods"></a>
232 
	<div class="info-box">
233 
		<div class="info-box-title">Methods</div>
234 
		<div class="nav-bar">
235 
			<a href="#sec-description">Description</a> |
297 jpm 236 
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
237 
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
159 jpm 238 
 
239 
		</div>
240 
		<div class="info-box-body">
241 
			<A NAME='method_detail'></A>
242 
<a name="method__construct" id="__construct"><!-- --></a>
297 jpm 243 
<div class="evenrow">
159 jpm 244 
 
245 
	<div class="method-header">
297 jpm 246 
		<span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Controleur.php.html#a41">41</a></span>)
159 jpm 247 
	</div>
248 
 
249 
	<!-- ========== Info from phpDoc block ========= -->
250 
<p class="short-description">Constructeur par défaut</p>
251 
	<ul class="tags">
252 
				<li><span class="field">access:</span> public</li>
253 
			</ul>
254 
 
255 
	<div class="method-signature">
256 
		<span class="method-result">Controleur</span>
257 
		<span class="method-name">
258 
			__construct
259 
		</span>
260 
				()
261 
			</div>
262 
 
263 
 
264 
 
265 
	</div>
266 
<a name="methodchargerModele" id="chargerModele"><!-- --></a>
297 jpm 267 
<div class="oddrow">
159 jpm 268 
 
269 
	<div class="method-header">
297 jpm 270 
		<span class="method-title">chargerModele</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Controleur.php.html#a56">56</a></span>)
159 jpm 271 
	</div>
272 
 
273 
	<!-- ========== Info from phpDoc block ========= -->
274 
<p class="short-description">Charge un modele donné et le rend disponible sous la forme $this-&gt;nom_modele</p>
275 
	<ul class="tags">
276 
				<li><span class="field">return:</span> false si le chargement a échoué, sinon true.</li>
297 jpm 277 
				<li><span class="field">access:</span> public</li>
159 jpm 278 
			</ul>
279 
 
280 
	<div class="method-signature">
281 
		<span class="method-result">boolean</span>
282 
		<span class="method-name">
283 
			chargerModele
284 
		</span>
285 
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$nom_modele</span>)
286 
			</div>
287 
 
288 
			<ul class="parameters">
289 
					<li>
290 
				<span class="var-type">string</span>
297 jpm 291 
				<span class="var-name">$nom_modele</span><span class="var-description">: le nom du modèle à  charger</span>			</li>
159 jpm 292 
				</ul>
293 
 
294 
 
295 
	</div>
297 jpm 296 
<a name="methodgetModele" id="getModele"><!-- --></a>
297 
<div class="evenrow">
159 jpm 298 
 
299 
	<div class="method-header">
297 jpm 300 
		<span class="method-title">getModele</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Controleur.php.html#a77">77</a></span>)
159 jpm 301 
	</div>
302 
 
303 
	<!-- ========== Info from phpDoc block ========= -->
297 jpm 304 
<p class="short-description">Retourne un modele donné</p>
159 jpm 305 
	<ul class="tags">
297 jpm 306 
				<li><span class="field">return:</span> false si le chargement a échoué, sinon l'objet du modèle demandé.</li>
159 jpm 307 
				<li><span class="field">access:</span> protected</li>
308 
			</ul>
309 
 
310 
	<div class="method-signature">
297 jpm 311 
		<span class="method-result">mixed</span>
159 jpm 312 
		<span class="method-name">
297 jpm 313 
			getModele
159 jpm 314 
		</span>
297 jpm 315 
					(<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>])
159 jpm 316 
			</div>
317 
 
318 
			<ul class="parameters">
319 
					<li>
297 jpm 320 
				<span class="var-type">string</span>
321 
				<span class="var-name">$nom_modele</span><span class="var-description">: le nom du fichier modèle à charger sans son extension</span>			</li>
322 
					<li>
159 jpm 323 
				<span class="var-type">String</span>
297 jpm 324 
				<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>
159 jpm 325 
				</ul>
326 
 
327 
 
328 
	</div>
297 jpm 329 
<a name="methodgetVue" id="getVue"><!-- --></a>
330 
<div class="oddrow">
159 jpm 331 
 
332 
	<div class="method-header">
297 jpm 333 
		<span class="method-title">getVue</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Controleur.php.html#a100">100</a></span>)
159 jpm 334 
	</div>
335 
 
336 
	<!-- ========== Info from phpDoc block ========= -->
297 jpm 337 
<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>
159 jpm 338 
	<ul class="tags">
297 jpm 339 
				<li><span class="field">return:</span> false si la vue n'existe pas, sinon la chaine résultat.</li>
159 jpm 340 
				<li><span class="field">access:</span> protected</li>
341 
			</ul>
342 
 
343 
	<div class="method-signature">
297 jpm 344 
		<span class="method-result">boolean</span>
159 jpm 345 
		<span class="method-name">
297 jpm 346 
			getVue
159 jpm 347 
		</span>
297 jpm 348 
					(<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>)
159 jpm 349 
			</div>
350 
 
351 
			<ul class="parameters">
352 
					<li>
297 jpm 353 
				<span class="var-type">String</span>
354 
				<span class="var-name">$nom_squelette</span><span class="var-description">: le nom du squelette sans son extension</span>			</li>
355 
					<li>
356 
				<span class="var-type">Array</span>
357 
				<span class="var-name">$donnees</span><span class="var-description">: un tableau associatif contenant les variables a injecter dans la vue</span>			</li>
358 
					<li>
359 
				<span class="var-type">String</span>
360 
				<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>
361 
					<li>
362 
				<span class="var-type"></span>
363 
				<span class="var-name">&$donnees</span>			</li>
159 jpm 364 
				</ul>
365 
 
366 
 
367 
	</div>
297 jpm 368 
<a name="methodpreTraiterDonnees" id="preTraiterDonnees"><!-- --></a>
369 
<div class="evenrow">
159 jpm 370 
 
371 
	<div class="method-header">
297 jpm 372 
		<span class="method-title">preTraiterDonnees</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Controleur.php.html#a118">118</a></span>)
159 jpm 373 
	</div>
374 
 
375 
	<!-- ========== Info from phpDoc block ========= -->
297 jpm 376 
<p class="short-description">Fonction prenant en paramètre un tableau de données et effectuant un traitement dessus.</p>
377 
<p class="description"><p>Cette fonction est à surcharger dans les classes filles pour automatiser un traitement  avant chaque chargement de vue.</p></p>
159 jpm 378 
	<ul class="tags">
297 jpm 379 
				<li><span class="field">return:</span> Le tableau de données traité</li>
159 jpm 380 
				<li><span class="field">access:</span> protected</li>
381 
			</ul>
382 
 
383 
	<div class="method-signature">
297 jpm 384 
		<span class="method-result">Array</span>
159 jpm 385 
		<span class="method-name">
297 jpm 386 
			preTraiterDonnees
159 jpm 387 
		</span>
297 jpm 388 
					(<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>)
159 jpm 389 
			</div>
390 
 
391 
			<ul class="parameters">
392 
					<li>
297 jpm 393 
				<span class="var-type">Array</span>
394 
				<span class="var-name">$donnees</span><span class="var-description">: Le tableau de données à traiter</span>			</li>
159 jpm 395 
					<li>
297 jpm 396 
				<span class="var-type"></span>
397 
				<span class="var-name">&$donnees</span>			</li>
159 jpm 398 
				</ul>
399 
 
400 
 
401 
	</div>
402 
 
403 
		</div>
404 
	</div>
405 
 
406 
 
407 
	<p class="notes" id="credit">
302 jpm 408 
		Documentation generated on Tue, 18 Jan 2011 15:30:47 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
159 jpm 409 
	</p>
410 
	</div></body>
411 
</html>