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
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 Log</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 Log</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 ========= -->
297 jpm 100
<p class="short-description">Classe permettant de logger des messages dans les fichier situés dans le dossier de log.</p>
159 jpm 101
	<ul class="tags">
297 jpm 102
				<li><span class="field">author:</span> Jean-Pascal MILCENT &lt;<a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a>&gt;</li>
103
				<li><span class="field">author:</span> Aurélien PERONNET &lt;<a href="mailto:aurelien@tela-botanica.org">aurelien@tela-botanica.org</a>&gt;</li>
104
				<li><span class="field">version:</span> $Id: Log.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.gnu.org/licenses/gpl.html">Licence GNU-GPL</a></li>
159 jpm 108
				<li><span class="field">license:</span> <a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL</a></li>
109
			</ul>
110
		<p class="notes">
297 jpm 111
			Located in <a class="field" href="_Log.php.html">/Log.php</a> (line <span class="field"><a href="../__filesource/fsource_Framework__Log.php.html#a16">16</a></span>)
159 jpm 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">void</span>
135
										<a href="#ajouterEntree" title="details" class="method-name">ajouterEntree</a>
136
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$nomFichier</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$entree</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$mode</span> = <span class="var-default">'a+'</span>])
137
									</div>
138
 
139
				<div class="method-definition">
297 jpm 140
					static 						<span class="method-result">void</span>
141
										<a href="#configurer" title="details" class="method-name">configurer</a>
159 jpm 142
										()
143
									</div>
144
 
145
				<div class="method-definition">
297 jpm 146
					static 						<span class="method-result">void</span>
147
										<a href="#initialiser" title="details" class="method-name">initialiser</a>
148
										()
149
									</div>
150
 
151
				<div class="method-definition">
159 jpm 152
					static 						<span class="method-result">boolean</span>
153
										<a href="#verifierOuvrirFichier" title="details" class="method-name">verifierOuvrirFichier</a>
154
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$nomFichier</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$mode</span>)
155
									</div>
156
 
157
				<div class="method-definition">
158
					static 						<span class="method-result">void</span>
159
										<a href="#viderLog" title="details" class="method-name">viderLog</a>
160
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$nomFichier</span>)
161
									</div>
162
 
163
				<div class="method-definition">
164
											<span class="method-result">void</span>
165
										<a href="#__destruct" title="details" class="method-name">__destruct</a>
166
										()
167
									</div>
297 jpm 168
																																																			</div>
159 jpm 169
		</div>
170
	</div>
171
 
172
 
173
	<a name="sec-methods"></a>
174
	<div class="info-box">
175
		<div class="info-box-title">Methods</div>
176
		<div class="nav-bar">
177
			<a href="#sec-description">Description</a> |
178
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
179
 
180
		</div>
181
		<div class="info-box-body">
182
			<A NAME='method_detail'></A>
183
<a name="methodajouterEntree" id="ajouterEntree"><!-- --></a>
297 jpm 184
<div class="oddrow">
159 jpm 185
 
186
	<div class="method-header">
297 jpm 187
		<span class="method-title">static ajouterEntree</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Log.php.html#a71">71</a></span>)
159 jpm 188
	</div>
189
 
190
	<!-- ========== Info from phpDoc block ========= -->
191
<p class="short-description">Ajoute une entrée au log spécifié par le paramètre $nomFichier</p>
192
	<ul class="tags">
193
				<li><span class="field">access:</span> public</li>
194
			</ul>
195
 
196
	<div class="method-signature">
197
		static <span class="method-result">void</span>
198
		<span class="method-name">
199
			ajouterEntree
200
		</span>
201
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$nomFichier</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$entree</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$mode</span> = <span class="var-default">'a+'</span>])
202
			</div>
203
 
204
			<ul class="parameters">
205
					<li>
206
				<span class="var-type">string</span>
207
				<span class="var-name">$nomFichier</span><span class="var-description">: le nom du fichier dans lequel écrire</span>			</li>
208
					<li>
209
				<span class="var-type"></span>
210
				<span class="var-name">$entree</span>			</li>
211
					<li>
212
				<span class="var-type"></span>
213
				<span class="var-name">$mode</span>			</li>
214
				</ul>
215
 
216
 
217
	</div>
297 jpm 218
<a name="methodconfigurer" id="configurer"><!-- --></a>
219
<div class="evenrow">
220
 
221
	<div class="method-header">
222
		<span class="method-title">static configurer</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Log.php.html#a58">58</a></span>)
223
	</div>
224
 
225
	<!-- ========== Info from phpDoc block ========= -->
226
<p class="short-description">Configure le Log à partir des paramêtres de config.</p>
227
	<ul class="tags">
228
				<li><span class="field">access:</span> public</li>
