| 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 Config | 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 class="active"><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><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 Config</h1>
|
|
|
113 |
|
|
|
114 |
|
|
|
115 |
<div class="description">
|
|
|
116 |
|
|
|
117 |
<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.
|
|
|
119 |
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
|
|
|
121 |
ça.</p>
|
|
|
122 |
|
|
|
123 |
</div>
|
|
|
124 |
|
|
|
125 |
|
|
|
126 |
|
|
|
127 |
|
|
|
128 |
|
|
|
129 |
|
|
|
130 |
|
|
|
131 |
|
|
|
132 |
|
|
|
133 |
<div class="info">
|
|
|
134 |
|
|
|
135 |
|
|
|
136 |
|
|
|
137 |
<b>Package:</b> <a href="package-Framework.html">Framework</a><br>
|
|
|
138 |
|
|
|
139 |
<b>Category:</b>
|
|
|
140 |
PHP 5.2<br>
|
|
|
141 |
<b>Copyright:</b>
|
|
|
142 |
Copyright (c) 2009, Tela Botanica (<a
|
|
|
143 |
href="mailto:accueil@tela-botanica.org">accueil@<!-- -->tela-botanica.org</a>)<br>
|
|
|
144 |
<b>License:</b>
|
|
|
145 |
<a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL-v3</a><br>
|
|
|
146 |
<b>License:</b>
|
|
|
147 |
<a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL-v2</a><br>
|
|
|
148 |
<b>Author:</b>
|
|
|
149 |
Jean-Pascal MILCENT <<a
|
|
|
150 |
href="mailto:jpm@tela-botanica.org">jpm@<!-- -->tela-botanica.org</a>><br>
|
|
|
151 |
<b>Version:</b>
|
|
|
152 |
$Id: Config.php 447 2013-12-19 10:52:37Z jpm $<br>
|
|
|
153 |
<b>Link:</b>
|
|
|
154 |
/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>
|
|
|
156 |
</div>
|
|
|
157 |
|
|
|
158 |
|
|
|
159 |
|
|
|
160 |
<table class="summary" id="methods">
|
|
|
161 |
<caption>Methods summary</caption>
|
|
|
162 |
<tr data-order="charger" id="_charger">
|
|
|
163 |
|
|
|
164 |
<td class="attributes"><code>
|
|
|
165 |
public static
|
|
|
166 |
array
|
|
|
167 |
|
|
|
168 |
</code>
|
|
|
169 |
</td>
|
|
|
170 |
|
|
|
171 |
<td class="name"><div>
|
|
|
172 |
<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>
|
|
|
174 |
|
|
|
175 |
<div class="description short">
|
|
|
176 |
|
|
|
177 |
<p>Charge un fichier ini dans le tableau des paramètres de l'appli.</p>
|
|
|
178 |
|
|
|
179 |
</div>
|
|
|
180 |
|
|
|
181 |
<div class="description detailed hidden">
|
|
|
182 |
|
|
|
183 |
<p>Charge un fichier ini dans le tableau des paramètres de l'appli.</p>
|
|
|
184 |
|
|
|
185 |
|
|
|
186 |
|
|
|
187 |
<h4>Parameters</h4>
|
|
|
188 |
<div class="list"><dl>
|
|
|
189 |
<dt><var>$fichier_ini</var></dt>
|
|
|
190 |
<dd><code>string</code><br>$fichier_ini le nom du fichier à charger</dd>
|
|
|
191 |
</dl></div>
|
|
|
192 |
|
|
|
193 |
<h4>Returns</h4>
|
|
|
194 |
<div class="list">
|
|
|
195 |
<code>array</code><br>le fichier ini parsé<br>
|
|
|
196 |
</div>
|
|
|
197 |
|
|
|
198 |
|
|
|
199 |
|
|
|
200 |
|
|
|
201 |
</div>
|
|
|
202 |
</div></td>
|
|
|
203 |
</tr>
|
|
|
204 |
<tr data-order="get" id="_get">
|
|
|
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="#_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>
|
|
|
216 |
|
|
|
217 |
<div class="description short">
|
|
|
218 |
|
|
|
219 |
<p>Accesseur pour la valeur d'un paramètre.</p>
|
|
|
220 |
|
|
|
221 |
</div>
|
|
|
222 |
|
|
|
223 |
<div class="description detailed hidden">
|
|
|
224 |
|
|
|
225 |
<p>Accesseur pour la valeur d'un paramètre.</p>
|
|
|
226 |
|
|
|
227 |
|
|
|
228 |
|
|
|
229 |
<h4>Parameters</h4>
|
|
|
230 |
<div class="list"><dl>
|
|
|
231 |
<dt><var>$param</var></dt>
|
|
|
232 |
<dd><code>string</code><br>$param le nom du paramètre</dd>
|
|
|
233 |
</dl></div>
|
|
|
234 |
|
|
|
235 |
<h4>Returns</h4>
|
|
|
236 |
<div class="list">
|
|
|
237 |
<code>string</code><br>la valeur du paramètre<br>
|
|
|
238 |
</div>
|
|
|
239 |
|
|
|
240 |
|
|
|
241 |
|
|
|
242 |
|
|
|
243 |
</div>
|
|
|
244 |
</div></td>
|
|
|
245 |
</tr>
|
|
|
246 |
<tr data-order="existe" id="_existe">
|
|
|
247 |
|
|
|
248 |
<td class="attributes"><code>
|
|
|
249 |
public static
|
|
|
250 |
boolean
|
|
|
251 |
|
|
|
252 |
</code>
|
|
|
253 |
</td>
|
|
|
254 |
|
|
|
255 |
<td class="name"><div>
|
|
|
256 |
<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>
|
|
|
258 |
|
|
|
259 |
<div class="description short">
|
|
|
260 |
|
|
|
261 |
<p>Vérifie si la valeur d'un paramètre existe.</p>
|
|
|
262 |
|
|
|
263 |
</div>
|
|
|
264 |
|
|
|
265 |
<div class="description detailed hidden">
|
|
|
266 |
|
|
|
267 |
<p>Vérifie si la valeur d'un paramètre existe.</p>
|
|
|
268 |
|
|
|
269 |
|
|
|
270 |
|
|
|
271 |
<h4>Parameters</h4>
|
|
|
272 |
<div class="list"><dl>
|
|
|
273 |
<dt><var>$param</var></dt>
|
|
|
274 |
<dd><code>string</code><br>$param le nom du paramètre</dd>
|
|
|
275 |
</dl></div>
|
|
|
276 |
|
|
|
277 |
<h4>Returns</h4>
|
|
|
278 |
<div class="list">
|
|
|
279 |
<code>boolean</code><br>vrai si le paramètre existe, false sinon<br>
|
|
|
280 |
</div>
|
|
|
281 |
|
|
|
282 |
|
|
|
283 |
|
|
|
284 |
|
|
|
285 |
</div>
|
|
|
286 |
</div></td>
|
|
|
287 |
</tr>
|
|
|
288 |
<tr data-order="verifierPresenceParametres" id="_verifierPresenceParametres">
|
|
|
289 |
|
|
|
290 |
<td class="attributes"><code>
|
|
|
291 |
public static
|
|
|
292 |
boolean
|
|
|
293 |
|
|
|
294 |
</code>
|
|
|
295 |
</td>
|
|
|
296 |
|
|
|
297 |
<td class="name"><div>
|
|
|
298 |
<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>
|
|
|
300 |
|
|
|
301 |
<div class="description short">
|
|
|
302 |
|
|
|
303 |
<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
|
|
|
305 |
méthode depuis la classe Config évite de faire appel à une classe
|
|
|
306 |
supplémentaire.</p>
|
|
|
307 |
|
|
|
308 |
</div>
|
|
|
309 |
|
|
|
310 |
<div class="description detailed hidden">
|
|
|
311 |
|
|
|
312 |
<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
|
|
|
314 |
méthode depuis la classe Config évite de faire appel à une classe
|
|
|
315 |
supplémentaire.</p>
|
|
|
316 |
|
|
|
317 |
|
|
|
318 |
|
|
|
319 |
<h4>Parameters</h4>
|
|
|
320 |
<div class="list"><dl>
|
|
|
321 |
<dt><var>$parametres</var></dt>
|
|
|
322 |
<dd><code>array</code><br>$parametres tableau des noms des paramètres de la config à verifier.</dd>
|
|
|
323 |
</dl></div>
|
|
|
324 |
|
|
|
325 |
<h4>Returns</h4>
|
|
|
326 |
<div class="list">
|
|
|
327 |
<code>boolean</code><br>true si tous les paramétres sont présents sinon false.<br>
|
|
|
328 |
</div>
|
|
|
329 |
|
|
|
330 |
|
|
|
331 |
|
|
|
332 |
|
|
|
333 |
</div>
|
|
|
334 |
</div></td>
|
|
|
335 |
</tr>
|
|
|
336 |
</table>
|
|
|
337 |
|
|
|
338 |
|
|
|
339 |
|
|
|
340 |
|
|
|
341 |
|
|
|
342 |
|
|
|
343 |
|
|
|
344 |
|
|
|
345 |
|
|
|
346 |
|
|
|
347 |
|
|
|
348 |
|
|
|
349 |
|
|
|
350 |
|
|
|
351 |
|
|
|
352 |
|
|
|
353 |
|
|
|
354 |
|
|
|
355 |
</div>
|
|
|
356 |
|
|
|
357 |
<div id="footer">
|
|
|
358 |
TBFramework - v0.4 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
|
|
359 |
</div>
|
|
|
360 |
</div>
|
|
|
361 |
</div>
|
|
|
362 |
</body>
|
|
|
363 |
</html>
|