Subversion Repositories Applications.framework

Rev

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

Rev Author Line No. Line
159 jpm 1 
<?xml version="1.0" encoding="UTF-8"?>
2 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 
  <html xmlns="http://www.w3.org/1999/xhtml">
4 
		<head>
5 
			<!-- template designed by Marco Von Ballmoos  -->
6 
			<title>Docs For Class Controleur</title>
7 
			<meta http-equiv='Content-Type' content='text/html; charset=UTF-8'/>
8 
			<link rel="stylesheet" href="../media/stylesheet.css" />
9 
						<script src="../media/lib/classTree.js"></script>
10 
												<script language="javascript" type="text/javascript">
11 
				var imgPlus = new Image();
12 
				var imgMinus = new Image();
13 
				imgPlus.src = "../media/images/plus.png";
14 
				imgMinus.src = "../media/images/minus.png";
15 
 
16 
				function showNode(Node){
17 
							switch(navigator.family){
18 
								case 'nn4':
19 
									// Nav 4.x code fork...
20 
							var oTable = document.layers["span" + Node];
21 
							var oImg = document.layers["img" + Node];
22 
									break;
23 
								case 'ie4':
24 
									// IE 4/5 code fork...
25 
							var oTable = document.all["span" + Node];
26 
							var oImg = document.all["img" + Node];
27 
									break;
28 
								case 'gecko':
29 
									// Standards Compliant code fork...
30 
							var oTable = document.getElementById("span" + Node);
31 
							var oImg = document.getElementById("img" + Node);
32 
									break;
33 
							}
34 
					oImg.src = imgMinus.src;
35 
					oTable.style.display = "block";
36 
				}
37 
 
38 
				function hideNode(Node){
39 
							switch(navigator.family){
40 
								case 'nn4':
41 
									// Nav 4.x code fork...
42 
							var oTable = document.layers["span" + Node];
43 
							var oImg = document.layers["img" + Node];
44 
									break;
45 
								case 'ie4':
46 
									// IE 4/5 code fork...
47 
							var oTable = document.all["span" + Node];
48 
							var oImg = document.all["img" + Node];
49 
									break;
50 
								case 'gecko':
51 
									// Standards Compliant code fork...
52 
							var oTable = document.getElementById("span" + Node);
53 
							var oImg = document.getElementById("img" + Node);
54 
									break;
55 
							}
56 
					oImg.src = imgPlus.src;
57 
					oTable.style.display = "none";
58 
				}
59 
 
60 
				function nodeIsVisible(Node){
61 
							switch(navigator.family){
62 
								case 'nn4':
63 
									// Nav 4.x code fork...
64 
							var oTable = document.layers["span" + Node];
65 
									break;
66 
								case 'ie4':
67 
									// IE 4/5 code fork...
68 
							var oTable = document.all["span" + Node];
69 
									break;
70 
								case 'gecko':
71 
									// Standards Compliant code fork...
72 
							var oTable = document.getElementById("span" + Node);
73 
									break;
74 
							}
75 
					return (oTable && oTable.style.display == "block");
76 
				}
77 
 
78 
				function toggleNodeVisibility(Node){
79 
					if (nodeIsVisible(Node)){
80 
						hideNode(Node);
81 
					}else{
82 
						showNode(Node);
83 
					}
84 
				}
85 
			</script>
86 
					</head>
87 
		<body>
88 
			<div class="page-body">
89 
<h2 class="class-name">Class Controleur</h2>
90 
 
91 
<a name="sec-description"></a>
92 
<div class="info-box">
93 
	<div class="info-box-title">Description</div>
94 
	<div class="nav-bar">
95 
					<span class="disabled">Description</span> |
297 jpm 96 
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
97 
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
159 jpm 98 
 
99 
					</div>
100 
	<div class="info-box-body">
101 
        		<!-- ========== Info from phpDoc block ========= -->
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>
103 
<p class="description"><p>Elle est abstraite donc doit obligatoirement être étendue.</p></p>
104 
	<ul class="tags">
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>
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>
297 jpm 107 
				<li><span class="field">version:</span> $Id: Controleur.php 241 2010-12-06 15:19:07Z jpm $</li>
108 
				<li><span class="field">copyright:</span> Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)</li>
159 jpm 109 
				<li><span class="field">link:</span> /doc/framework/</li>
110 
				<li><span class="field">abstract:</span> </li>
111 
				<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL</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>
113 
			</ul>
114 
		<p class="notes">
