Subversion Repositories Applications.framework

Rev

Rev 300 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
159 jpm 1 
<html>
2 
<head>
3 
<title>Docs For Class Config</title>
4 
<meta http-equiv='Content-Type' content='text/html; charset=UTF-8'/>
5 
<link rel="stylesheet" type="text/css" href="../media/style.css">
6 
</head>
7 
<body>
8 
 
9 
<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
10 
  <tr>
11 
    <td class="header_top">Framework</td>
12 
  </tr>
13 
  <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
14 
  <tr>
15 
    <td class="header_menu">
16 
 
17 
 
297 jpm 18 
                                                                      		  [ <a href="../classtrees_Framework.html" class="menu">class tree: Framework</a> ]
159 jpm 19 
		  [ <a href="../elementindex_Framework.html" class="menu">index: Framework</a> ]
20 
		  	    [ <a href="../elementindex.html" class="menu">all elements</a> ]
21 
    </td>
22 
  </tr>
23 
  <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
24 
</table>
25 
 
26 
<table width="100%" border="0" cellpadding="0" cellspacing="0">
27 
  <tr valign="top">
28 
    <td width="200" class="menu">
297 jpm 29 
	<div id="todolist">
30 
			<p><a href="../todolist.html">Todo List</a></p>
31 
	</div>
159 jpm 32 
      <b>Packages:</b><br />
33 
              <a href="../li_Framework.html">Framework</a><br />
297 jpm 34 
              <a href="../li_Utilitaire.html">Utilitaire</a><br />
35 
              <a href="../li_Zend_OpenId.html">Zend_OpenId</a><br />
159 jpm 36 
            <br /><br />
37 
                        <b>Files:</b><br />
38 
      	  <div class="package">
297 jpm 39 
			<a href="../Framework/_Bdd.php.html">		Bdd.php
159 jpm 40 
		</a><br>
297 jpm 41 
			<a href="../Framework/_Cache.php.html">		Cache.php
159 jpm 42 
		</a><br>
297 jpm 43 
			<a href="../Framework/_CacheFichier.php.html">		CacheFichier.php
44 
		</a><br>
45 
			<a href="../Framework/_CacheSimple.php.html">		CacheSimple.php
46 
		</a><br>
47 
			<a href="../Framework/_CacheSqlite.php.html">		CacheSqlite.php
48 
		</a><br>
159 jpm 49 
			<a href="../Framework/_Chronometre.php.html">		Chronometre.php
50 
		</a><br>
297 jpm 51 
			<a href="../Framework/_Cli.php.html">		Cli.php
52 
		</a><br>
159 jpm 53 
			<a href="../Framework/_Config.php.html">		Config.php
54 
		</a><br>
55 
			<a href="../Framework/_Controleur.php.html">		Controleur.php
56 
		</a><br>
57 
			<a href="../Framework/_Debug.php.html">		Debug.php
58 
		</a><br>
297 jpm 59 
			<a href="../Framework/_utilitaires---DiffieHellmanUtil.php.html">		DiffieHellmanUtil.php
60 
		</a><br>
61 
			<a href="../Framework/_Framework.php.html">		Framework.php
62 
		</a><br>
159 jpm 63 
			<a href="../Framework/_GestionnaireException.php.html">		GestionnaireException.php
64 
		</a><br>
297 jpm 65 
			<a href="../Framework/_I18n.php.html">		I18n.php
66 
		</a><br>
159 jpm 67 
			<a href="../Framework/_Log.php.html">		Log.php
68 
		</a><br>
297 jpm 69 
			<a href="../Framework/_OpenIdClient.php.html">		OpenIdClient.php
159 jpm 70 
		</a><br>
71 
			<a href="../Framework/_Registre.php.html">		Registre.php
72 
		</a><br>
297 jpm 73 
			<a href="../Framework/_RestClient.php.html">		RestClient.php
74 
		</a><br>
75 
			<a href="../Framework/_RestServeur.php.html">		RestServeur.php
76 
		</a><br>
77 
			<a href="../Framework/_RestService.php.html">		RestService.php
78 
		</a><br>
79 
			<a href="../Framework/_Script.php.html">		Script.php
80 
		</a><br>
159 jpm 81 
			<a href="../Framework/_SquelettePhp.php.html">		SquelettePhp.php
82 
		</a><br>
83 
			<a href="../Framework/_Url.php.html">		Url.php
