Subversion Repositories Applications.framework

Rev

Rev 464 | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 464 Rev 465
1
<!DOCTYPE html>
1
<!DOCTYPE html>
2
<html>
2
<html>
3
<head>
3
<head>
4
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
4
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
5
	<meta name="generator" content="ApiGen 2.8.0">
5
	<meta name="generator" content="ApiGen 2.8.0">
6
 
6
 
7
	<title>Class I18n | TBFramework - v0.4</title>
7
	<title>Class I18n</title>
8
 
8
 
9
	<script type="text/javascript" src="resources/combined.js?4205936287"></script>
9
	<script type="text/javascript" src="resources/combined.js?4205936287"></script>
10
	<script type="text/javascript" src="elementlist.js?1964084359"></script>
10
	<script type="text/javascript" src="elementlist.js?4111837732"></script>
11
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360">
11
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360">
12
 
12
 
13
</head>
13
</head>
14
 
14
 
15
<body>
15
<body>
16
<div id="left">
16
<div id="left">
17
	<div id="menu">
17
	<div id="menu">
18
		<a href="index.html" title="Overview"><span>Overview</span></a>
18
		<a href="index.html" title="Overview"><span>Overview</span></a>
19
 
19
 
20
 
20
 
21
		<div id="groups">
21
		<div id="groups">
22
			<h3>Packages</h3>
22
			<h3>Packages</h3>
23
			<ul>
23
			<ul>
24
				<li class="active"><a href="package-Framework.html">Framework</a>
24
				<li class="active"><a href="package-Framework.html">Framework</a>
25
						</li>
25
						</li>
26
				<li><a href="package-None.html">None</a>
26
				<li><a href="package-None.html">None</a>
27
						</li>
27
						</li>
28
				<li><a href="package-PHP.html">PHP</a>
28
				<li><a href="package-PHP.html">PHP</a>
29
						</li>
29
						</li>
30
				<li><a href="package-Utilitaire.html">Utilitaire</a>
30
				<li><a href="package-Utilitaire.html">Utilitaire</a>
31
						</li>
31
						</li>
32
			</ul>
32
			</ul>
33
		</div>
33
		</div>
34
 
34
 
35
		<hr>
35
		<hr>
36
 
36
 
37
 
37
 
38
		<div id="elements">
38
		<div id="elements">
39
			<h3>Classes</h3>
39
			<h3>Classes</h3>
40
			<ul>
40
			<ul>
41
				<li><a href="class-Bdd.html">Bdd</a></li>
41
				<li><a href="class-Bdd.html">Bdd</a></li>
42
				<li><a href="class-Cache.html">Cache</a></li>
42
				<li><a href="class-Cache.html">Cache</a></li>
43
				<li><a href="class-CacheSimple.html">CacheSimple</a></li>
43
				<li><a href="class-CacheSimple.html">CacheSimple</a></li>
44
				<li><a href="class-Chronometre.html">Chronometre</a></li>
44
				<li><a href="class-Chronometre.html">Chronometre</a></li>
45
				<li><a href="class-Cli.html">Cli</a></li>
45
				<li><a href="class-Cli.html">Cli</a></li>
46
				<li><a href="class-Config.html">Config</a></li>
46
				<li><a href="class-Config.html">Config</a></li>
47
				<li><a href="class-Controleur.html">Controleur</a></li>
47
				<li><a href="class-Controleur.html">Controleur</a></li>
48
				<li><a href="class-Debug.html">Debug</a></li>
48
				<li><a href="class-Debug.html">Debug</a></li>
49
				<li><a href="class-Framework.html">Framework</a></li>
49
				<li><a href="class-Framework.html">Framework</a></li>
50
				<li><a href="class-GestionnaireException.html">GestionnaireException</a></li>
50
				<li><a href="class-GestionnaireException.html">GestionnaireException</a></li>
51
				<li class="active"><a href="class-I18n.html">I18n</a></li>
51
				<li class="active"><a href="class-I18n.html">I18n</a></li>
