Subversion Repositories Applications.framework

Rev

Rev 464 | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 464 Rev 465
1
<!DOCTYPE html>
1
<!DOCTYPE html>
2
<html>
2
<html>
3
<head>
3
<head>
4
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
4
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
5
	<meta name="generator" content="ApiGen 2.8.0">
5
	<meta name="generator" content="ApiGen 2.8.0">
6
 
6
 
7
	<title>Class Config | TBFramework - v0.4</title>
7
	<title>Class Config</title>
8
 
8
 
9
	<script type="text/javascript" src="resources/combined.js?4205936287"></script>
9
	<script type="text/javascript" src="resources/combined.js?4205936287"></script>
10
	<script type="text/javascript" src="elementlist.js?1964084359"></script>
10
	<script type="text/javascript" src="elementlist.js?4111837732"></script>
11
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360">
11
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360">
12
 
12
 
13
</head>
13
</head>
14
 
14
 
15
<body>
15
<body>
16
<div id="left">
16
<div id="left">
17
	<div id="menu">
17
	<div id="menu">
18
		<a href="index.html" title="Overview"><span>Overview</span></a>
18
		<a href="index.html" title="Overview"><span>Overview</span></a>
19
 
19
 
20
 
20
 
21
		<div id="groups">
21
		<div id="groups">
22
			<h3>Packages</h3>
22
			<h3>Packages</h3>
23
			<ul>
23
			<ul>
24
				<li class="active"><a href="package-Framework.html">Framework</a>
24
				<li class="active"><a href="package-Framework.html">Framework</a>
25
						</li>
25
						</li>
26
				<li><a href="package-None.html">None</a>
26
				<li><a href="package-None.html">None</a>
27
						</li>
27
						</li>
28
				<li><a href="package-PHP.html">PHP</a>
28
				<li><a href="package-PHP.html">PHP</a>
29
						</li>
29
						</li>
30
				<li><a href="package-Utilitaire.html">Utilitaire</a>
30
				<li><a href="package-Utilitaire.html">Utilitaire</a>
31
						</li>
31
						</li>
32
			</ul>
32
			</ul>
33
		</div>
33
		</div>
34
 
34
 
35
		<hr>
35
		<hr>
36
 
36
 
37
 
37
 
38
		<div id="elements">
38
		<div id="elements">
39
			<h3>Classes</h3>
39
			<h3>Classes</h3>
40
			<ul>
40
			<ul>
41
				<li><a href="class-Bdd.html">Bdd</a></li>
41
				<li><a href="class-Bdd.html">Bdd</a></li>
42
				<li><a href="class-Cache.html">Cache</a></li>
42
				<li><a href="class-Cache.html">Cache</a></li>
43
				<li><a href="class-CacheSimple.html">CacheSimple</a></li>
43
				<li><a href="class-CacheSimple.html">CacheSimple</a></li>
44
				<li><a href="class-Chronometre.html">Chronometre</a></li>
44
				<li><a href="class-Chronometre.html">Chronometre</a></li>
45
				<li><a href="class-Cli.html">Cli</a></li>
45
				<li><a href="class-Cli.html">Cli</a></li>
46
				<li class="active"><a href="class-Config.html">Config</a></li>
46
				<li class="active"><a href="class-Config.html">Config</a></li>
47
				<li><a href="class-Controleur.html">Controleur</a></li>
47
				<li><a href="class-Controleur.html">Controleur</a></li>
48
				<li><a href="class-Debug.html">Debug</a></li>
48
				<li><a href="class-Debug.html">Debug</a></li>
49
				<li><a href="class-Framework.html">Framework</a></li>
49
				<li><a href="class-Framework.html">Framework</a></li>
50
				<li><a href="class-GestionnaireException.html">GestionnaireException</a></li>
50
				<li><a href="class-GestionnaireException.html">GestionnaireException</a></li>
51
				<li><a href="class-I18n.html">I18n</a></li>
51
				<li><a href="class-I18n.html">I18n</a></li>
52
				<li><a href="class-Log.html">Log</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>
53
				<li><a href="class-Registre.html">Registre</a></li>
55
				<li><a href="class-RestClient.html">RestClient</a></li>
54
				<li><a href="class-RestClient.html">RestClient</a></li>
56
				<li><a href="class-RestServeur.html">RestServeur</a></li>
55
				<li><a href="class-RestServeur.html">RestServeur</a></li>
57
				<li><a href="class-RestService.html">RestService</a></li>
56
				<li><a href="class-RestService.html">RestService</a></li>
