Subversion Repositories Applications.framework

Rev

Rev 300 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 300 Rev 302
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">
1
<!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">
2
  <html xmlns="http://www.w3.org/1999/xhtml">
4
		<head>
3
		<head>
5
			<!-- template designed by Marco Von Ballmoos  -->
4
			<!-- template designed by Marco Von Ballmoos  -->
6
			<title>Docs For Class CacheSimple</title>
5
			<title>Docs For Class CacheSimple</title>
7
			<meta http-equiv='Content-Type' content='text/html; charset=UTF-8'/>
6
			<meta http-equiv='Content-Type' content='text/html; charset=UTF-8'/>
8
			<link rel="stylesheet" href="../media/stylesheet.css" />
7
			<link rel="stylesheet" href="../media/stylesheet.css" />
9
						<script src="../media/lib/classTree.js"></script>
8
						<script src="../media/lib/classTree.js"></script>
10
												<script language="javascript" type="text/javascript">
9
												<script language="javascript" type="text/javascript">
11
				var imgPlus = new Image();
10
				var imgPlus = new Image();
12
				var imgMinus = new Image();
11
				var imgMinus = new Image();
13
				imgPlus.src = "../media/images/plus.png";
12
				imgPlus.src = "../media/images/plus.png";
14
				imgMinus.src = "../media/images/minus.png";
13
				imgMinus.src = "../media/images/minus.png";
15
				
14
				
16
				function showNode(Node){
15
				function showNode(Node){
17
							switch(navigator.family){
16
							switch(navigator.family){
18
								case 'nn4':
17
								case 'nn4':
19
									// Nav 4.x code fork...
18
									// Nav 4.x code fork...
20
							var oTable = document.layers["span" + Node];
19
							var oTable = document.layers["span" + Node];
21
							var oImg = document.layers["img" + Node];
20
							var oImg = document.layers["img" + Node];
22
									break;
21
									break;
23
								case 'ie4':
22
								case 'ie4':
24
									// IE 4/5 code fork...
23
									// IE 4/5 code fork...
25
							var oTable = document.all["span" + Node];
24
							var oTable = document.all["span" + Node];
26
							var oImg = document.all["img" + Node];
25
							var oImg = document.all["img" + Node];
27
									break;
26
									break;
28
								case 'gecko':
27
								case 'gecko':
29
									// Standards Compliant code fork...
28
									// Standards Compliant code fork...
30
							var oTable = document.getElementById("span" + Node);
29
							var oTable = document.getElementById("span" + Node);
31
							var oImg = document.getElementById("img" + Node);
30
							var oImg = document.getElementById("img" + Node);
32
									break;
31
									break;
33
							}
32
							}
34
					oImg.src = imgMinus.src;
33
					oImg.src = imgMinus.src;
35
					oTable.style.display = "block";
34
					oTable.style.display = "block";
36
				}
35
				}
37
				
36
				
38
				function hideNode(Node){
37
				function hideNode(Node){
39
							switch(navigator.family){
38
							switch(navigator.family){
40
								case 'nn4':
39
								case 'nn4':
41
									// Nav 4.x code fork...
40
									// Nav 4.x code fork...
42
							var oTable = document.layers["span" + Node];
41
							var oTable = document.layers["span" + Node];
43
							var oImg = document.layers["img" + Node];
42
							var oImg = document.layers["img" + Node];
44
									break;
43
									break;
45
								case 'ie4':
44
								case 'ie4':
46
									// IE 4/5 code fork...
45
									// IE 4/5 code fork...
47
							var oTable = document.all["span" + Node];
46
							var oTable = document.all["span" + Node];
48
							var oImg = document.all["img" + Node];
47
							var oImg = document.all["img" + Node];
49
									break;
48
									break;
50
								case 'gecko':
49
								case 'gecko':
51
									// Standards Compliant code fork...
50
									// Standards Compliant code fork...
52
							var oTable = document.getElementById("span" + Node);
51
							var oTable = document.getElementById("span" + Node);
53
							var oImg = document.getElementById("img" + Node);
52
							var oImg = document.getElementById("img" + Node);
54
									break;
53
									break;
55
							}
54
							}
56
					oImg.src = imgPlus.src;
55
					oImg.src = imgPlus.src;
57
					oTable.style.display = "none";
56
					oTable.style.display = "none";
58
				}
57
				}
