Subversion Repositories Applications.framework

Rev

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