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
297 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 I18n</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 I18n</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
											<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
98
 
99
			</div>
100
	<div class="info-box-body">
101
        		<!-- ========== Info from phpDoc block ========= -->
102
<p class="short-description">I18n permet de traduire une application à partir de données stockées dans des fichiers ini.</p>
103
<p class="description"><p>Si vous souhaitez utiliser le fonctionnement par défaut vous devrez : <ul><li>déposer les fichiers ini dans le dossier définit par la variable de config &quot;chemin_i18n&quot;.</li><li>nommer les fichiers selon la forme &quot;locale.ini&quot; (Ex.: fr.ini ou fr_CH.ini ).</li></ul>  Elle offre l'accès en lecture seule aux paramètres des fichiers ini.  C'est une Singleton. Une seule classe de traduction peut être instanciée par Application.</p></p>
104
	<ul class="tags">
105
				<li><span class="field">author:</span> Jean-Pascal MILCENT &lt;<a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a>&gt;</li>
300 jpm 106
				<li><span class="field">version:</span> $Id: I18n.php 299 2011-01-18 14:03:46Z jpm $</li>
297 jpm 107
				<li><span class="field">copyright:</span> Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</li>
108
				<li><span class="field">link:</span> /doc/framework/</li>
109
				<li><span class="field">since:</span> 0.3</li>
110
				<li><span class="field">license:</span> <a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL</a></li>
111
				<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL</a></li>
112
			</ul>
113
		<p class="notes">
114
			Located in <a class="field" href="_I18n.php.html">/I18n.php</a> (line <span class="field"><a href="../__filesource/fsource_Framework__I18n.php.html#a22">22</a></span>)
115
		</p>
116
 
117
 
118
		<pre></pre>
119
 
120
			</div>
121
</div>
122
 
123
 
124
	<a name="sec-const-summary"></a>
125
	<div class="info-box">
126
		<div class="info-box-title">Class Constant Summary</span></div>
127
		<div class="nav-bar">
128
			<a href="#sec-description">Description</a> |
129
						<span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
130
										|
131
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
132
 
133
					</div>
134
		<div class="info-box-body">
135
			<div class="const-summary">
136
								<div class="const-title">
137
					<img src="../media/images/Constant.png" alt=" " />
138
					<a href="#FORMAT_INI" title="details" class="const-name">FORMAT_INI</a> = 					<span class="var-type"> '.ini'</span>
139
 
140
				</div>
141
							</div>
142
		</div>
143
	</div>
144
 
145
 
146
	<a name="sec-method-summary"></a>
147
	<div class="info-box">
148
		<div class="info-box-title">Method Summary</span></div>
149
		<div class="nav-bar">
150
			<a href="#sec-description">Description</a> |
151
															<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
152
 
153
									<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
154
		</div>
155
		<div class="info-box-body">
156
			<div class="method-summary">
157
 
158
				<div class="method-definition">
159
					static 						<span class="method-result">boolean</span>
160
										<a href="#charger" title="details" class="method-name">charger</a>
161
											(<span class="var-type"></span>&nbsp;<span class="var-name">$langue</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$fichier</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$format</span> = <span class="var-default">self::FORMAT_INI</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$fichier_ini</span>)
162
									</div>
163
 
164
				<div class="method-definition">
165
					static 						<span class="method-result">string</span>
166
										<a href="#get" title="details" class="method-name">get</a>
167
											(<span class="var-type"></span>&nbsp;<span class="var-name">$identifiant</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$langue</span> = <span class="var-default">null</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$param</span>)
168
									</div>
169
 
170
				<div class="method-definition">
171
					static 						<span class="method-result">array</span>
172
										<a href="#setLangue" title="details" class="method-name">setLangue</a>
173
											(<span class="var-type"></span>&nbsp;<span class="var-name">$langue</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$fichier_ini</span>)
174
									</div>
175
																																							</div>
176
		</div>
177
	</div>
178
 
179
 
180
	<a name="sec-methods"></a>
181
	<div class="info-box">
182
		<div class="info-box-title">Methods</div>
183
		<div class="nav-bar">
184
			<a href="#sec-description">Description</a> |
185
																		<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
186
 
187
										<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
188
 
189
		</div>
190
		<div class="info-box-body">
191
			<A NAME='method_detail'></A>
192
<a name="methodcharger" id="charger"><!-- --></a>
193
<div class="oddrow">
194
 
195
	<div class="method-header">
196
		<span class="method-title">static charger</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__I18n.php.html#a87">87</a></span>)
197
	</div>
198
 
199
	<!-- ========== Info from phpDoc block ========= -->
