Subversion Repositories Applications.framework

Rev

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

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