Subversion Repositories Applications.framework

Rev

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

Rev Author Line No. Line
467 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 Config | TBFramework - v0.2</title>
8
 
9
	<script type="text/javascript" src="resources/combined.js?4205936287"></script>
476 jpm 10
	<script type="text/javascript" src="elementlist.js?1835392179"></script>
467 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-PHP.html">PHP</a>
27
						</li>
28
			</ul>
29
		</div>
30
 
31
		<hr>
32
 
33
 
34
		<div id="elements">
35
			<h3>Classes</h3>
36
			<ul>
37
				<li><a href="class-Application.html">Application</a></li>
38
				<li><a href="class-Chronometre.html">Chronometre</a></li>
39
				<li class="active"><a href="class-Config.html">Config</a></li>
40
				<li><a href="class-Controleur.html">Controleur</a></li>
41
				<li><a href="class-Debug.html">Debug</a></li>
42
				<li><a href="class-GestionnaireException.html">GestionnaireException</a></li>
476 jpm 43
				<li><a href="class-I18n.html">I18n</a></li>
467 jpm 44
				<li><a href="class-Log.html">Log</a></li>
45
				<li><a href="class-Modele.html">Modele</a></li>
46
				<li><a href="class-Registre.html">Registre</a></li>
47
				<li><a href="class-SquelettePhp.html">SquelettePhp</a></li>
48
				<li><a href="class-Url.html">Url</a></li>
49
			</ul>
50
 
51
 
52
 
53
 
54
 
55
			<h3>Functions</h3>
56
			<ul>
57
				<li><a href="function-autoloadAppliDefaut.html">autoloadAppliDefaut</a></li>
58
				<li><a href="function-autoloadFw.html">autoloadFw</a></li>
59
			</ul>
60
		</div>
61
	</div>
62
</div>
63
 
64
<div id="splitter"></div>
65
 
66
<div id="right">
67
<div id="rightInner">
68
	<form id="search">
69
		<input type="hidden" name="cx" value="">
70
		<input type="hidden" name="ie" value="UTF-8">
71
		<input type="text" name="q" class="text">
72
		<input type="submit" value="Search">
73
	</form>
74
 
75
	<div id="navigation">
76
		<ul>
77
			<li>
78
				<a href="index.html" title="Overview"><span>Overview</span></a>
79
			</li>
80
			<li>
81
				<a href="package-Framework.html" title="Summary of Framework"><span>Package</span></a>
82
			</li>
83
			<li class="active">
84
<span>Class</span>			</li>
85
		</ul>
86
		<ul>
87
			<li>
88
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
89
			</li>
90
			<li>
91
				<a href="deprecated.html" title="List of deprecated elements"><span>Deprecated</span></a>
92
			</li>
93
			<li>
94
				<a href="todo.html" title="Todo list"><span>Todo</span></a>
95
			</li>
96
		</ul>
97
		<ul>
98
		</ul>
99
	</div>
100
 
101
<div id="content" class="class">
102
	<h1>Class Config</h1>
103
 
104
 
105
	<div class="description">
106
 
107
<p>Config permet de charger automatiquement les fichiers ini du Framework et de
108
l'application. Elle offre l'accès en lecture seule aux paramètres de config.
109
C'est une Singleton.</p>
110
 
111
	</div>
112
 
113
 
114
 
115
 
116
 
117
 
118
 
119
 
120
 
121
	<div class="info">
122
 
123
 
124
 
125
		<b>Package:</b> <a href="package-Framework.html">Framework</a><br>
126
 
127
				<b>Category:</b>
476 jpm 128
				PHP 5.2<br>
467 jpm 129
				<b>Copyright:</b>