115 
			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>)
116 
		</p>
117 
 
118 
 
119 
		<pre></pre>
120 
 
121 
			</div>
122 
</div>
123 
 
124 
 
125 
 
297 jpm 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>
142 
											</div>
143 
		</div>
144 
	</div>
159 jpm 145 
 
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">
150 
			<a href="#sec-description">Description</a> |
297 jpm 151 
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
152 
 
153 
				|
154 
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
159 jpm 155 
		</div>
156 
		<div class="info-box-body">
157 
			<div class="method-summary">
158 
 
159 
				<div class="method-definition">
160 
											<span class="method-result">Controleur</span>
161 
										<a href="#__construct" title="details" class="method-name">__construct</a>
162 
										()
163 
									</div>
164 
 
165 
				<div class="method-definition">
166 
											<span class="method-result">boolean</span>
167 
										<a href="#chargerModele" title="details" class="method-name">chargerModele</a>
168 
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$nom_modele</span>)
169 
									</div>
170 
 
171 
				<div class="method-definition">
172 
											<span class="method-result">mixed</span>
173 
										<a href="#getModele" title="details" class="method-name">getModele</a>
297 jpm 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>])
159 jpm 175 
									</div>
176 
 
177 
				<div class="method-definition">
178 
											<span class="method-result">boolean</span>
179 
										<a href="#getVue" title="details" class="method-name">getVue</a>
297 jpm 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>)
159 jpm 181 
									</div>
297 jpm 182 
 
183 
				<div class="method-definition">
184 
											<span class="method-result">Array</span>
185 
										<a href="#preTraiterDonnees" title="details" class="method-name">preTraiterDonnees</a>
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>)
187 
									</div>
159 jpm 188 
											</div>
189 
		</div>
190 
	</div>
191 
 
297 jpm 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>
159 jpm 222 
 
297 jpm 223 
 
224 
 
225 
 
226 
 
227 
</div>
228 
 
229 
		</div>
230 
	</div>
231 
 
159 jpm 232 
	<a name="sec-methods"></a>
233 
	<div class="info-box">
234 
		<div class="info-box-title">Methods</div>
235 
		<div class="nav-bar">
236 
			<a href="#sec-description">Description</a> |
297 jpm 237 
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
238 
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
159 jpm 239 
 
240 
		</div>
241 
		<div class="info-box-body">
242 
			<A NAME='method_detail'></A>
243 
<a name="method__construct" id="__construct"><!-- --></a>
297 jpm 244 
<div class="evenrow">
159 jpm 245 
 
246 
	<div class="method-header">
297 jpm 247 
		<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 248 
	</div>
249 
 
250 
	<!-- ========== Info from phpDoc block ========= -->
251 
<p class="short-description">Constructeur par défaut</p>
252 
	<ul class="tags">
253 
				<li><span class="field">access:</span> public</li>
254 
			</ul>
255 
 
256 
	<div class="method-signature">
257 
		<span class="method-result">Controleur</span>
258 
		<span class="method-name">
259 
			__construct
260 
		</span>
261 
				()
262 
			</div>
263 
 
264 
 
265 
 
266 
	</div>
267 
<a name="methodchargerModele" id="chargerModele"><!-- --></a>
297 jpm 268 
<div class="oddrow">
159 jpm 269 
 
270 
	<div class="method-header">
297 jpm 271 
		<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 272 
	</div>
273 
 
274 
	<!-- ========== Info from phpDoc block ========= -->
275 
<p class="short-description">Charge un modele donné et le rend disponible sous la forme $this-&gt;nom_modele</p>
276 
	<ul class="tags">
277 
				<li><span class="field">return:</span> false si le chargement a échoué, sinon true.</li>
297 jpm 278 
				<li><span class="field">access:</span> public</li>
159 jpm 279 
			</ul>
280 
 
281 
	<div class="method-signature">
282 
		<span class="method-result">boolean</span>
283 
		<span class="method-name">
284 
			chargerModele
285 
		</span>
286 
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$nom_modele</span>)
287 
			</div>
288 
 
289 
			<ul class="parameters">
290 
					<li>
291 
				<span class="var-type">string</span>
297 jpm 292 
				<span class="var-name">$nom_modele</span><span class="var-description">: le nom du modèle à  charger</span>			</li>
159 jpm 293 
				</ul>
294 
 
295 
 
296 
	</div>
297 jpm 297 
<a name="methodgetModele" id="getModele"><!-- --></a>
298 
<div class="evenrow">
159 jpm 299 
 