52
				<li><a href="class-Log.html">Log</a></li>
52
				<li><a href="class-Log.html">Log</a></li>
53
				<li><a href="class-MonService.html">MonService</a></li>
-
 
54
				<li><a href="class-Registre.html">Registre</a></li>
53
				<li><a href="class-Registre.html">Registre</a></li>
55
				<li><a href="class-RestClient.html">RestClient</a></li>
54
				<li><a href="class-RestClient.html">RestClient</a></li>
56
				<li><a href="class-RestServeur.html">RestServeur</a></li>
55
				<li><a href="class-RestServeur.html">RestServeur</a></li>
57
				<li><a href="class-RestService.html">RestService</a></li>
56
				<li><a href="class-RestService.html">RestService</a></li>
58
				<li><a href="class-Script.html">Script</a></li>
57
				<li><a href="class-Script.html">Script</a></li>
59
				<li><a href="class-ServiceCacheFichier.html">ServiceCacheFichier</a></li>
-
 
60
				<li><a href="class-ServiceCacheSimple.html">ServiceCacheSimple</a></li>
-
 
61
				<li><a href="class-ServiceCacheSqlite.html">ServiceCacheSqlite</a></li>
-
 
62
				<li><a href="class-SquelettePhp.html">SquelettePhp</a></li>
58
				<li><a href="class-SquelettePhp.html">SquelettePhp</a></li>
63
				<li><a href="class-Url.html">Url</a></li>
59
				<li><a href="class-Url.html">Url</a></li>
64
			</ul>
60
			</ul>
65
 
61
 
66
 
62
 
67
 
63
 
68
 
64
 
69
 
65
 
70
		</div>
66
		</div>
71
	</div>
67
	</div>
72
</div>
68
</div>
73
 
69
 
74
<div id="splitter"></div>
70
<div id="splitter"></div>
75
 
71
 
76
<div id="right">
72
<div id="right">
77
<div id="rightInner">
73
<div id="rightInner">
78
	<form id="search">
74
	<form id="search">
79
		<input type="hidden" name="cx" value="">
75
		<input type="hidden" name="cx" value="">
80
		<input type="hidden" name="ie" value="UTF-8">
76
		<input type="hidden" name="ie" value="UTF-8">
81
		<input type="text" name="q" class="text">
77
		<input type="text" name="q" class="text">
82
		<input type="submit" value="Search">
78
		<input type="submit" value="Search">
83
	</form>
79
	</form>
84
 
80
 
85
	<div id="navigation">
81
	<div id="navigation">
86
		<ul>
82
		<ul>
87
			<li>
83
			<li>
88
				<a href="index.html" title="Overview"><span>Overview</span></a>
84
				<a href="index.html" title="Overview"><span>Overview</span></a>
89
			</li>
85
			</li>
90
			<li>
86
			<li>
91
				<a href="package-Framework.html" title="Summary of Framework"><span>Package</span></a>
87
				<a href="package-Framework.html" title="Summary of Framework"><span>Package</span></a>
92
			</li>
88
			</li>
93
			<li class="active">
89
			<li class="active">
94
<span>Class</span>			</li>
90
<span>Class</span>			</li>
95
		</ul>
91
		</ul>
96
		<ul>
92
		<ul>
97
			<li>
93
			<li>
98
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
94
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
99
			</li>
95
			</li>
100
			<li>
96
			<li>
101
				<a href="deprecated.html" title="List of deprecated elements"><span>Deprecated</span></a>
97
				<a href="deprecated.html" title="List of deprecated elements"><span>Deprecated</span></a>
102
			</li>
98
			</li>
103
			<li>
99
			<li>
104
				<a href="todo.html" title="Todo list"><span>Todo</span></a>
100
				<a href="todo.html" title="Todo list"><span>Todo</span></a>
105
			</li>
101
			</li>
106
		</ul>
102
		</ul>
107
		<ul>
103
		<ul>
108
		</ul>