59
				
58
				
60
				function nodeIsVisible(Node){
59
				function nodeIsVisible(Node){
61
							switch(navigator.family){
60
							switch(navigator.family){
62
								case 'nn4':
61
								case 'nn4':
63
									// Nav 4.x code fork...
62
									// Nav 4.x code fork...
64
							var oTable = document.layers["span" + Node];
63
							var oTable = document.layers["span" + Node];
65
									break;
64
									break;
66
								case 'ie4':
65
								case 'ie4':
67
									// IE 4/5 code fork...
66
									// IE 4/5 code fork...
68
							var oTable = document.all["span" + Node];
67
							var oTable = document.all["span" + Node];
69
									break;
68
									break;
70
								case 'gecko':
69
								case 'gecko':
71
									// Standards Compliant code fork...
70
									// Standards Compliant code fork...
72
							var oTable = document.getElementById("span" + Node);
71
							var oTable = document.getElementById("span" + Node);
73
									break;
72
									break;
74
							}
73
							}
75
					return (oTable && oTable.style.display == "block");
74
					return (oTable && oTable.style.display == "block");
76
				}
75
				}
77
				
76
				
78
				function toggleNodeVisibility(Node){
77
				function toggleNodeVisibility(Node){
79
					if (nodeIsVisible(Node)){
78
					if (nodeIsVisible(Node)){
80
						hideNode(Node);
79
						hideNode(Node);
81
					}else{
80
					}else{
82
						showNode(Node);
81
						showNode(Node);
83
					}
82
					}
84
				}
83
				}
85
			</script>
84
			</script>
86
					</head>
85
					</head>
87
		<body>
86
		<body>
88
			<div class="page-body">			
87
			<div class="page-body">			
89
<h2 class="class-name">Class CacheSimple</h2>
88
<h2 class="class-name">Class CacheSimple</h2>
90
 
89
 
91
<a name="sec-description"></a>
90
<a name="sec-description"></a>
92
<div class="info-box">
91
<div class="info-box">
93
	<div class="info-box-title">Description</div>
92
	<div class="info-box-title">Description</div>
94
	<div class="nav-bar">
93
	<div class="nav-bar">
95
					<span class="disabled">Description</span> |
94
					<span class="disabled">Description</span> |
96
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
95
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
97
						
96
						
98
					</div>
97
					</div>
99
	<div class="info-box-body">
98
	<div class="info-box-body">
100
        		<!-- ========== Info from phpDoc block ========= -->
99
        		<!-- ========== Info from phpDoc block ========= -->
101
<p class="short-description">Classe Cache permettant de mettre en cache des données de façon extremement simple.</p>
100
<p class="short-description">Classe Cache permettant de mettre en cache des données de façon extremement simple.</p>
102
<p class="description"><p>Le cache est stocker dans des fichiers textes.  Le contrôle de la durée de vie du cache se fait avec la fonction PHP filemtime.  Si la durée de vie du cache est modifiée dans le constructeur ou le fichier de config, alors la durée de vie de l'ensemble  des fichiers de cache est modifiée en conséquence.  Les clés pour le tableau des options et les valeurs par défaut sont indiquées dans l'attribut options de la classe.</p></p>
101
<p class="description"><p>Le cache est stocker dans des fichiers textes.  Le contrôle de la durée de vie du cache se fait avec la fonction PHP filemtime.  Si la durée de vie du cache est modifiée dans le constructeur ou le fichier de config, alors la durée de vie de l'ensemble  des fichiers de cache est modifiée en conséquence.  Les clés pour le tableau des options et les valeurs par défaut sont indiquées dans l'attribut options de la classe.</p></p>
103
	<ul class="tags">
