| 159 |
jpm |
1 |
<?xml version="1.0" encoding="UTF-8"?>
|
|
|
2 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
3 |
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
|
4 |
<head>
|
|
|
5 |
<!-- template designed by Marco Von Ballmoos -->
|
|
|
6 |
<title>Docs For Class Config</title>
|
|
|
7 |
<meta http-equiv='Content-Type' content='text/html; charset=UTF-8'/>
|
|
|
8 |
<link rel="stylesheet" href="../media/stylesheet.css" />
|
|
|
9 |
<script src="../media/lib/classTree.js"></script>
|
|
|
10 |
<script language="javascript" type="text/javascript">
|
|
|
11 |
var imgPlus = new Image();
|
|
|
12 |
var imgMinus = new Image();
|
|
|
13 |
imgPlus.src = "../media/images/plus.png";
|
|
|
14 |
imgMinus.src = "../media/images/minus.png";
|
|
|
15 |
|
|
|
16 |
function showNode(Node){
|
|
|
17 |
switch(navigator.family){
|
|
|
18 |
case 'nn4':
|
|
|
19 |
// Nav 4.x code fork...
|
|
|
20 |
var oTable = document.layers["span" + Node];
|
|
|
21 |
var oImg = document.layers["img" + Node];
|
|
|
22 |
break;
|
|
|
23 |
case 'ie4':
|
|
|
24 |
// IE 4/5 code fork...
|
|
|
25 |
var oTable = document.all["span" + Node];
|
|
|
26 |
var oImg = document.all["img" + Node];
|
|
|
27 |
break;
|
|
|
28 |
case 'gecko':
|
|
|
29 |
// Standards Compliant code fork...
|
|
|
30 |
var oTable = document.getElementById("span" + Node);
|
|
|
31 |
var oImg = document.getElementById("img" + Node);
|
|
|
32 |
break;
|
|
|
33 |
}
|
|
|
34 |
oImg.src = imgMinus.src;
|
|
|
35 |
oTable.style.display = "block";
|
|
|
36 |
}
|
|
|
37 |
|
|
|
38 |
function hideNode(Node){
|
|
|
39 |
switch(navigator.family){
|
|
|
40 |
case 'nn4':
|
|
|
41 |
// Nav 4.x code fork...
|
|
|
42 |
var oTable = document.layers["span" + Node];
|
|
|
43 |
var oImg = document.layers["img" + Node];
|
|
|
44 |
break;
|
|
|
45 |
case 'ie4':
|
|
|
46 |
// IE 4/5 code fork...
|
|
|
47 |
var oTable = document.all["span" + Node];
|
|
|
48 |
var oImg = document.all["img" + Node];
|
|
|
49 |
break;
|
|
|
50 |
case 'gecko':
|
|
|
51 |
// Standards Compliant code fork...
|
|
|
52 |
var oTable = document.getElementById("span" + Node);
|
|
|
53 |
var oImg = document.getElementById("img" + Node);
|
|
|
54 |
break;
|
|
|
55 |
}
|
|
|
56 |
oImg.src = imgPlus.src;
|
|
|
57 |
oTable.style.display = "none";
|
|
|
58 |
}
|
|
|
59 |
|
|
|
60 |
function nodeIsVisible(Node){
|
|
|
61 |
switch(navigator.family){
|
|
|
62 |
case 'nn4':
|
|
|
63 |
// Nav 4.x code fork...
|
|
|
64 |
var oTable = document.layers["span" + Node];
|
|
|
65 |
break;
|
|
|
66 |
case 'ie4':
|
|
|
67 |
// IE 4/5 code fork...
|
|
|
68 |
var oTable = document.all["span" + Node];
|
|
|
69 |
break;
|
|
|
70 |
case 'gecko':
|
|
|
71 |
// Standards Compliant code fork...
|
|
|
72 |
var oTable = document.getElementById("span" + Node);
|
|
|
73 |
break;
|
|
|
74 |
}
|
|
|
75 |
return (oTable && oTable.style.display == "block");
|
|
|
76 |
}
|
|
|
77 |
|
|
|
78 |
function toggleNodeVisibility(Node){
|
|
|
79 |
if (nodeIsVisible(Node)){
|
|
|
80 |
hideNode(Node);
|
|
|
81 |
}else{
|
|
|
82 |
showNode(Node);
|
|
|
83 |
}
|
|
|
84 |
}
|
|
|
85 |
</script>
|
|
|
86 |
</head>
|
|
|
87 |
<body>
|
|
|
88 |
<div class="page-body">
|
|
|
89 |
<h2 class="class-name">Class Config</h2>
|
|
|
90 |
|
|
|
91 |
<a name="sec-description"></a>
|
|
|
92 |
<div class="info-box">
|
|
|
93 |
<div class="info-box-title">Description</div>
|
|
|
94 |
<div class="nav-bar">
|
|
|
95 |
<span class="disabled">Description</span> |
|
|
|
96 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
97 |
|
|
|
98 |
</div>
|
|
|
99 |
<div class="info-box-body">
|
|
|
100 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
101 |
<p class="short-description">Config permet de charger automatiquement les fichiers ini du Framework et de l'application.</p>
|
| 297 |
jpm |
102 |
<p class="description"><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></p>
|
| 159 |
jpm |
103 |
<ul class="tags">
|
|
|
104 |
<li><span class="field">author:</span> Jean-Pascal MILCENT <<a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a>></li>
|
| 297 |
jpm |
105 |
<li><span class="field">version:</span> $Id: Config.php 274 2010-12-28 15:37:22Z jpm $</li>
|
|
|
106 |
<li><span class="field">copyright:</span> Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)</li>
|
| 159 |
jpm |
107 |
<li><span class="field">link:</span> /doc/framework/</li>
|
| 297 |
jpm |
108 |
<li><span class="field">license:</span> <a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL-v2</a></li>
|
|
|
109 |
<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL-v3</a></li>
|
| 159 |
jpm |
110 |
</ul>
|
|
|
111 |
<p class="notes">
|
|
|
112 |
Located in <a class="field" href="_Config.php.html">/Config.php</a> (line <span class="field"><a href="../__filesource/fsource_Framework__Config.php.html#a19">19</a></span>)
|
|
|
113 |
</p>
|
|
|
114 |
|
|
|
115 |
|
|
|
116 |
<pre></pre>
|
|
|
117 |
|
|
|
118 |
</div>
|
|
|
119 |
</div>
|
|
|
120 |
|
|
|
121 |
|
|
|
122 |
|
|
|
123 |
|
|
|
124 |
<a name="sec-method-summary"></a>
|
|
|
125 |
<div class="info-box">
|
|
|
126 |
<div class="info-box-title">Method Summary</span></div>
|
|
|
127 |
<div class="nav-bar">
|
|
|
128 |
<a href="#sec-description">Description</a> |
|
|
|
129 |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
|
|
130 |
</div>
|
|
|
131 |
<div class="info-box-body">
|
|
|
132 |
<div class="method-summary">
|
|
|
133 |
|
|
|
134 |
<div class="method-definition">
|
|
|
135 |
static <span class="method-result">array</span>
|
|
|
136 |
<a href="#charger" title="details" class="method-name">charger</a>
|
|
|
137 |
(<span class="var-type">string</span> <span class="var-name">$fichier_ini</span>)
|
|
|
138 |
</div>
|
|
|
139 |
|
|
|
140 |
<div class="method-definition">
|
|
|
141 |
static <span class="method-result">boolean</span>
|
|
|
142 |
<a href="#existe" title="details" class="method-name">existe</a>
|
|
|
143 |
(<span class="var-type">string</span> <span class="var-name">$param</span>)
|
|
|
144 |
</div>
|
|
|
145 |
|
|
|
146 |
<div class="method-definition">
|
|
|
147 |
static <span class="method-result">string</span>
|
|
|
148 |
<a href="#get" title="details" class="method-name">get</a>
|
|
|
149 |
([<span class="var-type">string</span> <span class="var-name">$param</span> = <span class="var-default">null</span>])
|
|
|
150 |
</div>
|
| 297 |
jpm |
151 |
|
|
|
152 |
<div class="method-definition">
|
|
|
153 |
static <span class="method-result">boolean</span>
|
|
|
154 |
<a href="#verifierPresenceParametres" title="details" class="method-name">verifierPresenceParametres</a>
|
|
|
155 |
(<span class="var-type"></span> <span class="var-name">$parametres</span>)
|
|
|
156 |
</div>
|
|
|
157 |
</div>
|
| 159 |
jpm |
158 |
</div>
|
|
|
159 |
</div>
|
|
|
160 |
|
|
|
161 |
|
|
|
162 |
<a name="sec-methods"></a>
|
|
|
163 |
<div class="info-box">
|
|
|
164 |
<div class="info-box-title">Methods</div>
|
|
|
165 |
<div class="nav-bar">
|
|
|
166 |
<a href="#sec-description">Description</a> |
|
|
|
167 |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
|
|
168 |
|
|
|
169 |
</div>
|
|
|
170 |
<div class="info-box-body">
|
|
|
171 |
<A NAME='method_detail'></A>
|
|
|
172 |
<a name="methodcharger" id="charger"><!-- --></a>
|
| 297 |
jpm |
173 |
<div class="oddrow">
|
| 159 |
jpm |
174 |
|
|
|
175 |
<div class="method-header">
|
| 297 |
jpm |
176 |
<span class="method-title">static charger</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Config.php.html#a235">235</a></span>)
|
| 159 |
jpm |
177 |
</div>
|
|
|
178 |
|
|
|
179 |
<!-- ========== Info from phpDoc block ========= -->
|
| 297 |
jpm |
180 |
<p class="short-description">Charge un fichier ini dans le tableau des paramètres de l'appli.</p>
|
| 159 |
jpm |
181 |
<ul class="tags">
|
|
|
182 |
<li><span class="field">return:</span> le fichier ini parsé</li>
|
|
|
183 |
<li><span class="field">access:</span> public</li>
|
|
|
184 |
</ul>
|
|
|
185 |
|
|
|
186 |
<div class="method-signature">
|
|
|
187 |
static <span class="method-result">array</span>
|
|
|
188 |
<span class="method-name">
|
|
|
189 |
charger
|
|
|
190 |
</span>
|
|
|
191 |
(<span class="var-type">string</span> <span class="var-name">$fichier_ini</span>)
|
|
|
192 |
</div>
|
|
|
193 |
|
|
|
194 |
<ul class="parameters">
|
|
|
195 |
<li>
|
|
|
196 |
<span class="var-type">string</span>
|
|
|
197 |
<span class="var-name">$fichier_ini</span><span class="var-description">: le nom du fichier à charger</span> </li>
|
|
|
198 |
</ul>
|
|
|
199 |
|
|
|
200 |
|
|
|
201 |
</div>
|
|
|
202 |
<a name="methodexiste" id="existe"><!-- --></a>
|
| 297 |
jpm |
203 |
<div class="evenrow">
|
| 159 |
jpm |
204 |
|
|
|
205 |
<div class="method-header">
|
| 297 |
jpm |
206 |
<span class="method-title">static existe</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Config.php.html#a255">255</a></span>)
|
| 159 |
jpm |
207 |
</div>
|
|
|
208 |
|
|
|
209 |
<!-- ========== Info from phpDoc block ========= -->
|
| 297 |
jpm |
210 |
<p class="short-description">Vérifie si la valeur d'un paramètre existe.</p>
|
| 159 |
jpm |
211 |
<ul class="tags">
|
|
|
212 |
<li><span class="field">return:</span> vrai si le paramètre existe, false sinon</li>
|
|
|
213 |
<li><span class="field">access:</span> public</li>
|
|
|
214 |
</ul>
|
|
|
215 |
|
|
|
216 |
<div class="method-signature">
|
|
|
217 |
static <span class="method-result">boolean</span>
|
|
|
218 |
<span class="method-name">
|
|
|
219 |
existe
|
|
|
220 |
</span>
|
|
|
221 |
(<span class="var-type">string</span> <span class="var-name">$param</span>)
|
|
|
222 |
</div>
|
|
|
223 |
|
|
|
224 |
<ul class="parameters">
|
|
|
225 |
<li>
|
|
|
226 |
<span class="var-type">string</span>
|
|
|
227 |
<span class="var-name">$param</span><span class="var-description">: le nom du paramètre</span> </li>
|
|
|
228 |
</ul>
|
|
|
229 |
|
|
|
230 |
|
|
|
231 |
</div>
|
|
|
232 |
<a name="methodget" id="get"><!-- --></a>
|
| 297 |
jpm |
233 |
<div class="oddrow">
|
| 159 |
jpm |
234 |
|
|
|
235 |
<div class="method-header">
|
| 297 |
jpm |
236 |
<span class="method-title">static get</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Config.php.html#a245">245</a></span>)
|
| 159 |
jpm |
237 |
</div>
|
|
|
238 |
|
|
|
239 |
<!-- ========== Info from phpDoc block ========= -->
|
| 297 |
jpm |
240 |
<p class="short-description">Accesseur pour la valeur d'un paramètre.</p>
|
| 159 |
jpm |
241 |
<ul class="tags">
|
|
|
242 |
<li><span class="field">return:</span> la valeur du paramètre</li>
|
|
|
243 |
<li><span class="field">access:</span> public</li>
|
|
|
244 |
</ul>
|
|
|
245 |
|
|
|
246 |
<div class="method-signature">
|
|
|
247 |
static <span class="method-result">string</span>
|
|
|
248 |
<span class="method-name">
|
|
|
249 |
get
|
|
|
250 |
</span>
|
|
|
251 |
([<span class="var-type">string</span> <span class="var-name">$param</span> = <span class="var-default">null</span>])
|
|
|
252 |
</div>
|
|
|
253 |
|
|
|
254 |
<ul class="parameters">
|
|
|
255 |
<li>
|
|
|
256 |
<span class="var-type">string</span>
|
|
|
257 |
<span class="var-name">$param</span><span class="var-description">: le nom du paramètre</span> </li>
|
|
|
258 |
</ul>
|
|
|
259 |
|
|
|
260 |
|
|
|
261 |
</div>
|
| 297 |
jpm |
262 |
<a name="methodverifierPresenceParametres" id="verifierPresenceParametres"><!-- --></a>
|
|
|
263 |
<div class="evenrow">
|
|
|
264 |
|
|
|
265 |
<div class="method-header">
|
|
|
266 |
<span class="method-title">static verifierPresenceParametres</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Config.php.html#a268">268</a></span>)
|
|
|
267 |
</div>
|
|
|
268 |
|
|
|
269 |
<!-- ========== Info from phpDoc block ========= -->
|
|
|
270 |
<p class="short-description">Vérifie que tous les paramêtres de config nécessaires au fonctionnement d'une classe existe dans les fichiers de configurations.</p>
|
|
|
271 |
<p class="description"><p>L'utilisation de cette méthode depuis la classe Config évite de faire appel à une classe supplémentaire.</p></p>
|
|
|
272 |
<ul class="tags">
|
|
|
273 |
<li><span class="field">return:</span> true si tous les paramétres sont présents sinon false.</li>
|
|
|
274 |
<li><span class="field">access:</span> public</li>
|
|
|
275 |
</ul>
|
|
|
276 |
|
|
|
277 |
<div class="method-signature">
|
|
|
278 |
static <span class="method-result">boolean</span>
|
|
|
279 |
<span class="method-name">
|
|
|
280 |
verifierPresenceParametres
|
|
|
281 |
</span>
|
|
|
282 |
(<span class="var-type"></span> <span class="var-name">$parametres</span>)
|
|
|
283 |
</div>
|
|
|
284 |
|
|
|
285 |
<ul class="parameters">
|
|
|
286 |
<li>
|
|
|
287 |
<span class="var-type">array</span>
|
|
|
288 |
<span class="var-name">$parametres</span><span class="var-description">: tableau des noms des paramètres de la config à verifier.</span> </li>
|
|
|
289 |
</ul>
|
|
|
290 |
|
|
|
291 |
|
|
|
292 |
</div>
|
| 159 |
jpm |
293 |
|
|
|
294 |
</div>
|
|
|
295 |
</div>
|
|
|
296 |
|
|
|
297 |
|
|
|
298 |
<p class="notes" id="credit">
|
| 297 |
jpm |
299 |
Documentation generated on Tue, 18 Jan 2011 15:01:30 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
|
| 159 |
jpm |
300 |
</p>
|
|
|
301 |
</div></body>
|
|
|
302 |
</html>
|