104
		</ul>
109
	</div>
105
	</div>
110
 
106
 
111
<div id="content" class="class">
107
<div id="content" class="class">
112
	<h1>Class I18n</h1>
108
	<h1>Class I18n</h1>
113
 
109
 
114
 
110
 
115
	<div class="description">
111
	<div class="description">
116
	
112
	
117
<p>I18n permet de traduire une application à partir de données stockées dans
113
<p>I18n permet de traduire une application à partir de données stockées dans
118
des fichiers ini. Si vous souhaitez utiliser le fonctionnement par défaut vous
114
des fichiers ini. Si vous souhaitez utiliser le fonctionnement par défaut vous
119
devrez :</p>
115
devrez :</p>
120
 
116
 
121
<ul>
117
<ul>
122
	<li>déposer les fichiers ini dans le dossier définit par la variable de config
118
	<li>déposer les fichiers ini dans le dossier définit par la variable de config
123
	"chemin_i18n".</li>
119
	"chemin_i18n".</li>
124
 
120
 
125
	<li>nommer les fichiers selon la forme "locale.ini" (Ex.: fr.ini ou fr_CH.ini
121
	<li>nommer les fichiers selon la forme "locale.ini" (Ex.: fr.ini ou fr_CH.ini
126
	).</li>
122
	).</li>
127
</ul>
123
</ul>
128
 
124
 
129
<p>Elle offre l'accès en lecture seule aux paramètres des fichiers ini. C'est
125
<p>Elle offre l'accès en lecture seule aux paramètres des fichiers ini. C'est
130
une Singleton. Une seule classe de traduction peut être instanciée par
126
une Singleton. Une seule classe de traduction peut être instanciée par
131
Application.</p>
127
Application.</p>
132
 
128
 
133
	</div>
129
	</div>
134
 
130
 
135
 
131
 
136
 
132
 
137
 
133
 
138
 
134
 
139
 
135
 
140
 
136
 
141
 
137
 
142
 
138
 
143
	<div class="info">
139
	<div class="info">
144
		
140
		
145
		
141
		
146
		
142
		
147
		<b>Package:</b> <a href="package-Framework.html">Framework</a><br>
143
		<b>Package:</b> <a href="package-Framework.html">Framework</a><br>
148
 
144
 
149
				<b>Category:</b>
145
				<b>Category:</b>
150
				PHP 5.2<br>
146
				PHP 5.2<br>
151
				<b>Copyright:</b>
147
				<b>Copyright:</b>
