Subversion Repositories Applications.framework

Rev

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

Rev Author Line No. Line
297 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 CacheSimple</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 CacheSimple</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 ========= -->
101
<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>
103
	<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>
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>
300 jpm 106
				<li><span class="field">version:</span> $Id: CacheSimple.php 299 2011-01-18 14:03:46Z jpm $</li>
297 jpm 107
				<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>
109
				<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>
111
				<li><span class="field">license:</span> <a href="http://framework.zend.com/license/new-bsd">Licence New BSD</a></li>
112
			</ul>
113
		<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>)
115
		</p>
116
 
117
 
118
		<pre></pre>
119
 
120
			</div>
121
</div>
122
 
123
 
124
 
125
 
126
	<a name="sec-method-summary"></a>
127
	<div class="info-box">
128
		<div class="info-box-title">Method Summary</span></div>
129
		<div class="nav-bar">
130
			<a href="#sec-description">Description</a> |
131
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
132
		</div>
133
		<div class="info-box-body">
134
			<div class="method-summary">
135
 
136
				<div class="method-definition">
137
											<span class="method-result">CacheSimple</span>
138
										<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>])
140
									</div>
141
 
142
				<div class="method-definition">
143
											<span class="method-result">string|false</span>
144
										<a href="#charger" title="details" class="method-name">charger</a>
145
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
146
									</div>
147
 
148
				<div class="method-definition">
149
											<span class="method-result">boolean</span>
150
										<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>)
152
									</div>
153
											</div>
154
		</div>
155
	</div>
156
 
157
 
158
	<a name="sec-methods"></a>
159
	<div class="info-box">
160
		<div class="info-box-title">Methods</div>
161
		<div class="nav-bar">
162
			<a href="#sec-description">Description</a> |
163
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
164
 
165
		</div>
166
		<div class="info-box-body">
167
			<A NAME='method_detail'></A>
168
<a name="method__construct" id="__construct"><!-- --></a>
169
<div class="oddrow">
170
 
171
	<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>)
173
	</div>
174
 
175
	<!-- ========== Info from phpDoc block ========= -->
176
	<ul class="tags">
177
				<li><span class="field">access:</span> public</li>
178
			</ul>
179
 
180
	<div class="method-signature">
181
		<span class="method-result">CacheSimple</span>
182
		<span class="method-name">
183
			__construct
184
		</span>
185
					([<span class="var-type"></span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">array()</span>])
186
			</div>
187
 
188
			<ul class="parameters">
189
					<li>
190
				<span class="var-type"></span>
191
				<span class="var-name">$options</span>			</li>
192
				</ul>
193
 
194
 
195
	</div>
196
<a name="methodcharger" id="charger"><!-- --></a>
197
<div class="evenrow">
198
 
199
	<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>)
201
	</div>
202
 
203
	<!-- ========== 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>
205
	<ul class="tags">
206
				<li><span class="field">return:</span> les données en cache.</li>
207
				<li><span class="field">access:</span> public</li>
208
			</ul>
209
 
210
	<div class="method-signature">
211
		<span class="method-result">string|false</span>
212
		<span class="method-name">
213
			charger
214
		</span>
215
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
216
			</div>
217
 
218
			<ul class="parameters">
219
					<li>
220
				<span class="var-type">string</span>
221
				<span class="var-name">$id</span><span class="var-description">: l'identifiant du Cache.</span>			</li>
222
				</ul>
223
 
224
 
225
	</div>
226
<a name="methodsauver" id="sauver"><!-- --></a>
227
<div class="oddrow">
228
 
229
	<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>)
231
	</div>
232
 
233
	<!-- ========== Info from phpDoc block ========= -->
234
<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>
236
	<ul class="tags">
237
				<li><span class="field">return:</span> true si aucun problème</li>
238
				<li><span class="field">access:</span> public</li>
239
			</ul>
240
 
241
	<div class="method-signature">
242
		<span class="method-result">boolean</span>
243
		<span class="method-name">
244
			sauver
245
		</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>)
247
			</div>
248
 
249
			<ul class="parameters">
250
					<li>
251
				<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>
253
					<li>
254
				<span class="var-type">string</span>
255
				<span class="var-name">$id</span><span class="var-description">: l'identifiant du Cache.</span>			</li>
256
				</ul>
257
 
258
 
259
	</div>
260
 
261
		</div>
262
	</div>
263
 
264
 
265
	<p class="notes" id="credit">
300 jpm 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>
297 jpm 267
	</p>
268
	</div></body>
269
</html>