102
	<ul class="tags">
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>
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>
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>
104
				<li><span class="field">author:</span> Jean-Pascal MILCENT &lt;<a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a>&gt;</li>
106
				<li><span class="field">version:</span> $Id: CacheSimple.php 299 2011-01-18 14:03:46Z jpm $</li>
105
				<li><span class="field">version:</span> $Id: CacheSimple.php 299 2011-01-18 14:03:46Z jpm $</li>
107
				<li><span class="field">copyright:</span> Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</li>
106
				<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>
107
				<li><span class="field">link:</span> /doc/framework/</li>
109
				<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL</a></li>
108
				<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL</a></li>
110
				<li><span class="field">license:</span> <a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL</a></li>
109
				<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://framework.zend.com/license/new-bsd">Licence New BSD</a></li>
110
				<li><span class="field">license:</span> <a href="http://framework.zend.com/license/new-bsd">Licence New BSD</a></li>
112
			</ul>
111
			</ul>
113
		<p class="notes">
112
		<p class="notes">
114
			Located in <a class="field" href="_CacheSimple.php.html">/CacheSimple.php</a> (line <span class="field"><a href="../__filesource/fsource_Framework__CacheSimple.php.html#a22">22</a></span>)
113
			Located in <a class="field" href="_CacheSimple.php.html">/CacheSimple.php</a> (line <span class="field"><a href="../__filesource/fsource_Framework__CacheSimple.php.html#a22">22</a></span>)
115
		</p>
114
		</p>
116
		
115
		
117
				
116
				
118
		<pre></pre>
117
		<pre></pre>
119
	
118
	
120
			</div>
119
			</div>
121
</div>
120
</div>
122
 
121
 
123
 
122
 
124
 
123
 
125
 
124
 
126
	<a name="sec-method-summary"></a>
125
	<a name="sec-method-summary"></a>
127
	<div class="info-box">
126
	<div class="info-box">
128
		<div class="info-box-title">Method Summary</span></div>
127
		<div class="info-box-title">Method Summary</span></div>
129
		<div class="nav-bar">
128
		<div class="nav-bar">
130
			<a href="#sec-description">Description</a> |
129
			<a href="#sec-description">Description</a> |
131
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
130
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
132
		</div>
131
		</div>
133
		<div class="info-box-body">			
132
		<div class="info-box-body">			
134
			<div class="method-summary">
133
			<div class="method-summary">
135
																																						
134
																																						
136
				<div class="method-definition">
135
				<div class="method-definition">
137
											<span class="method-result">CacheSimple</span>
136
											<span class="method-result">CacheSimple</span>
138
										<a href="#__construct" title="details" class="method-name">__construct</a>
137
										<a href="#__construct" title="details" class="method-name">__construct</a>