476 jpm 130
				Copyright (c) 2009, Tela Botanica (<a
131
href="mailto:accueil&#64;tela-botanica.org">accueil&#64;<!-- -->tela-botanica.org</a>)<br>
467 jpm 132
				<b>License:</b>
476 jpm 133
				<a href="GNU-GPL-v3">&lt;http://www.gnu.org/licenses/gpl.html&gt;</a><br>
134
				<b>License:</b>
135
				<a href="CECILL-v2">&lt;http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt&gt;</a><br>
467 jpm 136
				<b>Author:</b>
137
				Jean-Pascal MILCENT &lt;<a
138
href="mailto:jpm&#64;tela-botanica.org">jpm&#64;<!-- -->tela-botanica.org</a>&gt;<br>
476 jpm 139
		<b>Located at</b> <a href="source-class-Config.html#4-261" title="Go to source code">Config.php</a><br>
467 jpm 140
	</div>
141
 
142
 
143
 
144
	<table class="summary" id="methods">
145
	<caption>Methods summary</caption>
476 jpm 146
	<tr data-order="parserFichierIni" id="_parserFichierIni">
147
 
148
		<td class="attributes"><code>
149
			 public static
150
			array
151
 
152
			</code>
153
		</td>
154
 
155
		<td class="name"><div>
156
		<a class="anchor" href="#_parserFichierIni">#</a>
157
		<code><a href="source-class-Config.html#88-102" title="Go to source code">parserFichierIni</a>( <span>string <var>$fichier_ini</var></span> )</code>
158
 
159
		<div class="description short">
160
 
161
<p>Parse le fichier ini donné en paramètre</p>
162
 
163
		</div>
164
 
165
		<div class="description detailed hidden">
166
 
167
<p>Parse le fichier ini donné en paramètre</p>
168
 
169
 
170
 
171
				<h4>Parameters</h4>
172
				<div class="list"><dl>
173
					<dt><var>$fichier_ini</var></dt>
174
					<dd><code>string</code><br>$fichier_ini nom du fichier ini à parser</dd>
175
				</dl></div>
176
 
177
				<h4>Returns</h4>
178
				<div class="list">
179
					<code>array</code><br>tableau contenant les paramètres du fichier ini<br>
180
				</div>
181
 
182
 
183
 
184
 
185
		</div>
186
		</div></td>
187
	</tr>
467 jpm 188
	<tr data-order="charger" id="_charger">
189
 
190
		<td class="attributes"><code>
191
			 public static
192
			array
193
 
194
			</code>
195
		</td>
196
 
197
		<td class="name"><div>
198
		<a class="anchor" href="#_charger">#</a>
476 jpm 199
		<code><a href="source-class-Config.html#232-240" title="Go to source code">charger</a>( <span>string <var>$fichier_ini</var></span> )</code>
467 jpm 200
 
201
		<div class="description short">
202
 
203
<p>Charge un fichier ini dans le tableau des paramètres de l'appli</p>
204
 
205
		</div>
206
 
207
		<div class="description detailed hidden">
208
 
209
<p>Charge un fichier ini dans le tableau des paramètres de l'appli</p>
210
 
211
 
212
 
213
				<h4>Parameters</h4>
214
				<div class="list"><dl>
215
					<dt><var>$fichier_ini</var></dt>
216
					<dd><code>string</code><br>$fichier_ini le nom du fichier à charger</dd>
217
				</dl></div>
218
 
219
				<h4>Returns</h4>
220
				<div class="list">
221
					<code>array</code><br>le fichier ini parsé<br>
222
				</div>
223
 
224
 
225
 
226
 
227
		</div>
228
		</div></td>
229
	</tr>
230
	<tr data-order="get" id="_get">
231
 
232
		<td class="attributes"><code>
233
			 public static
234
			string
235
 
236
			</code>
237
		</td>
238
 
239
		<td class="name"><div>
240
		<a class="anchor" href="#_get">#</a>
476 jpm 241
		<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>
467 jpm 242
 
243
		<div class="description short">
244
 
245
<p>Acesseur pour la valeur d'un paramètre</p>
246
 
247
		</div>
248
 
249
		<div class="description detailed hidden">
250
 
251
<p>Acesseur pour la valeur d'un paramètre</p>
252
 
253
 
254
 
255
				<h4>Parameters</h4>
256
				<div class="list"><dl>
257
					<dt><var>$param</var></dt>
258
					<dd><code>string</code><br>$param le nom du paramètre</dd>
259
				</dl></div>
260
 
261
				<h4>Returns</h4>
262
				<div class="list">
263
					<code>string</code><br>la valeur du paramètre<br>
264
				</div>
265
 
266
 
267
 
268
 
269
		</div>
270
		</div></td>
271
	</tr>
272
	<tr data-order="existe" id="_existe">
273
 
274
		<td class="attributes"><code>
275
			 public static
276
			boolean
277
 
278
			</code>
279
		</td>
280
 
281
		<td class="name"><div>
282
		<a class="anchor" href="#_existe">#</a>
476 jpm 283
		<code><a href="source-class-Config.html#252-260" title="Go to source code">existe</a>( <span>string <var>$param</var></span> )</code>
467 jpm 284
 
285
		<div class="description short">
286
 
287
<p>Vérifie si la valeur d'un paramètre existe</p>
288
 
289
		</div>
290
 
291
		<div class="description detailed hidden">
292
 
293
<p>Vérifie si la valeur d'un paramètre existe</p>
294
 
295
 
296
 
297
				<h4>Parameters</h4>
298
				<div class="list"><dl>
299
					<dt><var>$param</var></dt>
300
					<dd><code>string</code><br>$param le nom du paramètre</dd>
301
				</dl></div>
302
 
303
				<h4>Returns</h4>
304
				<div class="list">
305
					<code>boolean</code><br>vrai si le paramètre existe, false sinon<br>
306
				</div>
307
 
308
 
309
 
310
 
311
		</div>
312
		</div></td>
313
	</tr>
314
	</table>
315
 
316
 
317
 
318
 
319
 
320
 
321
 
322
 
323
 
324
 
325
 
326
 
327
 
328
 
329
 
330
 
331
 
332
 
333
</div>
334
 
335
	<div id="footer">
336
		TBFramework - v0.2 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
337
	</div>
338
</div>
339
</div>
340
</body>
341
</html>