152
				Copyright (c) 2010, Tela Botanica (<a
148
				Copyright (c) 2010, Tela Botanica (<a
153
href="mailto:accueil&#64;tela-botanica.org">accueil&#64;<!-- -->tela-botanica.org</a>)<br>
149
href="mailto:accueil&#64;tela-botanica.org">accueil&#64;<!-- -->tela-botanica.org</a>)<br>
154
				<b>License:</b>
150
				<b>License:</b>
155
				<a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL</a><br>
151
				<a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL</a><br>
156
				<b>License:</b>
152
				<b>License:</b>
157
				<a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL</a><br>
153
				<a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL</a><br>
158
				<b>Author:</b>
154
				<b>Author:</b>
159
				Jean-Pascal MILCENT &lt;<a
155
				Jean-Pascal MILCENT &lt;<a
160
href="mailto:jpm&#64;tela-botanica.org">jpm&#64;<!-- -->tela-botanica.org</a>&gt;<br>
156
href="mailto:jpm&#64;tela-botanica.org">jpm&#64;<!-- -->tela-botanica.org</a>&gt;<br>
161
				<b>Version:</b>
157
				<b>Version:</b>
162
				$Id: I18n.php 331 2011-02-24 18:03:35Z jpm $<br>
158
				$Id: I18n.php 331 2011-02-24 18:03:35Z jpm $<br>
163
				<b>Since:</b>
159
				<b>Since:</b>
164
				0.3<br>
160
				0.3<br>
165
				<b>Link:</b>
161
				<b>Link:</b>
166
				/doc/framework/<br>
162
				/doc/framework/<br>
167
		<b>Located at</b> <a href="source-class-I18n.html#3-234" title="Go to source code">framework/I18n.php</a><br>
163
		<b>Located at</b> <a href="source-class-I18n.html#3-234" title="Go to source code">I18n.php</a><br>
168
	</div>
164
	</div>
169
 
165
 
170
 
166
 
171
 
167
 
172
	<table class="summary" id="methods">
168
	<table class="summary" id="methods">
173
	<caption>Methods summary</caption>
169
	<caption>Methods summary</caption>
174
	<tr data-order="get" id="_get">
170
	<tr data-order="get" id="_get">
175
 
171
 
176
		<td class="attributes"><code>
172
		<td class="attributes"><code>
177
			 public static
173
			 public static
178
			string
174
			string
179
			
175
			
180
			</code>
176
			</code>
181
		</td>
177
		</td>
182
 
178
 
183
		<td class="name"><div>
179
		<td class="name"><div>
184
		<a class="anchor" href="#_get">#</a>
180
		<a class="anchor" href="#_get">#</a>
185
		<code><a href="source-class-I18n.html#43-80" title="Go to source code">get</a>( <span>string <var>$identifiant</var></span>, <span>mixed <var>$langue</var> = <span class="php-keyword1">null</span></span> )</code>
181
		<code><a href="source-class-I18n.html#43-80" title="Go to source code">get</a>( <span>string <var>$identifiant</var></span>, <span>mixed <var>$langue</var> = <span class="php-keyword1">null</span></span> )</code>
186
 
182
 
187
		<div class="description short">
183
		<div class="description short">
188
			
184
			
189
<p>Accesseur pour la valeur d'une traduction</p>
185
<p>Accesseur pour la valeur d'une traduction</p>
190
 
186
 
191
		</div>
187
		</div>
192
 
188
 
193
		<div class="description detailed hidden">
189
		<div class="description detailed hidden">
194
			
190
			
195
<p>Accesseur pour la valeur d'une traduction</p>
191
<p>Accesseur pour la valeur d'une traduction</p>
196
 
192
 
197
 
193
 
198
 
194
 
199
				<h4>Parameters</h4>
195
				<h4>Parameters</h4>
200
				<div class="list"><dl>
196
				<div class="list"><dl>
201
					<dt><var>$identifiant</var></dt>
197
					<dt><var>$identifiant</var></dt>
202
					<dd><code>string</code><br>$param le nom du paramètre</dd>
198
					<dd><code>string</code><br>$param le nom du paramètre</dd>
203
					<dt><var>$langue</var></dt>
199
					<dt><var>$langue</var></dt>
204
					<dd></dd>
200
					<dd></dd>
205
				</dl></div>
201
				</dl></div>
206
 
202
 
207
				<h4>Returns</h4>
203
				<h4>Returns</h4>
208
				<div class="list">
204
				<div class="list">
209
					<code>string</code><br>la valeur du paramètre<br>
205
					<code>string</code><br>la valeur du paramètre<br>
210
				</div>
206
				</div>
211
 
207
 
212
 
208
 
213
 
209
 
214
 
210
 
215
		</div>
211
		</div>
216
		</div></td>
212
		</div></td>
217
	</tr>
213
	</tr>
218
	<tr data-order="charger" id="_charger">
214
	<tr data-order="charger" id="_charger">
219
 
215
 
220
		<td class="attributes"><code>
216
		<td class="attributes"><code>
221
			 public static
217
			 public static
222
			boolean
218
			boolean
223
			
219
			
224
			</code>
220
			</code>
225
		</td>
221
		</td>
226
 
222
 
227
		<td class="name"><div>
223
		<td class="name"><div>
228
		<a class="anchor" href="#_charger">#</a>
224
		<a class="anchor" href="#_charger">#</a>
229
		<code><a href="source-class-I18n.html#82-105" title="Go to source code">charger</a>( <span>string <var>$langue</var></span>, <span>mixed <var>$fichier</var> = <span class="php-keyword1">null</span></span>, <span>mixed <var>$format</var> = <code><a href="class-I18n.html#FORMAT_INI">I18n::<b>FORMAT_INI</b></a></code></span> )</code>
225
		<code><a href="source-class-I18n.html#82-105" title="Go to source code">charger</a>( <span>string <var>$langue</var></span>, <span>mixed <var>$fichier</var> = <span class="php-keyword1">null</span></span>, <span>mixed <var>$format</var> = <code><a href="class-I18n.html#FORMAT_INI">I18n::<b>FORMAT_INI</b></a></code></span> )</code>
230
 
226
 
231
		<div class="description short">
227
		<div class="description short">
232
			
228
			
233
<p>Charge un fichier ini dans le tableau des paramètres de l'appli</p>
229
<p>Charge un fichier ini dans le tableau des paramètres de l'appli</p>
234
 
230
 
235
		</div>
231
		</div>
236
 
232
 
237
		<div class="description detailed hidden">
233
		<div class="description detailed hidden">
238
			
234
			
239
<p>Charge un fichier ini dans le tableau des paramètres de l'appli</p>
235
<p>Charge un fichier ini dans le tableau des paramètres de l'appli</p>
240
 
236
 
241
 
237
 
242
 
238
 
243
				<h4>Parameters</h4>
239
				<h4>Parameters</h4>
244
				<div class="list"><dl>
240
				<div class="list"><dl>
245
					<dt><var>$langue</var></dt>
241
					<dt><var>$langue</var></dt>
246
					<dd><code>string</code><br>$fichier_ini le nom du fichier à charger</dd>
242
					<dd><code>string</code><br>$fichier_ini le nom du fichier à charger</dd>
247
					<dt><var>$fichier</var></dt>
243
					<dt><var>$fichier</var></dt>
248
					<dd></dd>
244
					<dd></dd>
249
					<dt><var>$format</var></dt>
245
					<dt><var>$format</var></dt>
250
					<dd></dd>
246
					<dd></dd>
251
				</dl></div>
247
				</dl></div>
252
 
248
 
253
				<h4>Returns</h4>
249
				<h4>Returns</h4>
254
				<div class="list">
250
				<div class="list">
255
					<code>boolean</code><br>true, si le fichier a été trouvé et correctement chargé, sinon false.<br>
251
					<code>boolean</code><br>true, si le fichier a été trouvé et correctement chargé, sinon false.<br>
256
				</div>
252
				</div>
257
 
253
 
258
 
254
 
259
 
255
 
260
 
256
 
261
		</div>
257
		</div>
262
		</div></td>
258
		</div></td>
263
	</tr>
259
	</tr>
264
	<tr data-order="setLangue" id="_setLangue">
260
	<tr data-order="setLangue" id="_setLangue">
265
 
261
 
266
		<td class="attributes"><code>
262
		<td class="attributes"><code>
267
			 public static
263
			 public static
268
			array
264
			array
269
			
265
			
270
			</code>
266
			</code>
271
		</td>
267
		</td>
272
 
268
 
273
		<td class="name"><div>
269
		<td class="name"><div>
274
		<a class="anchor" href="#_setLangue">#</a>
270
		<a class="anchor" href="#_setLangue">#</a>
275
		<code><a href="source-class-I18n.html#107-115" title="Go to source code">setLangue</a>( <span>string <var>$langue</var></span> )</code>
271
		<code><a href="source-class-I18n.html#107-115" title="Go to source code">setLangue</a>( <span>string <var>$langue</var></span> )</code>
276
 
272
 
277
		<div class="description short">
273
		<div class="description short">
278
			
274
			
279
<p>Définit la langue utiliser pour rechercher une traduction.</p>
275
<p>Définit la langue utiliser pour rechercher une traduction.</p>
280
 
276
 
281
		</div>
277
		</div>
282
 
278
 
283
		<div class="description detailed hidden">
279
		<div class="description detailed hidden">
284
			
280
			
285
<p>Définit la langue utiliser pour rechercher une traduction.</p>
281
<p>Définit la langue utiliser pour rechercher une traduction.</p>
286
 
282
 
287
 
283
 
288
 
284
 
289
				<h4>Parameters</h4>
285
				<h4>Parameters</h4>
290
				<div class="list"><dl>
286
				<div class="list"><dl>
291
					<dt><var>$langue</var></dt>
287
					<dt><var>$langue</var></dt>
292
					<dd><code>string</code><br>$fichier_ini le nom du fichier à charger</dd>
288
					<dd><code>string</code><br>$fichier_ini le nom du fichier à charger</dd>
293
				</dl></div>
289
				</dl></div>
294
 
290
 
295
				<h4>Returns</h4>
291
				<h4>Returns</h4>
296
				<div class="list">
292
				<div class="list">
297
					<code>array</code><br>le fichier ini parsé<br>
293
					<code>array</code><br>le fichier ini parsé<br>
298
				</div>
294
				</div>
299
 
295
 
300
 
296
 
301
 
297
 
302
 
298
 
303
		</div>
299
		</div>
304
		</div></td>
300
		</div></td>
305
	</tr>
301
	</tr>
306
	</table>
302
	</table>
307
 
303
 
308
 
304
 
309
 
305
 
310
 
306
 
311
 
307
 
312
 
308
 
313
 
309
 
314
 
310
 
315
	<table class="summary" id="constants">
311
	<table class="summary" id="constants">
316
	<caption>Constants summary</caption>
312
	<caption>Constants summary</caption>
317
	<tr data-order="FORMAT_INI" id="FORMAT_INI">
313
	<tr data-order="FORMAT_INI" id="FORMAT_INI">
318
 
314
 
319
		<td class="attributes"><code>string</code></td>
315
		<td class="attributes"><code>string</code></td>
320
		<td class="name"><code>
316
		<td class="name"><code>
321
				<a href="source-class-I18n.html#23-24" title="Go to source code"><b>FORMAT_INI</b></a>
317
				<a href="source-class-I18n.html#23-24" title="Go to source code"><b>FORMAT_INI</b></a>
322
		</code></td>
318
		</code></td>
323
		<td class="value"><code><span class="php-quote">'.ini'</span></code></td>
319
		<td class="value"><code><span class="php-quote">'.ini'</span></code></td>
324
		<td class="description"><div>
320
		<td class="description"><div>
325
			<a href="#FORMAT_INI" class="anchor">#</a>
321
			<a href="#FORMAT_INI" class="anchor">#</a>
326
 
322
 
327
			<div class="description short">
323
			<div class="description short">
328
				
324
				
329
<p>Format de traduction utilisant les fichier .ini</p>
325
<p>Format de traduction utilisant les fichier .ini</p>
330
 
326
 
331
			</div>
327
			</div>
332
 
328
 
333
			<div class="description detailed hidden">
329
			<div class="description detailed hidden">
334
				
330
				
335
<p>Format de traduction utilisant les fichier .ini</p>
331
<p>Format de traduction utilisant les fichier .ini</p>
336
 
332
 
337
 
333
 
338
			</div>
334
			</div>
339
		</div></td>
335
		</div></td>
340
	</tr>
336
	</tr>
341
	</table>
337
	</table>
342
 
338
 
343
 
339
 
344
 
340
 
345
 
341
 
346
 
342
 
347
 
343
 
348
 
344
 
349
 
345
 
350
 
346
 
351
 
347
 
352
</div>
348
</div>
353
 
349
 
354
	<div id="footer">
350
	<div id="footer">
355
		TBFramework - v0.4 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
351
		 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
356
	</div>
352
	</div>
357
</div>
353
</div>
358
</div>
354
</div>
359
</body>
355
</body>
360
</html>
356
</html>