139
											([<span class="var-type"></span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">array()</span>])
138
											([<span class="var-type"></span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">array()</span>])
140
									</div>
139
									</div>
141
														
140
														
142
				<div class="method-definition">
141
				<div class="method-definition">
143
											<span class="method-result">string|false</span>
142
											<span class="method-result">string|false</span>
144
										<a href="#charger" title="details" class="method-name">charger</a>
143
										<a href="#charger" title="details" class="method-name">charger</a>
145
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
144
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
146
									</div>
145
									</div>
147
														
146
														
148
				<div class="method-definition">
147
				<div class="method-definition">
149
											<span class="method-result">boolean</span>
148
											<span class="method-result">boolean</span>
150
										<a href="#sauver" title="details" class="method-name">sauver</a>
149
										<a href="#sauver" title="details" class="method-name">sauver</a>
151
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$contenu</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
150
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$contenu</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
152
									</div>
151
									</div>
153
											</div>
152
											</div>
154
		</div>
153
		</div>
155
	</div>		
154
	</div>		
156
 
155
 
157
	
156
	
158
	<a name="sec-methods"></a>
157
	<a name="sec-methods"></a>
159
	<div class="info-box">
158
	<div class="info-box">
160
		<div class="info-box-title">Methods</div>
159
		<div class="info-box-title">Methods</div>
161
		<div class="nav-bar">
160
		<div class="nav-bar">
162
			<a href="#sec-description">Description</a> |
161
			<a href="#sec-description">Description</a> |
163
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
162
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
164
						
163
						
165
		</div>
164
		</div>
166
		<div class="info-box-body">
165
		<div class="info-box-body">
167
			<A NAME='method_detail'></A>
166
			<A NAME='method_detail'></A>
168
<a name="method__construct" id="__construct"><!-- --></a>
167
<a name="method__construct" id="__construct"><!-- --></a>
169
<div class="oddrow">
168
<div class="oddrow">
170
	
169
	
171
	<div class="method-header">
170
	<div class="method-header">
172
		<span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSimple.php.html#a34">34</a></span>)
171
		<span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSimple.php.html#a34">34</a></span>)
173
	</div> 
172
	</div> 
174
	
173
	
175
	<!-- ========== Info from phpDoc block ========= -->
174
	<!-- ========== Info from phpDoc block ========= -->
176
	<ul class="tags">
175
	<ul class="tags">
177
				<li><span class="field">access:</span> public</li>
176
				<li><span class="field">access:</span> public</li>
178
			</ul>
177
			</ul>
179
	
178
	
180
	<div class="method-signature">
179
	<div class="method-signature">
181
		<span class="method-result">CacheSimple</span>
180
		<span class="method-result">CacheSimple</span>
182
		<span class="method-name">
181
		<span class="method-name">
183
			__construct
182
			__construct
184
		</span>
183
		</span>
185
					([<span class="var-type"></span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">array()</span>])
184
					([<span class="var-type"></span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">array()</span>])
186
			</div>
185
			</div>
187
	
186
	
188
			<ul class="parameters">
187
			<ul class="parameters">
189
					<li>
188
					<li>
190
				<span class="var-type"></span>
189
				<span class="var-type"></span>
191
				<span class="var-name">$options</span>			</li>
190
				<span class="var-name">$options</span>			</li>
192
				</ul>
191
				</ul>
193
		
192
		
194
			
193
			
195
	</div>
194
	</div>
196
<a name="methodcharger" id="charger"><!-- --></a>
195
<a name="methodcharger" id="charger"><!-- --></a>
197
<div class="evenrow">
196
<div class="evenrow">
198
	
197
	
199
	<div class="method-header">
198
	<div class="method-header">
200
		<span class="method-title">charger</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSimple.php.html#a58">58</a></span>)
199
		<span class="method-title">charger</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSimple.php.html#a58">58</a></span>)
201
	</div> 
200
	</div> 
202
	
201
	
203
	<!-- ========== Info from phpDoc block ========= -->
202
	<!-- ========== Info from phpDoc block ========= -->
204
<p class="short-description">Teste si le cache est disponible pour l'id donné et (si oui) le retourne (sinon renvoie false)</p>
203
<p class="short-description">Teste si le cache est disponible pour l'id donné et (si oui) le retourne (sinon renvoie false)</p>
205
	<ul class="tags">
204
	<ul class="tags">
206
				<li><span class="field">return:</span> les données en cache.</li>
205
				<li><span class="field">return:</span> les données en cache.</li>
207
				<li><span class="field">access:</span> public</li>
206
				<li><span class="field">access:</span> public</li>
208
			</ul>
207
			</ul>
209
	
208
	
210
	<div class="method-signature">
209
	<div class="method-signature">
211
		<span class="method-result">string|false</span>
210
		<span class="method-result">string|false</span>
212
		<span class="method-name">
211
		<span class="method-name">
213
			charger
212
			charger
214
		</span>
213
		</span>
215
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
214
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
216
			</div>
215
			</div>
217
	
216
	
218
			<ul class="parameters">
217
			<ul class="parameters">
219
					<li>
218
					<li>
220
				<span class="var-type">string</span>
219
				<span class="var-type">string</span>
221
				<span class="var-name">$id</span><span class="var-description">: l'identifiant du Cache.</span>			</li>
220
				<span class="var-name">$id</span><span class="var-description">: l'identifiant du Cache.</span>			</li>
222
				</ul>
221
				</ul>
223
		
222
		
224
			
223
			
225
	</div>
224
	</div>
226
<a name="methodsauver" id="sauver"><!-- --></a>
225
<a name="methodsauver" id="sauver"><!-- --></a>
227
<div class="oddrow">
226
<div class="oddrow">
228
	
227
	
229
	<div class="method-header">
228
	<div class="method-header">
230
		<span class="method-title">sauver</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSimple.php.html#a78">78</a></span>)
229
		<span class="method-title">sauver</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSimple.php.html#a78">78</a></span>)
231
	</div> 
230
	</div> 
232
	
231
	
233
	<!-- ========== Info from phpDoc block ========= -->
232
	<!-- ========== Info from phpDoc block ========= -->
234
<p class="short-description">Sauvegarde la chaine de données dans un fichier texte.</p>
233
<p class="short-description">Sauvegarde la chaine de données dans un fichier texte.</p>
235
<p class="description"><p>Note : $contenu est toujours de type &quot;string&quot;. C'est à vous de gérer la sérialisation.</p></p>
234
<p class="description"><p>Note : $contenu est toujours de type &quot;string&quot;. C'est à vous de gérer la sérialisation.</p></p>
236
	<ul class="tags">
235
	<ul class="tags">
237
				<li><span class="field">return:</span> true si aucun problème</li>
236
				<li><span class="field">return:</span> true si aucun problème</li>
238
				<li><span class="field">access:</span> public</li>
237
				<li><span class="field">access:</span> public</li>
239
			</ul>
238
			</ul>
240
	
239
	
241
	<div class="method-signature">
240
	<div class="method-signature">
242
		<span class="method-result">boolean</span>
241
		<span class="method-result">boolean</span>
243
		<span class="method-name">
242
		<span class="method-name">
244
			sauver
243
			sauver
245
		</span>
244
		</span>
246
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$contenu</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
245
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$contenu</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
247
			</div>
246
			</div>
248
	
247
	
249
			<ul class="parameters">
248
			<ul class="parameters">
250
					<li>
249
					<li>
251
				<span class="var-type">string</span>
250
				<span class="var-type">string</span>
252
				<span class="var-name">$contenu</span><span class="var-description">: les données à mettre en cache.</span>			</li>
251
				<span class="var-name">$contenu</span><span class="var-description">: les données à mettre en cache.</span>			</li>
253
					<li>
252
					<li>
254
				<span class="var-type">string</span>
253
				<span class="var-type">string</span>
255
				<span class="var-name">$id</span><span class="var-description">: l'identifiant du Cache.</span>			</li>
254
				<span class="var-name">$id</span><span class="var-description">: l'identifiant du Cache.</span>			</li>
256
				</ul>
255
				</ul>
257
		
256
		
258
			
257
			
259
	</div>
258
	</div>
260
						
259
						
261
		</div>
260
		</div>
262
	</div>
261
	</div>
263
 
262
 
264
 
263
 
265
	<p class="notes" id="credit">
264
	<p class="notes" id="credit">
266
		Documentation generated on Tue, 18 Jan 2011 15:13:07 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
265
		Documentation generated on Tue, 18 Jan 2011 15:30:42 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
267
	</p>
266
	</p>
268
	</div></body>
267
	</div></body>
269
</html>
268
</html>