229
			</ul>
230
 
231
	<div class="method-signature">
232
		static <span class="method-result">void</span>
233
		<span class="method-name">
234
			configurer
235
		</span>
236
				()
237
			</div>
238
 
239
 
240
 
241
	</div>
242
<a name="methodinitialiser" id="initialiser"><!-- --></a>
159 jpm 243
<div class="oddrow">
244
 
245
	<div class="method-header">
297 jpm 246
		<span class="method-title">static initialiser</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Log.php.html#a46">46</a></span>)
159 jpm 247
	</div>
248
 
249
	<!-- ========== Info from phpDoc block ========= -->
297 jpm 250
<p class="short-description">Initialiser les logs par défaut, sans tenir comptes des paramêtres de config.</p>
159 jpm 251
	<ul class="tags">
252
				<li><span class="field">access:</span> public</li>
253
			</ul>
254
 
255
	<div class="method-signature">
297 jpm 256
		static <span class="method-result">void</span>
159 jpm 257
		<span class="method-name">
297 jpm 258
			initialiser
159 jpm 259
		</span>
260
				()
261
			</div>
262
 
263
 
264
 
265
	</div>
266
<a name="methodverifierOuvrirFichier" id="verifierOuvrirFichier"><!-- --></a>
267
<div class="evenrow">
268
 
269
	<div class="method-header">
297 jpm 270
		<span class="method-title">static verifierOuvrirFichier</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Log.php.html#a98">98</a></span>)
159 jpm 271
	</div>
272
 
273
	<!-- ========== Info from phpDoc block ========= -->
297 jpm 274
<p class="short-description">Vérifie la présence d'un fichier dans le tableau, ses droits d'écriture, l'ouvre si nécessaire.</p>
159 jpm 275
	<ul class="tags">
276
				<li><span class="field">return:</span> true si le fichier est ouvert ou maintenant accessible, false sinon</li>
277
				<li><span class="field">access:</span> public</li>
278
			</ul>
279
 
280
	<div class="method-signature">
281
		static <span class="method-result">boolean</span>
282
		<span class="method-name">
283
			verifierOuvrirFichier
284
		</span>
285
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$nomFichier</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$mode</span>)
286
			</div>
287
 
288
			<ul class="parameters">
289
					<li>
290
				<span class="var-type">string</span>
291
				<span class="var-name">$nomFichier</span><span class="var-description">: le nom du fichier dont on doit vérifier la présence</span>			</li>
292
					<li>
293
				<span class="var-type"></span>
294
				<span class="var-name">$mode</span>			</li>
295
				</ul>
296
 
297
 
298
	</div>
299
<a name="methodviderLog" id="viderLog"><!-- --></a>
300
<div class="oddrow">
301
 
302
	<div class="method-header">
297 jpm 303
		<span class="method-title">static viderLog</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Log.php.html#a88">88</a></span>)
159 jpm 304
	</div>
305
 
306
	<!-- ========== Info from phpDoc block ========= -->
307
<p class="short-description">Vide un fichier log indiqué</p>
308
	<ul class="tags">
309
				<li><span class="field">access:</span> public</li>
310
			</ul>
311
 
312
	<div class="method-signature">
313
		static <span class="method-result">void</span>
314
		<span class="method-name">
315
			viderLog
316
		</span>
317
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$nomFichier</span>)
318
			</div>
319
 
320
			<ul class="parameters">
321
					<li>
322
				<span class="var-type">string</span>
323
				<span class="var-name">$nomFichier</span><span class="var-description">: le nom du fichier à vider</span>			</li>
324
				</ul>
325
 
326
 
327
	</div>
328
<a name="method__destruct" id="__destruct"><!-- --></a>
329
<div class="evenrow">
330
 
331
	<div class="method-header">
297 jpm 332
		<span class="method-title">Destructor __destruct</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Log.php.html#a143">143</a></span>)
159 jpm 333
	</div>
334
 
335
	<!-- ========== Info from phpDoc block ========= -->
297 jpm 336
<p class="short-description">Destructeur de classe, ferme les descripteurs ouverts.</p>
159 jpm 337
	<ul class="tags">
338
				<li><span class="field">access:</span> public</li>
339
			</ul>
340
 
341
	<div class="method-signature">
342
		<span class="method-result">void</span>
343
		<span class="method-name">
344
			__destruct
345
		</span>
346
				()
347
			</div>
348
 
349
 
350
 
351
	</div>
352
 
353
		</div>
354
	</div>
355
 
356
 
357
	<p class="notes" id="credit">
302 jpm 358
		Documentation generated on Tue, 18 Jan 2011 15:30:52 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
159 jpm 359
	</p>
360
	</div></body>
361
</html>