Subversion Repositories Applications.framework

Rev

Rev 464 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
464 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
 
465 jpm 7
	<title>Class Framework</title>
464 jpm 8
 
9
	<script type="text/javascript" src="resources/combined.js?4205936287"></script>
465 jpm 10
	<script type="text/javascript" src="elementlist.js?4111837732"></script>
464 jpm 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><a href="class-Controleur.html">Controleur</a></li>
48
				<li><a href="class-Debug.html">Debug</a></li>
49
				<li class="active"><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 Framework</h1>
109
 
110
 
111
	<div class="description">
112
 
113
<p>Classe de base du Framework : - fournissant des infos sur l'application, -
114
paramétrant l'environnement de l'appli et du framework, - réalisant des
115
traitements sur les variables globales ($_GET, $_POST, $_COOKIE...)</p>
116
 
117
<p>Cette classe contient la fonction de chargement automatique de classes. Ce
118
fichier doit toujours rester à la racine du framework car il initialise le
119
chemin de l'application en se basant sur son propre emplacement.</p>
120
 
121
	</div>
122
 
123
 
124
 
125
 
126
 
127
 
128
 
129
 
130
 
131
	<div class="info">
132
 
133
 
134
 
135
		<b>Package:</b> <a href="package-Framework.html">Framework</a><br>
136
 
137
				<b>Category:</b>
138
				PHP 5.2<br>
139
				<b>Copyright:</b>