58
				<li><a href="class-Script.html">Script</a></li>
57
				<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>
58
				<li><a href="class-SquelettePhp.html">SquelettePhp</a></li>
63
				<li><a href="class-Url.html">Url</a></li>
59
				<li><a href="class-Url.html">Url</a></li>
64
			</ul>
60
			</ul>
65
 
61
 
66
 
62
 
67
 
63
 
68
 
64
 
69
 
65
 
70
		</div>
66
		</div>
71
	</div>
67
	</div>
72
</div>
68
</div>
73
 
69
 
74
<div id="splitter"></div>
70
<div id="splitter"></div>
75
 
71
 
76
<div id="right">
72
<div id="right">
77
<div id="rightInner">
73
<div id="rightInner">
78
	<form id="search">
74
	<form id="search">
79
		<input type="hidden" name="cx" value="">
75
		<input type="hidden" name="cx" value="">
80
		<input type="hidden" name="ie" value="UTF-8">
76
		<input type="hidden" name="ie" value="UTF-8">
81
		<input type="text" name="q" class="text">
77
		<input type="text" name="q" class="text">
82
		<input type="submit" value="Search">
78
		<input type="submit" value="Search">
83
	</form>
79
	</form>
84
 
80
 
85
	<div id="navigation">
81
	<div id="navigation">
86
		<ul>
82
		<ul>
87
			<li>
83
			<li>
88
				<a href="index.html" title="Overview"><span>Overview</span></a>
84
				<a href="index.html" title="Overview"><span>Overview</span></a>
89
			</li>
85
			</li>
90
			<li>
86
			<li>
91
				<a href="package-Framework.html" title="Summary of Framework"><span>Package</span></a>
87
				<a href="package-Framework.html" title="Summary of Framework"><span>Package</span></a>
92
			</li>
88
			</li>
93
			<li class="active">
89
			<li class="active">
94
<span>Class</span>			</li>
90
<span>Class</span>			</li>
95
		</ul>
91
		</ul>
96
		<ul>
92
		<ul>
97
			<li>
93
			<li>
98
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
94
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
99
			</li>
95
			</li>
100
			<li>
96
			<li>
101
				<a href="deprecated.html" title="List of deprecated elements"><span>Deprecated</span></a>
97
				<a href="deprecated.html" title="List of deprecated elements"><span>Deprecated</span></a>
102
			</li>
98
			</li>
103
			<li>
99
			<li>
104
				<a href="todo.html" title="Todo list"><span>Todo</span></a>
100
				<a href="todo.html" title="Todo list"><span>Todo</span></a>
105
			</li>
101
			</li>
106
		</ul>
102
		</ul>
107
		<ul>
103
		<ul>
108
		</ul>
104
		</ul>
109
	</div>
105
	</div>
110
 
106
 
111
<div id="content" class="class">
107
<div id="content" class="class">
112
	<h1>Class Config</h1>
108
	<h1>Class Config</h1>
113
 
109
 
114
 
110
 
115
	<div class="description">
111
	<div class="description">
116
	
112
	
117
<p>Config permet de charger automatiquement les fichiers ini du Framework et de
113
<p>Config permet de charger automatiquement les fichiers ini du Framework et de
118
l'application. Elle offre l'accès en lecture seule aux paramètres de config.
114
l'application. Elle offre l'accès en lecture seule aux paramètres de config.
119
C'est une Singleton. Si vous avez besoin de modifier dynamiquement des
115
C'est une Singleton. Si vous avez besoin de modifier dynamiquement des
120
paramètres de configuration, utiliser le @see Registe, il est fait pour
116
paramètres de configuration, utiliser le @see Registe, il est fait pour
121
ça.</p>
117
ça.</p>
122
 
118
 
123
	</div>
119
	</div>
124
 
120
 
125
 
121
 
126
 
122
 
127
 
123
 
128
 
124
 
129
 
125
 
130
 
126
 
131
 
127
 
132
 
128
 
133
	<div class="info">
129
	<div class="info">
134
		
130
		
135
		
131
		
136
		
132
		
137
		<b>Package:</b> <a href="package-Framework.html">Framework</a><br>
133
		<b>Package:</b> <a href="package-Framework.html">Framework</a><br>
138
 
134
 
139
				<b>Category:</b>
135
				<b>Category:</b>
140
				PHP 5.2<br>
136
				PHP 5.2<br>
141
				<b>Copyright:</b>
137
				<b>Copyright:</b>
