Subversion Repositories Applications.framework

Rev

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

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