140
				Copyright (c) 2010, Tela Botanica (<a
141
href="mailto:accueil&#64;tela-botanica.org">accueil&#64;<!-- -->tela-botanica.org</a>)<br>
142
				<b>License:</b>
143
				<a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL-v3</a><br>
144
				<b>License:</b>
145
				<a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL-v2</a><br>
146
				<b>Author:</b>
147
				Jean-Pascal MILCENT &lt;<a
148
href="mailto:jpm&#64;tela-botanica.org">jpm&#64;<!-- -->tela-botanica.org</a>&gt;<br>
149
				<b>Version:</b>
150
				$Id: Framework.php 393 2011-11-10 13:36:48Z jpm $<br>
151
				<b>Since:</b>
152
				0.3<br>
153
				<b>Link:</b>
154
				/doc/framework/<br>
465 jpm 155
		<b>Located at</b> <a href="source-class-Framework.html#3-252" title="Go to source code">Framework.php</a><br>
464 jpm 156
	</div>
157
 
158
 
159
 
160
	<table class="summary" id="methods">
161
	<caption>Methods summary</caption>
162
	<tr data-order="setCheminAppli" id="_setCheminAppli">
163
 
164
		<td class="attributes"><code>
165
			 public static
166
 
167
 
168
			</code>
169
		</td>
170
 
171
		<td class="name"><div>
172
		<a class="anchor" href="#_setCheminAppli">#</a>
173
		<code><a href="source-class-Framework.html#143-161" title="Go to source code">setCheminAppli</a>( <span>string <var>$chemin_fichier_principal</var></span> )</code>
174
 
175
		<div class="description short">
176
 
177
<p>Permet d'indiquer le chemin de base de l'Application. Cette méthode doit
178
obligatoirement être utilisée par l'application pour que le Framework
179
fonctionne correctement.</p>
180
 
181
		</div>
182
 
183
		<div class="description detailed hidden">
184
 
185
<p>Permet d'indiquer le chemin de base de l'Application. Cette méthode doit
186
obligatoirement être utilisée par l'application pour que le Framework
187
fonctionne correctement.</p>
188
 
189
 
190
 
191
				<h4>Parameters</h4>
192
				<div class="list"><dl>
193
					<dt><var>$chemin_fichier_principal</var></dt>
194
					<dd><code>string</code><br>$chemin_fichier_principal chemin de base</dd>
195
				</dl></div>
196
 
197
 
198
 
199
 
200
 
201
		</div>
202
		</div></td>
203
	</tr>
204
	<tr data-order="getCheminAppli" id="_getCheminAppli">
205
 
206
		<td class="attributes"><code>
207
			 public static
208
			string
209
 
210
			</code>
211
		</td>
212
 
213
		<td class="name"><div>
214
		<a class="anchor" href="#_getCheminAppli">#</a>
215
		<code><a href="source-class-Framework.html#163-169" title="Go to source code">getCheminAppli</a>( )</code>
216
 
217
		<div class="description short">
218
 
219
<p>accesseur pour le chemin</p>
220
 
221
		</div>
222
 
223
		<div class="description detailed hidden">
224
 
225
<p>accesseur pour le chemin</p>
226
 
227
 
228
 
229
 
230
				<h4>Returns</h4>
231
				<div class="list">
232
					<code>string</code><br>le chemin<br>
233
				</div>
234
 
235
 
236
 
237
 
238
		</div>
239
		</div></td>
240
	</tr>
241
	<tr data-order="setInfoAppli" id="_setInfoAppli">
242
 
243
		<td class="attributes"><code>
244
			 public static
245
 
246
 
247
			</code>
248
		</td>
249
 
250
		<td class="name"><div>
251
		<a class="anchor" href="#_setInfoAppli">#</a>
252
		<code><a href="source-class-Framework.html#171-185" title="Go to source code">setInfoAppli</a>( <span>array <var>$info</var></span> )</code>
253
 
254
		<div class="description short">
255
 
256
<p>Le tableau des informations sur l'application possède les clés suivantes
257
:</p>
258
 
259
<ul>
260
	<li>nom : nom de l'application</li>
261
 
262
	<li>abr : abréviation de l'application</li>
263
 
264
	<li>encodage : encodage de l'application (ISO-8859-15, UTF-8...)</li>
265
</ul>
266
 
267
		</div>
268
 
269
		<div class="description detailed hidden">
270
 
271
<p>Le tableau des informations sur l'application possède les clés suivantes
272
:</p>
273
 
274
<ul>
275
	<li>nom : nom de l'application</li>
276
 
277
	<li>abr : abréviation de l'application</li>
278
 
279
	<li>encodage : encodage de l'application (ISO-8859-15, UTF-8...)</li>
280
</ul>
281
 
282
 
283
 
284
				<h4>Parameters</h4>
285
				<div class="list"><dl>
286
					<dt><var>$info</var></dt>
287
					<dd><code>array</code><br>$info tableau fournissant des informations sur l'application</dd>
288
				</dl></div>
289
 
290
 
291
 
292
 
293
 
294
		</div>
295
		</div></td>
296
	</tr>
297
	<tr data-order="getInfoAppli" id="_getInfoAppli">
298
 
299
		<td class="attributes"><code>
300
			 public static
301
 
302
 
303
			</code>
304
		</td>
305
 
306
		<td class="name"><div>
307
		<a class="anchor" href="#_getInfoAppli">#</a>
308
		<code><a href="source-class-Framework.html#187-199" title="Go to source code">getInfoAppli</a>( <span>string <var>$cle</var> = <span class="php-keyword1">null</span></span> )</code>
309
 
310
		<div class="description short">
311
 
312
<p>Accesseur pour le tableau d'infos sur l'application.</p>
313
 
314
		</div>
315
 
316
		<div class="description detailed hidden">
317
 
318
<p>Accesseur pour le tableau d'infos sur l'application.</p>
319
 
320
 
321
 
322
				<h4>Parameters</h4>
323
				<div class="list"><dl>
324
					<dt><var>$cle</var></dt>
325
					<dd><code>string</code><br>$cle la clé à laquelle on veut accéder</dd>
326
				</dl></div>
327
 
328
 
329
 
330
 
331
 
332
		</div>
333
		</div></td>
334
	</tr>
335
	<tr data-order="verifierEtReencoderTableauRequete" id="_verifierEtReencoderTableauRequete">
336
 
337
		<td class="attributes"><code>
338
			 protected static
339
 
340
 
341
			</code>
342
		</td>
343
 
344
		<td class="name"><div>
345
		<a class="anchor" href="#_verifierEtReencoderTableauRequete">#</a>
346
		<code><a href="source-class-Framework.html#201-214" title="Go to source code">verifierEtReencoderTableauRequete</a>( )</code>
347
 
348
		<div class="description short">
349
 
350
<p>Procédure vérifiant l'encodage des tableaux $_GET et $_POST et les
351
transcodant dans l'encodage de l'application</p>
352
 
353
		</div>
354
 
355
		<div class="description detailed hidden">
356
 
357
<p>Procédure vérifiant l'encodage des tableaux $_GET et $_POST et les
358
transcodant dans l'encodage de l'application</p>
359
 
360
 
361
 
362
 
363
 
364
 
365
 
366
 
367
		</div>
368
		</div></td>
369
	</tr>
370
	<tr data-order="encoderTableau" id="_encoderTableau">
371
 
372
		<td class="attributes"><code>
373
			final protected static
374
			Array
375
 
376
			</code>
377
		</td>
378
 
379
		<td class="name"><div>
380
		<a class="anchor" href="#_encoderTableau">#</a>
381
		<code><a href="source-class-Framework.html#232-251" title="Go to source code">encoderTableau</a>( <span>mixed <var>$tableau</var></span>, <span>mixed <var>$encodage_sortie</var></span>, <span>mixed <var>$encodage_entree</var> = <span class="php-keyword1">null</span></span> )</code>
382
 
383
		<div class="description short">
384
 
385
<p>Fonction récursive transcodant toutes les valeurs d'un tableau de leur
386
encodage d'entrée vers un encodage de sortie donné</p>
387
 
388
		</div>
389
 
390
		<div class="description detailed hidden">
391
 
392
<p>Fonction récursive transcodant toutes les valeurs d'un tableau de leur
393
encodage d'entrée vers un encodage de sortie donné</p>
394
 
395
 
396
 
397
				<h4>Parameters</h4>
398
				<div class="list"><dl>
399
					<dt><var>$tableau</var></dt>
400
					<dd><code>mixed</code><br>$tableau Array Un tableau de données à encoder</dd>
401
					<dt><var>$encodage_sortie</var></dt>
402
					<dd><code>mixed</code><br>$encodage_sortie String l'encodage vers lequel on doit transcoder</dd>
403
					<dt><var>$encodage_entree</var></dt>
404
					<dd><code>mixed</code><br>$encodage_entree String l'encodage original des chaines du tableau (optionnel)</dd>
405
				</dl></div>
406
 
407
				<h4>Returns</h4>
408
				<div class="list">
409
					<code>Array</code><br>Le tableau encodé dans l'encodage de sortie<br>
410
				</div>
411
 
412
 
413
 
414
 
415
		</div>
416
		</div></td>
417
	</tr>
418
	</table>
419
 
420
 
421
 
422
 
423
 
424
 
425
 
426
 
427
 
428
 
429
 
430
 
431
 
432
 
433
 
434
 
435
 
436
 
437
</div>
438
 
439
	<div id="footer">
465 jpm 440
		 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
464 jpm 441
	</div>
442
</div>
443
</div>
444
</body>
445
</html>