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
297 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 CacheSimple</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 CacheSimple</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 ========= -->
100
<p class="short-description">Classe Cache permettant de mettre en cache des données de façon extremement simple.</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>
102
	<ul class="tags">
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">author:</span> Jean-Pascal MILCENT &lt;<a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a>&gt;</li>
300 jpm 105
				<li><span class="field">version:</span> $Id: CacheSimple.php 299 2011-01-18 14:03:46Z jpm $</li>
297 jpm 106
				<li><span class="field">copyright:</span> Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</li>
107
				<li><span class="field">link:</span> /doc/framework/</li>
108
				<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL</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>
110
				<li><span class="field">license:</span> <a href="http://framework.zend.com/license/new-bsd">Licence New BSD</a></li>
111
			</ul>
112
		<p class="notes">
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>)
114
		</p>
115
 
116
 
117
		<pre></pre>
118
 
119
			</div>
120
</div>
121
 
122
 
123
 
124
 
125
	<a name="sec-method-summary"></a>
126
	<div class="info-box">
127
		<div class="info-box-title">Method Summary</span></div>
128
		<div class="nav-bar">
129
			<a href="#sec-description">Description</a> |
130
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
131
		</div>
132
		<div class="info-box-body">
133
			<div class="method-summary">
134
 
135
				<div class="method-definition">
136
											<span class="method-result">CacheSimple</span>
137
										<a href="#__construct" title="details" class="method-name">__construct</a>
138
											([<span class="var-type"></span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">array()</span>])
139
									</div>
140
 
141
				<div class="method-definition">
142
											<span class="method-result">string|false</span>
143
										<a href="#charger" title="details" class="method-name">charger</a>
144
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
145
									</div>
146
 
147
				<div class="method-definition">
148
											<span class="method-result">boolean</span>
149
										<a href="#sauver" title="details" class="method-name">sauver</a>
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>)
151
									</div>
152
											</div>
153
		</div>
154
	</div>
155
 
156
 
157
	<a name="sec-methods"></a>
158
	<div class="info-box">
159
		<div class="info-box-title">Methods</div>
160
		<div class="nav-bar">
161
			<a href="#sec-description">Description</a> |
162
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
163
 
164
		</div>
165
		<div class="info-box-body">
166
			<A NAME='method_detail'></A>
167
<a name="method__construct" id="__construct"><!-- --></a>
168
<div class="oddrow">
169
 
170
	<div class="method-header">
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>)
172
	</div>
173
 
174
	<!-- ========== Info from phpDoc block ========= -->
175
	<ul class="tags">
176
				<li><span class="field">access:</span> public</li>
177
			</ul>
178
 
179
	<div class="method-signature">
180
		<span class="method-result">CacheSimple</span>
181
		<span class="method-name">
182
			__construct
183
		</span>
184
					([<span class="var-type"></span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">array()</span>])
185
			</div>
186
 
187
			<ul class="parameters">
188
					<li>
189
				<span class="var-type"></span>
190
				<span class="var-name">$options</span>			</li>
191
				</ul>
192
 
193
 
194
	</div>
195
<a name="methodcharger" id="charger"><!-- --></a>
196
<div class="evenrow">
197
 
198
	<div class="method-header">
199
		<span class="method-title">charger</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSimple.php.html#a58">58</a></span>)
200
	</div>
201
 
202
	<!-- ========== Info from phpDoc block ========= -->
203
<p class="short-description">Teste si le cache est disponible pour l'id donné et (si oui) le retourne (sinon renvoie false)</p>
204
	<ul class="tags">
205
				<li><span class="field">return:</span> les données en cache.</li>
206
				<li><span class="field">access:</span> public</li>
207
			</ul>
208
 
209
	<div class="method-signature">
210
		<span class="method-result">string|false</span>
211
		<span class="method-name">
212
			charger
213
		</span>
214
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
215
			</div>
216
 
217
			<ul class="parameters">
218
					<li>
219
				<span class="var-type">string</span>
220
				<span class="var-name">$id</span><span class="var-description">: l'identifiant du Cache.</span>			</li>
221
				</ul>
222
 
223
 
224
	</div>
225
<a name="methodsauver" id="sauver"><!-- --></a>
226
<div class="oddrow">
227
 
228
	<div class="method-header">
229
		<span class="method-title">sauver</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSimple.php.html#a78">78</a></span>)
230
	</div>
231
 
232
	<!-- ========== Info from phpDoc block ========= -->
233
<p class="short-description">Sauvegarde la chaine de données dans un fichier texte.</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>
235
	<ul class="tags">
236
				<li><span class="field">return:</span> true si aucun problème</li>
237
				<li><span class="field">access:</span> public</li>
238
			</ul>
239
 
240
	<div class="method-signature">
241
		<span class="method-result">boolean</span>
242
		<span class="method-name">
243
			sauver
244
		</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>)
246
			</div>
247
 
248
			<ul class="parameters">
249
					<li>
250
				<span class="var-type">string</span>
251
				<span class="var-name">$contenu</span><span class="var-description">: les données à mettre en cache.</span>			</li>
252
					<li>
253
				<span class="var-type">string</span>
254
				<span class="var-name">$id</span><span class="var-description">: l'identifiant du Cache.</span>			</li>
255
				</ul>
256
 
257
 
258
	</div>
259
 
260
		</div>
261
	</div>
262
 
263
 
264
	<p class="notes" id="credit">
302 jpm 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>
297 jpm 266
	</p>
267
	</div></body>
268
</html>