84 
		</a><br>
85 
	  </div><br />
86 
 
87 
 
88 
            <b>Classes:</b><br />
89 
        <div class="package">
297 jpm 90 
		    		<a href="../Framework/Bdd.html">Bdd</a><br />
91 
	    		<a href="../Framework/Cache.html">Cache</a><br />
92 
	    		<a href="../Framework/CacheFichier.html">CacheFichier</a><br />
93 
	    		<a href="../Framework/CacheSimple.html">CacheSimple</a><br />
94 
	    		<a href="../Framework/CacheSqlite.html">CacheSqlite</a><br />
159 jpm 95 
	    		<a href="../Framework/Chronometre.html">Chronometre</a><br />
297 jpm 96 
	    		<a href="../Framework/Cli.html">Cli</a><br />
159 jpm 97 
	    		<a href="../Framework/Config.html">Config</a><br />
98 
	    		<a href="../Framework/Controleur.html">Controleur</a><br />
99 
	    		<a href="../Framework/Debug.html">Debug</a><br />
297 jpm 100 
	    		<a href="../Framework/DiffieHellmanUtil.html">DiffieHellmanUtil</a><br />
101 
	    		<a href="../Framework/Framework.html">Framework</a><br />
159 jpm 102 
	    		<a href="../Framework/GestionnaireException.html">GestionnaireException</a><br />
297 jpm 103 
	    		<a href="../Framework/I18n.html">I18n</a><br />
159 jpm 104 
	    		<a href="../Framework/Log.html">Log</a><br />
297 jpm 105 
	    		<a href="../Framework/OpenIdClient.html">OpenIdClient</a><br />
159 jpm 106 
	    		<a href="../Framework/Registre.html">Registre</a><br />
297 jpm 107 
	    		<a href="../Framework/RestClient.html">RestClient</a><br />
108 
	    		<a href="../Framework/RestServeur.html">RestServeur</a><br />
109 
	    		<a href="../Framework/RestService.html">RestService</a><br />
110 
	    		<a href="../Framework/Script.html">Script</a><br />
159 jpm 111 
	    		<a href="../Framework/SquelettePhp.html">SquelettePhp</a><br />
112 
	    		<a href="../Framework/Url.html">Url</a><br />
113 
	  </div>
114 
                </td>
115 
    <td>
116 
      <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">
117 
 
118 
<h1>Class: Config</h1>
119 
Source Location: /Config.php<br /><br />
120 
 
121 
 
122 
<table width="100%" border="0">
123 
<tr><td valign="top">
124 
 
125 
<h3><a href="#class_details">Class Overview</a></h3>
126 
<pre></pre><br />
127 
<div class="description">Config permet de charger automatiquement les fichiers ini du Framework et de l'application.</div><br /><br />
128 
<h4>Author(s):</h4>
129 
<ul>
130 
          <li>Jean-Pascal MILCENT &lt;<a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a>&gt;</li>
297 jpm 131 
                                    </ul>
159 jpm 132 
 
133 
 
134 
 
135 
 
136 
 
137 
 
297 jpm 138 
 
159 jpm 139 
<h4>Version:</h4>
140 
<ul>
297 jpm 141 
  <li>$Id: Config.php 274 2010-12-28 15:37:22Z jpm $</li>
159 jpm 142 
</ul>
143 
 
144 
<h4>Copyright:</h4>
145 
<ul>
297 jpm 146 
  <li>Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)</li>
159 jpm 147 
</ul>
148 
 
149 
</td>
150 
 
151 
 
152 
 
153 
<td valign="top">
154 
<h3><a href="#class_methods">Methods</a></h3>
155 
<ul>
156 
    <li><a href="../Framework/Config.html#methodcharger">charger</a></li>
157 
    <li><a href="../Framework/Config.html#methodexiste">existe</a></li>
158 
    <li><a href="../Framework/Config.html#methodget">get</a></li>
297 jpm 159 
    <li><a href="../Framework/Config.html#methodverifierPresenceParametres">verifierPresenceParametres</a></li>
159 jpm 160 
  </ul>
161 
</td>
162 
 
163 
</tr></table>
164 
<hr />
165 
 
166 
<table width="100%" border="0"><tr>
167 
 
168 
 
169 
 
170 
 
171 
 
172 
 
173 
</tr></table>
174 
<hr />
175 
 