300 
	<div class="method-header">
297 jpm 301 
		<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 302 
	</div>
303 
 
304 
	<!-- ========== Info from phpDoc block ========= -->
297 jpm 305 
<p class="short-description">Retourne un modele donné</p>
159 jpm 306 
	<ul class="tags">
297 jpm 307 
				<li><span class="field">return:</span> false si le chargement a échoué, sinon l'objet du modèle demandé.</li>
159 jpm 308 
				<li><span class="field">access:</span> protected</li>
309 
			</ul>
310 
 
311 
	<div class="method-signature">
297 jpm 312 
		<span class="method-result">mixed</span>
159 jpm 313 
		<span class="method-name">
297 jpm 314 
			getModele
159 jpm 315 
		</span>
297 jpm 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>])
159 jpm 317 
			</div>
318 
 
319 
			<ul class="parameters">
320 
					<li>
297 jpm 321 
				<span class="var-type">string</span>
322 
				<span class="var-name">$nom_modele</span><span class="var-description">: le nom du fichier modèle à charger sans son extension</span>			</li>
323 
					<li>
159 jpm 324 
				<span class="var-type">String</span>
297 jpm 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>
159 jpm 326 
				</ul>
327 
 
328 
 
329 
	</div>
297 jpm 330 
<a name="methodgetVue" id="getVue"><!-- --></a>
331 
<div class="oddrow">
159 jpm 332 
 
333 
	<div class="method-header">
297 jpm 334 
		<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 335 
	</div>
336 
 
337 
	<!-- ========== Info from phpDoc block ========= -->
297 jpm 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>
159 jpm 339 
	<ul class="tags">
297 jpm 340 
				<li><span class="field">return:</span> false si la vue n'existe pas, sinon la chaine résultat.</li>
159 jpm 341 
				<li><span class="field">access:</span> protected</li>
342 
			</ul>
343 
 
344 
	<div class="method-signature">
297 jpm 345 
		<span class="method-result">boolean</span>
159 jpm 346 
		<span class="method-name">
297 jpm 347 
			getVue
159 jpm 348 
		</span>
297 jpm 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>)
159 jpm 350 
			</div>
351 
 
352 
			<ul class="parameters">
353 
					<li>
297 jpm 354 
				<span class="var-type">String</span>
355 
				<span class="var-name">$nom_squelette</span><span class="var-description">: le nom du squelette sans son extension</span>			</li>
356 
					<li>
357 
				<span class="var-type">Array</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>
359 
					<li>
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>
362 
					<li>
363 
				<span class="var-type"></span>
364 
				<span class="var-name">&$donnees</span>			</li>
159 jpm 365 
				</ul>
366 
 
367 
 
368 
	</div>
297 jpm 369 
<a name="methodpreTraiterDonnees" id="preTraiterDonnees"><!-- --></a>
370 
<div class="evenrow">
159 jpm 371 
 
372 
	<div class="method-header">
297 jpm 373 
		<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 374 
	</div>
375 
 
376 
	<!-- ========== Info from phpDoc block ========= -->
297 jpm 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>
159 jpm 379 
	<ul class="tags">
297 jpm 380 
				<li><span class="field">return:</span> Le tableau de données traité</li>
159 jpm 381 
				<li><span class="field">access:</span> protected</li>
382 
			</ul>
383 
 
384 
	<div class="method-signature">
297 jpm 385 
		<span class="method-result">Array</span>
159 jpm 386 
		<span class="method-name">
297 jpm 387 
			preTraiterDonnees
159 jpm 388 
		</span>
297 jpm 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>)
159 jpm 390 
			</div>
391 
 
392 
			<ul class="parameters">
393 
					<li>
297 jpm 394 
				<span class="var-type">Array</span>
395 
				<span class="var-name">$donnees</span><span class="var-description">: Le tableau de données à traiter</span>			</li>
159 jpm 396 
					<li>
297 jpm 397 
				<span class="var-type"></span>
398 
				<span class="var-name">&$donnees</span>			</li>
159 jpm 399 
				</ul>
400 
 
401 
 
402 
	</div>
403 
 
404 
		</div>
405 
	</div>
406 
 
407 
 
408 
	<p class="notes" id="credit">
297 jpm 409 
		Documentation generated on Tue, 18 Jan 2011 15:01:30 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
159 jpm 410 
	</p>
411 
	</div></body>
412 
</html>