200
<p class="short-description">Charge un fichier ini dans le tableau des paramètres de l'appli</p>
201
	<ul class="tags">
202
				<li><span class="field">return:</span> true, si le fichier a été trouvé et correctement chargé, sinon false.</li>
203
				<li><span class="field">access:</span> public</li>
204
			</ul>
205
 
206
	<div class="method-signature">
207
		static <span class="method-result">boolean</span>
208
		<span class="method-name">
209
			charger
210
		</span>
211
					(<span class="var-type"></span>&nbsp;<span class="var-name">$langue</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$fichier</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$format</span> = <span class="var-default">self::FORMAT_INI</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$fichier_ini</span>)
212
			</div>
213
 
214
			<ul class="parameters">
215
					<li>
216
				<span class="var-type">string</span>
217
				<span class="var-name">$fichier_ini</span><span class="var-description">: le nom du fichier à charger</span>			</li>
218
					<li>
219
				<span class="var-type"></span>
220
				<span class="var-name">$langue</span>			</li>
221
					<li>
222
				<span class="var-type"></span>
223
				<span class="var-name">$fichier</span>			</li>
224
					<li>
225
				<span class="var-type"></span>
226
				<span class="var-name">$format</span>			</li>
227
				</ul>
228
 
229
 
230
	</div>
231
<a name="methodget" id="get"><!-- --></a>
232
<div class="evenrow">
233
 
234
	<div class="method-header">
235
		<span class="method-title">static get</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__I18n.php.html#a48">48</a></span>)
236
	</div>
237
 
238
	<!-- ========== Info from phpDoc block ========= -->
239
<p class="short-description">Accesseur pour la valeur d'une traduction</p>
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"></span>&nbsp;<span class="var-name">$identifiant</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$langue</span> = <span class="var-default">null</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$param</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
					<li>
258
				<span class="var-type"></span>
259
				<span class="var-name">$identifiant</span>			</li>
260
					<li>
261
				<span class="var-type"></span>
262
				<span class="var-name">$langue</span>			</li>
263
				</ul>
264
 
265
 
266
	</div>
267
<a name="methodsetLangue" id="setLangue"><!-- --></a>
268
<div class="oddrow">
269
 
270
	<div class="method-header">
271
		<span class="method-title">static setLangue</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__I18n.php.html#a112">112</a></span>)
272
	</div>
273
 
274
	<!-- ========== Info from phpDoc block ========= -->
275
<p class="short-description">Définit la langue utiliser pour rechercher une traduction.</p>
276
	<ul class="tags">
277
				<li><span class="field">return:</span> le fichier ini parsé</li>
278
				<li><span class="field">access:</span> public</li>
279
			</ul>
280
 
281
	<div class="method-signature">
282
		static <span class="method-result">array</span>
283
		<span class="method-name">
284
			setLangue
285
		</span>
286
					(<span class="var-type"></span>&nbsp;<span class="var-name">$langue</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$fichier_ini</span>)
287
			</div>
288
 
289
			<ul class="parameters">
290
					<li>
291
				<span class="var-type">string</span>
292
				<span class="var-name">$fichier_ini</span><span class="var-description">: le nom du fichier à charger</span>			</li>
293
					<li>
294
				<span class="var-type"></span>
295
				<span class="var-name">$langue</span>			</li>
296
				</ul>
297
 
298
 
299
	</div>
300
 
301
		</div>
302
	</div>
303
 
304
	<a name="sec-consts"></a>
305
	<div class="info-box">
306
		<div class="info-box-title">Class Constants</div>
307
		<div class="nav-bar">
308
			<a href="#sec-description">Description</a> |
309
										<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
310
 
311
 
312
										|
313
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
314
 
315
					</div>
316
		<div class="info-box-body">
317
			<a name="constFORMAT_INI" id="FORMAT_INI"><!-- --></A>
318
<div class="evenrow">
319
 
320
	<div class="const-header">
321
		<img src="../media/images/Variable.png" />
322
		<span class="const-title">
323
			<span class="const-name">FORMAT_INI</span>
324
			 = <span class="const-default"> '.ini'</span>
325
			(line <span class="line-number"><a href="../__filesource/fsource_Framework__I18n.php.html#a24">24</a></span>)
326
		</span>
327
	</div>
328
 
329
	<!-- ========== Info from phpDoc block ========= -->
330
<p class="short-description">Format de traduction utilisant les fichier .ini</p>
331
 
332
 
333
</div>
334
 
335
		</div>
336
	</div>
337
 
338
	<p class="notes" id="credit">
302 jpm 339
		Documentation generated on Tue, 18 Jan 2011 15:30:51 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
297 jpm 340
	</p>
341
	</div></body>
342
</html>