176 
<a name="class_details"></a>
177 
<h3>Class Details</h3>
178 
<div class="tags">
179 
[line <a href="../__filesource/fsource_Framework__Config.php.html#a19">19</a>]<br />
297 jpm 180 
Config permet de charger automatiquement les fichiers ini du Framework et de l'application.<br /><br /><p>Elle offre l'accès en lecture seule aux paramètres de config.  C'est une Singleton.  Si vous avez besoin de modifier dynamiquement des paramètres de configuration, utiliser le @see Registe, il est fait pour ça.</p><br /><br /><br />
159 jpm 181 
<h4>Tags:</h4>
182 
<div class="tags">
183 
<table border="0" cellspacing="0" cellpadding="0">
184 
  <tr>
185 
    <td><b>author:</b>&nbsp;&nbsp;</td><td>Jean-Pascal MILCENT &lt;<a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a>&gt;</td>
186 
  </tr>
187 
  <tr>
297 jpm 188 
    <td><b>version:</b>&nbsp;&nbsp;</td><td>$Id: Config.php 274 2010-12-28 15:37:22Z jpm $</td>
159 jpm 189 
  </tr>
190 
  <tr>
297 jpm 191 
    <td><b>copyright:</b>&nbsp;&nbsp;</td><td>Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)</td>
159 jpm 192 
  </tr>
193 
  <tr>
194 
    <td><b>link:</b>&nbsp;&nbsp;</td><td>/doc/framework/</td>
195 
  </tr>
196 
  <tr>
297 jpm 197 
    <td><b>license:</b>&nbsp;&nbsp;</td><td><a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL-v2</a></td>
159 jpm 198 
  </tr>
297 jpm 199 
  <tr>
200 
    <td><b>license:</b>&nbsp;&nbsp;</td><td><a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL-v3</a></td>
201 
  </tr>
159 jpm 202 
</table>
203 
</div>
204 
</div><br /><br />
205 
<div class="top">[ <a href="#top">Top</a> ]</div><br />
206 
 
207 
 
208 
<hr />
209 
<a name="class_methods"></a>
210 
<h3>Class Methods</h3>
211 
<div class="tags">
212 
  <hr />
213 
	<a name="methodcharger"></a>
297 jpm 214 
	<h3>static method charger <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Config.php.html#a235">235</a>]</span></h3>
159 jpm 215 
	<div class="function">
216 
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
217 
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
218 
		<code>static array charger(
219 
string
220 
$fichier_ini)</code>
221 
    </td></tr></table>
222 
    </td></tr></table><br />
223 
 
297 jpm 224 
		Charge un fichier ini dans le tableau des paramètres de l'appli.<br /><br /><br /><br />
159 jpm 225 
<h4>Tags:</h4>
226 
<div class="tags">
227 
<table border="0" cellspacing="0" cellpadding="0">
228 
  <tr>
229 
    <td><b>return:</b>&nbsp;&nbsp;</td><td>le fichier ini parsé</td>
230 
  </tr>
231 
  <tr>
232 
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
233 
  </tr>
234 
</table>
235 
</div>
236 
<br /><br />
237 
 
238 
 
239 
        <h4>Parameters:</h4>
240 
    <div class="tags">
241 
    <table border="0" cellspacing="0" cellpadding="0">
242 
          <tr>
243 
        <td class="type">string&nbsp;&nbsp;</td>
244 
        <td><b>$fichier_ini</b>&nbsp;&nbsp;</td>
245 
        <td>le nom du fichier à charger</td>
246 
      </tr>
247 
        </table>
248 
    </div><br />
249 
        <div class="top">[ <a href="#top">Top</a> ]</div>
250 
  </div>
251 
  <hr />
252 
	<a name="methodexiste"></a>
297 jpm 253 
	<h3>static method existe <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Config.php.html#a255">255</a>]</span></h3>
159 jpm 254 
	<div class="function">
255 
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
256 
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
257 
		<code>static boolean existe(
258 
string
259 
$param)</code>
260 
    </td></tr></table>
261 
    </td></tr></table><br />
262 
 
297 jpm 263 
		Vérifie si la valeur d'un paramètre existe.<br /><br /><br /><br />
159 jpm 264 
<h4>Tags:</h4>
265 
<div class="tags">
266 
<table border="0" cellspacing="0" cellpadding="0">
267 
  <tr>
268 
    <td><b>return:</b>&nbsp;&nbsp;</td><td>vrai si le paramètre existe, false sinon</td>