142
				Copyright (c) 2009, Tela Botanica (<a
138
				Copyright (c) 2009, Tela Botanica (<a
143
href="mailto:accueil&#64;tela-botanica.org">accueil&#64;<!-- -->tela-botanica.org</a>)<br>
139
href="mailto:accueil&#64;tela-botanica.org">accueil&#64;<!-- -->tela-botanica.org</a>)<br>
144
				<b>License:</b>
140
				<b>License:</b>
145
				<a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL-v3</a><br>
141
				<a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL-v3</a><br>
146
				<b>License:</b>
142
				<b>License:</b>
147
				<a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL-v2</a><br>
143
				<a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL-v2</a><br>
148
				<b>Author:</b>
144
				<b>Author:</b>
149
				Jean-Pascal MILCENT &lt;<a
145
				Jean-Pascal MILCENT &lt;<a
150
href="mailto:jpm&#64;tela-botanica.org">jpm&#64;<!-- -->tela-botanica.org</a>&gt;<br>
146
href="mailto:jpm&#64;tela-botanica.org">jpm&#64;<!-- -->tela-botanica.org</a>&gt;<br>
151
				<b>Version:</b>
147
				<b>Version:</b>
152
				$Id: Config.php 447 2013-12-19 10:52:37Z jpm $<br>
148
				$Id: Config.php 447 2013-12-19 10:52:37Z jpm $<br>
153
				<b>Link:</b>
149
				<b>Link:</b>
154
				/doc/framework/<br>
150
				/doc/framework/<br>
155
		<b>Located at</b> <a href="source-class-Config.html#4-282" title="Go to source code">framework/Config.php</a><br>
151
		<b>Located at</b> <a href="source-class-Config.html#4-282" title="Go to source code">Config.php</a><br>
156
	</div>
152
	</div>
157
 
153
 
158
 
154
 
159
 
155
 
160
	<table class="summary" id="methods">
156
	<table class="summary" id="methods">
161
	<caption>Methods summary</caption>
157
	<caption>Methods summary</caption>
162
	<tr data-order="charger" id="_charger">
158
	<tr data-order="charger" id="_charger">
163
 
159
 
164
		<td class="attributes"><code>
160
		<td class="attributes"><code>
165
			 public static
161
			 public static
166
			array
162
			array
167
			
163
			
168
			</code>
164
			</code>
169
		</td>
165
		</td>
170
 
166
 
171
		<td class="name"><div>
167
		<td class="name"><div>
172
		<a class="anchor" href="#_charger">#</a>
168
		<a class="anchor" href="#_charger">#</a>
173
		<code><a href="source-class-Config.html#232-240" title="Go to source code">charger</a>( <span>string <var>$fichier_ini</var></span> )</code>
169
		<code><a href="source-class-Config.html#232-240" title="Go to source code">charger</a>( <span>string <var>$fichier_ini</var></span> )</code>
174
 
170
 
175
		<div class="description short">
171
		<div class="description short">
176
			
172
			
177
<p>Charge un fichier ini dans le tableau des paramètres de l'appli.</p>
173
<p>Charge un fichier ini dans le tableau des paramètres de l'appli.</p>
178
 
174
 
179
		</div>
175
		</div>
180
 
176
 
181
		<div class="description detailed hidden">
177
		<div class="description detailed hidden">
182
			
178
			
183
<p>Charge un fichier ini dans le tableau des paramètres de l'appli.</p>
179
<p>Charge un fichier ini dans le tableau des paramètres de l'appli.</p>
184
 
180
 
185
 
181
 
186
 
182
 
187
				<h4>Parameters</h4>
183
				<h4>Parameters</h4>
188
				<div class="list"><dl>
184
				<div class="list"><dl>
189
					<dt><var>$fichier_ini</var></dt>
185
					<dt><var>$fichier_ini</var></dt>
190
					<dd><code>string</code><br>$fichier_ini le nom du fichier à charger</dd>
186
					<dd><code>string</code><br>$fichier_ini le nom du fichier à charger</dd>
191
				</dl></div>
187
				</dl></div>
192
 
188
 
193
				<h4>Returns</h4>
189
				<h4>Returns</h4>
194
				<div class="list">
190
				<div class="list">
195
					<code>array</code><br>le fichier ini parsé<br>
191
					<code>array</code><br>le fichier ini parsé<br>
196
				</div>
192
				</div>
197
 
193
 
198
 
194
 
199
 
195
 
200
 
196
 
201
		</div>
197
		</div>
202
		</div></td>
198
		</div></td>
203
	</tr>
199
	</tr>
204
	<tr data-order="get" id="_get">
200
	<tr data-order="get" id="_get">
205
 
201
 
206
		<td class="attributes"><code>
202
		<td class="attributes"><code>
207
			 public static
203
			 public static
208
			string
204
			string
209
			
205
			
210
			</code>
206
			</code>
211
		</td>
207
		</td>
212
 
208
 
213
		<td class="name"><div>
209
		<td class="name"><div>
214
		<a class="anchor" href="#_get">#</a>
210
		<a class="anchor" href="#_get">#</a>
215
		<code><a href="source-class-Config.html#242-250" title="Go to source code">get</a>( <span>string <var>$param</var> = <span class="php-keyword1">null</span></span> )</code>
211
		<code><a href="source-class-Config.html#242-250" title="Go to source code">get</a>( <span>string <var>$param</var> = <span class="php-keyword1">null</span></span> )</code>
216
 
212
 
217
		<div class="description short">
213
		<div class="description short">
218
			
214
			
219
<p>Accesseur pour la valeur d'un paramètre.</p>
215
<p>Accesseur pour la valeur d'un paramètre.</p>
220
 
216
 
221
		</div>
217
		</div>
222
 
218
 
223
		<div class="description detailed hidden">
219
		<div class="description detailed hidden">
224
			
220
			
225
<p>Accesseur pour la valeur d'un paramètre.</p>
221
<p>Accesseur pour la valeur d'un paramètre.</p>
226
 
222
 
227
 
223
 
228
 
224
 
229
				<h4>Parameters</h4>
225
				<h4>Parameters</h4>
230
				<div class="list"><dl>
226
				<div class="list"><dl>
231
					<dt><var>$param</var></dt>
227
					<dt><var>$param</var></dt>
232
					<dd><code>string</code><br>$param le nom du paramètre</dd>
228
					<dd><code>string</code><br>$param le nom du paramètre</dd>
233
				</dl></div>
229
				</dl></div>
234
 
230
 
235
				<h4>Returns</h4>
231
				<h4>Returns</h4>
236
				<div class="list">
232
				<div class="list">
237
					<code>string</code><br>la valeur du paramètre<br>
233
					<code>string</code><br>la valeur du paramètre<br>
238
				</div>
234
				</div>
239
 
235
 
240
 
236
 
241
 
237
 
242
 
238
 
243
		</div>
239
		</div>
244
		</div></td>
240
		</div></td>
245
	</tr>
241
	</tr>
246
	<tr data-order="existe" id="_existe">
242
	<tr data-order="existe" id="_existe">
247
 
243
 
248
		<td class="attributes"><code>
244
		<td class="attributes"><code>
249
			 public static
245
			 public static
250
			boolean
246
			boolean
251
			
247
			
252
			</code>
248
			</code>
253
		</td>
249
		</td>
254
 
250
 
255
		<td class="name"><div>
251
		<td class="name"><div>
256
		<a class="anchor" href="#_existe">#</a>
252
		<a class="anchor" href="#_existe">#</a>
257
		<code><a href="source-class-Config.html#252-260" title="Go to source code">existe</a>( <span>string <var>$param</var></span> )</code>
253
		<code><a href="source-class-Config.html#252-260" title="Go to source code">existe</a>( <span>string <var>$param</var></span> )</code>
258
 
254
 
259
		<div class="description short">
255
		<div class="description short">
260
			
256
			
261
<p>Vérifie si la valeur d'un paramètre existe.</p>
257
<p>Vérifie si la valeur d'un paramètre existe.</p>
262
 
258
 
263
		</div>
259
		</div>
264
 
260
 
265
		<div class="description detailed hidden">
261
		<div class="description detailed hidden">
266
			
262
			
267
<p>Vérifie si la valeur d'un paramètre existe.</p>
263
<p>Vérifie si la valeur d'un paramètre existe.</p>
268
 
264
 
269
 
265
 
270
 
266
 
271
				<h4>Parameters</h4>
267
				<h4>Parameters</h4>
272
				<div class="list"><dl>
268
				<div class="list"><dl>
273
					<dt><var>$param</var></dt>
269
					<dt><var>$param</var></dt>
274
					<dd><code>string</code><br>$param le nom du paramètre</dd>
270
					<dd><code>string</code><br>$param le nom du paramètre</dd>
275
				</dl></div>
271
				</dl></div>
276
 
272
 
277
				<h4>Returns</h4>
273
				<h4>Returns</h4>
278
				<div class="list">
274
				<div class="list">
279
					<code>boolean</code><br>vrai si le paramètre existe, false sinon<br>
275
					<code>boolean</code><br>vrai si le paramètre existe, false sinon<br>
280
				</div>
276
				</div>
281
 
277
 
282
 
278
 
283
 
279
 
284
 
280
 
285
		</div>
281
		</div>
286
		</div></td>
282
		</div></td>
287
	</tr>
283
	</tr>
288
	<tr data-order="verifierPresenceParametres" id="_verifierPresenceParametres">
284
	<tr data-order="verifierPresenceParametres" id="_verifierPresenceParametres">
289
 
285
 
290
		<td class="attributes"><code>
286
		<td class="attributes"><code>
291
			 public static
287
			 public static
292
			boolean
288
			boolean
293
			
289
			
294
			</code>
290
			</code>
295
		</td>
291
		</td>
296
 
292
 
297
		<td class="name"><div>
293
		<td class="name"><div>
298
		<a class="anchor" href="#_verifierPresenceParametres">#</a>
294
		<a class="anchor" href="#_verifierPresenceParametres">#</a>
299
		<code><a href="source-class-Config.html#262-281" title="Go to source code">verifierPresenceParametres</a>( <span>array <var>$parametres</var></span> )</code>
295
		<code><a href="source-class-Config.html#262-281" title="Go to source code">verifierPresenceParametres</a>( <span>array <var>$parametres</var></span> )</code>
300
 
296
 
301
		<div class="description short">
297
		<div class="description short">
302
			
298
			
303
<p>Vérifie que tous les paramêtres de config nécessaires au fonctionnement
299
<p>Vérifie que tous les paramêtres de config nécessaires au fonctionnement
304
d'une classe existe dans les fichiers de configurations. L'utilisation de cette
300
d'une classe existe dans les fichiers de configurations. L'utilisation de cette
305
méthode depuis la classe Config évite de faire appel à une classe
301
méthode depuis la classe Config évite de faire appel à une classe
306
supplémentaire.</p>
302
supplémentaire.</p>
307
 
303
 
308
		</div>
304
		</div>
309
 
305
 
310
		<div class="description detailed hidden">
306
		<div class="description detailed hidden">
311
			
307
			
312
<p>Vérifie que tous les paramêtres de config nécessaires au fonctionnement
308
<p>Vérifie que tous les paramêtres de config nécessaires au fonctionnement
313
d'une classe existe dans les fichiers de configurations. L'utilisation de cette
309
d'une classe existe dans les fichiers de configurations. L'utilisation de cette
314
méthode depuis la classe Config évite de faire appel à une classe
310
méthode depuis la classe Config évite de faire appel à une classe
315
supplémentaire.</p>
311
supplémentaire.</p>
316
 
312
 
317
 
313
 
318
 
314
 
319
				<h4>Parameters</h4>
315
				<h4>Parameters</h4>
320
				<div class="list"><dl>
316
				<div class="list"><dl>
321
					<dt><var>$parametres</var></dt>
317
					<dt><var>$parametres</var></dt>
322
					<dd><code>array</code><br>$parametres tableau des noms des paramètres de la config à verifier.</dd>
318
					<dd><code>array</code><br>$parametres tableau des noms des paramètres de la config à verifier.</dd>
323
				</dl></div>
319
				</dl></div>
324
 
320
 
325
				<h4>Returns</h4>
321
				<h4>Returns</h4>
326
				<div class="list">
322
				<div class="list">
327
					<code>boolean</code><br>true si tous les paramétres sont présents sinon false.<br>
323
					<code>boolean</code><br>true si tous les paramétres sont présents sinon false.<br>
328
				</div>
324
				</div>
329
 
325
 
330
 
326
 
331
 
327
 
332
 
328
 
333
		</div>
329
		</div>
334
		</div></td>
330
		</div></td>
335
	</tr>
331
	</tr>
336
	</table>
332
	</table>
337
 
333
 
338
 
334
 
339
 
335
 
340
 
336
 
341
 
337
 
342
 
338
 
343
 
339
 
344
 
340
 
345
 
341
 
346
 
342
 
347
 
343
 
348
 
344
 
349
 
345
 
350
 
346
 
351
 
347
 
352
 
348
 
353
 
349
 
354
 
350
 
355
</div>
351
</div>
356
 
352
 
357
	<div id="footer">
353
	<div id="footer">
358
		TBFramework - v0.4 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
354
		 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
359
	</div>
355
	</div>
360
</div>
356
</div>
361
</div>
357
</div>
362
</body>
358
</body>
363
</html>
359
</html>