Subversion Repositories Applications.framework

Rev

Details | Last modification | View Log | RSS feed

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