269 
  </tr>
270 
  <tr>
271 
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
272 
  </tr>
273 
</table>
274 
</div>
275 
<br /><br />
276 
 
277 
 
278 
        <h4>Parameters:</h4>
279 
    <div class="tags">
280 
    <table border="0" cellspacing="0" cellpadding="0">
281 
          <tr>
282 
        <td class="type">string&nbsp;&nbsp;</td>
283 
        <td><b>$param</b>&nbsp;&nbsp;</td>
284 
        <td>le nom du paramètre</td>
285 
      </tr>
286 
        </table>
287 
    </div><br />
288 
        <div class="top">[ <a href="#top">Top</a> ]</div>
289 
  </div>
290 
  <hr />
291 
	<a name="methodget"></a>
297 jpm 292 
	<h3>static method get <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Config.php.html#a245">245</a>]</span></h3>
159 jpm 293 
	<div class="function">
294 
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
295 
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
296 
		<code>static string get(
297 
[string
298 
$param = null])</code>
299 
    </td></tr></table>
300 
    </td></tr></table><br />
301 
 
297 jpm 302 
		Accesseur pour la valeur d'un paramètre.<br /><br /><br /><br />
159 jpm 303 
<h4>Tags:</h4>
304 
<div class="tags">
305 
<table border="0" cellspacing="0" cellpadding="0">
306 
  <tr>
307 
    <td><b>return:</b>&nbsp;&nbsp;</td><td>la valeur du paramètre</td>
308 
  </tr>
309 
  <tr>
310 
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
311 
  </tr>
312 
</table>
313 
</div>
314 
<br /><br />
315 
 
316 
 
317 
        <h4>Parameters:</h4>
318 
    <div class="tags">
319 
    <table border="0" cellspacing="0" cellpadding="0">
320 
          <tr>
321 
        <td class="type">string&nbsp;&nbsp;</td>
322 
        <td><b>$param</b>&nbsp;&nbsp;</td>
323 
        <td>le nom du paramètre</td>
324 
      </tr>
325 
        </table>
326 
    </div><br />
327 
        <div class="top">[ <a href="#top">Top</a> ]</div>
328 
  </div>
297 jpm 329 
  <hr />
330 
	<a name="methodverifierPresenceParametres"></a>
331 
	<h3>static method verifierPresenceParametres <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Config.php.html#a268">268</a>]</span></h3>
332 
	<div class="function">
333 
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
334 
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
335 
		<code>static boolean verifierPresenceParametres(
159 jpm 336 
 
297 jpm 337 
$parametres)</code>
338 
    </td></tr></table>
339 
    </td></tr></table><br />
340 
 
341 
		Vérifie que tous les paramêtres de config nécessaires au fonctionnement d'une classe existe dans les fichiers  de configurations.<br /><br /><p>L'utilisation de cette méthode depuis la classe Config évite de faire appel à une classe supplémentaire.</p><br /><br /><br />
342 
<h4>Tags:</h4>
343 
<div class="tags">
344 
<table border="0" cellspacing="0" cellpadding="0">
345 
  <tr>
346 
    <td><b>return:</b>&nbsp;&nbsp;</td><td>true si tous les paramétres sont présents sinon false.</td>
347 
  </tr>
348 
  <tr>
349 
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
350 
  </tr>
351 
</table>
352 
</div>
353 
<br /><br />
354 
 
355 
 
356 
        <h4>Parameters:</h4>
357 
    <div class="tags">
358 
    <table border="0" cellspacing="0" cellpadding="0">
359 
          <tr>
360 
        <td class="type">array&nbsp;&nbsp;</td>
361 
        <td><b>$parametres</b>&nbsp;&nbsp;</td>
362 
        <td>tableau des noms des paramètres de la config à verifier.</td>
363 
      </tr>
364 
        </table>
365 
    </div><br />
366 
        <div class="top">[ <a href="#top">Top</a> ]</div>
367 
  </div>
368 
 
159 jpm 369 
</div><br />
370 
 
371 
 
372 
        <div class="credit">
373 
		    <hr />
302 jpm 374 
		    Documentation generated on Tue, 18 Jan 2011 15:31:15 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.3</a>
159 jpm 375 
	      </div>
376 
      </td></tr></table>
377 
    </td>
378 
  </tr>
379 
</table>
380 
 
381 
</body>
382 
</html>