|
525
|
1 |
<!DOCTYPE html> |
|
|
2 |
<html lang="en"> |
|
|
3 |
<head> |
|
|
4 |
<meta charset="utf-8"> |
|
|
5 |
<title>Example: Offline Caching</title> |
|
|
6 |
<link rel="stylesheet" href="http://fonts.googleapis.com/css?family=PT+Sans:400,700,400italic,700italic"> |
|
|
7 |
<link rel="stylesheet" href="../../build/cssgrids/cssgrids-min.css"> |
|
|
8 |
<link rel="stylesheet" href="../assets/css/main.css"> |
|
|
9 |
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css"> |
|
|
10 |
<link rel="shortcut icon" type="image/png" href="../assets/favicon.png"> |
|
|
11 |
<script src="../../build/yui/yui-min.js"></script> |
|
|
12 |
|
|
|
13 |
</head> |
|
|
14 |
<body> |
|
|
15 |
<!-- |
|
|
16 |
<a href="https://github.com/yui/yui3"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub"></a> |
|
|
17 |
--> |
|
|
18 |
<div id="doc"> |
|
|
19 |
<div id="hd"> |
|
|
20 |
<h1><img src="http://yuilibrary.com/img/yui-logo.png"></h1> |
|
|
21 |
</div> |
|
|
22 |
|
|
|
23 |
|
|
|
24 |
<h1>Example: Offline Caching</h1> |
|
|
25 |
<div class="yui3-g"> |
|
|
26 |
<div class="yui3-u-3-4"> |
|
|
27 |
<div id="main"> |
|
|
28 |
<div class="content"><div class="intro"> |
|
|
29 |
<p>OfflineCache stores data in HTML 5 localStorage when available so that data persists across browser sessions. When localStorage is disabled or altogether unavailable (i.e., IE6 and IE7) data is simply cached in local JavaScript memory and will not persist across browser sessions.</p> |
|
|
30 |
</div> |
|
|
31 |
|
|
|
32 |
<div class="example"> |
|
|
33 |
<style scoped> |
|
|
34 |
/* custom styles for this example */ |
|
|
35 |
.demo fieldset {display:block; border:0;} |
|
|
36 |
.demo .short {width:2em;} |
|
|
37 |
#out {border:1px solid #CCC; padding:1em} |
|
|
38 |
</style> |
|
|
39 |
|
|
|
40 |
<form id="demo1" class="demo"> |
|
|
41 |
<h6>CacheOffline Instance #1</h6> |
|
|
42 |
<fieldset> |
|
|
43 |
<label for="demo1_expires">Data expires after: <input type="text" id="demo1_expires" class="med" value="86400000"> milliseconds |
|
|
44 |
<input type="button" id="demo1_setExpires" value="Set expires"></label> |
|
|
45 |
</fieldset> |
|
|
46 |
<fieldset> |
|
|
47 |
<label for="demo1_addKey">Key: <input type="text" id="demo1_addKey"></label> |
|
|
48 |
<label for="demo1_addValue">Value: <input type="text" id="demo1_addValue"></label> |
|
|
49 |
<input type="button" id="demo1_add" value="Cache value"> |
|
|
50 |
</fieldset> |
|
|
51 |
<fieldset> |
|
|
52 |
<label for="demo1_retrieveKey">Key: <input type="text" id="demo1_retrieveKey"></label> |
|
|
53 |
<input type="button" id="demo1_retrieve" value="Retrieve value"> |
|
|
54 |
</fieldset> |
|
|
55 |
<fieldset> |
|
|
56 |
<input type="button" id="demo1_flush" value="Flush cache"></label> |
|
|
57 |
</fieldset> |
|
|
58 |
</form> |
|
|
59 |
|
|
|
60 |
<form id="demo2" class="demo"> |
|
|
61 |
<h6>CacheOffline Instance #2</h6> |
|
|
62 |
<fieldset> |
|
|
63 |
<label for="demo2_expires">Data expires after: <input type="text" id="demo2_expires" class="med" value="86400000"> milliseconds |
|
|
64 |
<input type="button" id="demo2_setExpires" value="Set expires"></label> |
|
|
65 |
</fieldset> |
|
|
66 |
<fieldset> |
|
|
67 |
<label for="demo2_addKey">Key: <input type="text" id="demo2_addKey"></label> |
|
|
68 |
<label for="demo2_addValue">Value: <input type="text" id="demo2_addValue"></label> |
|
|
69 |
<input type="button" id="demo2_add" value="Cache value"> |
|
|
70 |
</fieldset> |
|
|
71 |
<fieldset> |
|
|
72 |
<label for="demo2_retrieveKey">Key: <input type="text" id="demo2_retrieveKey"></label> |
|
|
73 |
<input type="button" id="demo2_retrieve" value="Retrieve value"> |
|
|
74 |
</fieldset> |
|
|
75 |
<fieldset> |
|
|
76 |
<input type="button" id="demo2_flush" value="Flush cache"></label> |
|
|
77 |
</fieldset> |
|
|
78 |
</form> |
|
|
79 |
<div id="out">(cache results here)</div> |
|
|
80 |
|
|
|
81 |
<script> |
|
|
82 |
YUI().use("node", "datatype-number", "cache-offline" ,function (Y) { |
|
|
83 |
var cache1 = new Y.CacheOffline({sandbox:"instance1"}), |
|
|
84 |
out = Y.one("#out"); |
|
|
85 |
|
|
|
86 |
Y.on("click", function(e){ |
|
|
87 |
cache1.set("expires", Y.DataType.Number.parse(Y.one("#demo1_expires").get("value"))); |
|
|
88 |
out.set('text', "Cache 1 \"expires\" set to " + cache1.get("expires") + "."); |
|
|
89 |
}, "#demo1_setExpires"); |
|
|
90 |
|
|
|
91 |
Y.on("click", function(e){ |
|
|
92 |
cache1.add(Y.one("#demo1_addKey").get("value"), Y.one("#demo1_addValue").get("value")); |
|
|
93 |
var msg = "Value cached. Cache 1 \"size\" is now " + cache1.get("size") + "."; |
|
|
94 |
out.set('text', msg); |
|
|
95 |
}, "#demo1_add"); |
|
|
96 |
|
|
|
97 |
Y.on("click", function(e){ |
|
|
98 |
var entry = cache1.retrieve(Y.one("#demo1_retrieveKey").get("value")), |
|
|
99 |
output = entry ? entry.response : "Value not cached."; |
|
|
100 |
out.set('text', output); |
|
|
101 |
}, "#demo1_retrieve"); |
|
|
102 |
|
|
|
103 |
Y.on("click", function(e){ |
|
|
104 |
cache1.flush(); |
|
|
105 |
out.set('text', "Cache 1 flushed."); |
|
|
106 |
}, "#demo1_flush"); |
|
|
107 |
|
|
|
108 |
var cache2 = new Y.CacheOffline({sandbox:"instance2"}); |
|
|
109 |
|
|
|
110 |
Y.on("click", function(e){ |
|
|
111 |
cache2.set("expires", Y.DataType.Number.parse(Y.one("#demo2_expires").get("value"))); |
|
|
112 |
out.set('text', "Cache 2 \"expires\" set to " + cache2.get("expires") + "."); |
|
|
113 |
}, "#demo2_setExpires"); |
|
|
114 |
|
|
|
115 |
Y.on("click", function(e){ |
|
|
116 |
cache2.add(Y.one("#demo2_addKey").get("value"), Y.one("#demo2_addValue").get("value")); |
|
|
117 |
var msg = "Value cached. Cache 2 \"size\" is now " + cache2.get("size") + "."; |
|
|
118 |
out.set('text', msg); |
|
|
119 |
}, "#demo2_add"); |
|
|
120 |
|
|
|
121 |
Y.on("click", function(e){ |
|
|
122 |
var entry = cache2.retrieve(Y.one("#demo2_retrieveKey").get("value")), |
|
|
123 |
output = entry ? entry.response : "Value not cached."; |
|
|
124 |
out.set('text', output); |
|
|
125 |
}, "#demo2_retrieve"); |
|
|
126 |
|
|
|
127 |
Y.on("click", function(e){ |
|
|
128 |
cache2.flush(); |
|
|
129 |
out.set('text', "Cache 2 flushed."); |
|
|
130 |
}, "#demo2_flush"); |
|
|
131 |
}); |
|
|
132 |
</script> |
|
|
133 |
|
|
|
134 |
</div> |
|
|
135 |
|
|
|
136 |
<pre class="code prettyprint">YUI().use("cache-offline", function(Y) { |
|
|
137 |
var cache = new Y.CacheOffline({ |
|
|
138 |
sandbox:"6-hr-cache", // Pass in a unique identifier |
|
|
139 |
expires:21600000 // Expire data after 6 hours |
|
|
140 |
}); |
|
|
141 |
|
|
|
142 |
// Add entries to the Cache |
|
|
143 |
cache.add("key1", "value1"); |
|
|
144 |
cache.add("key2", "value2"); |
|
|
145 |
|
|
|
146 |
// Retrieve a cached entry |
|
|
147 |
var cachedentry = cache.retrieve("key1"); |
|
|
148 |
|
|
|
149 |
// Cached entry is an object with the following properties |
|
|
150 |
alert("cached key: " + cachedentry.request + |
|
|
151 |
" cached value: " + cachedentry.response + |
|
|
152 |
" cached at: " + cachedentry.cached + |
|
|
153 |
" expires at: " + cachedentry.expires); |
|
|
154 |
|
|
|
155 |
// Flush the cache |
|
|
156 |
cache.flush(); |
|
|
157 |
});</pre> |
|
|
158 |
|
|
|
159 |
|
|
|
160 |
<h2>Complete Example Source</h2> |
|
|
161 |
|
|
|
162 |
<pre class="code prettyprint"><style scoped> |
|
|
163 |
/* custom styles for this example */ |
|
|
164 |
.demo fieldset {display:block; border:0;} |
|
|
165 |
.demo .short {width:2em;} |
|
|
166 |
#out {border:1px solid #CCC; padding:1em} |
|
|
167 |
</style> |
|
|
168 |
|
|
|
169 |
<form id="demo1" class="demo"> |
|
|
170 |
<h6>CacheOffline Instance #1</h6> |
|
|
171 |
<fieldset> |
|
|
172 |
<label for="demo1_expires">Data expires after: <input type="text" id="demo1_expires" class="med" value="86400000"> milliseconds |
|
|
173 |
<input type="button" id="demo1_setExpires" value="Set expires"></label> |
|
|
174 |
</fieldset> |
|
|
175 |
<fieldset> |
|
|
176 |
<label for="demo1_addKey">Key: <input type="text" id="demo1_addKey"></label> |
|
|
177 |
<label for="demo1_addValue">Value: <input type="text" id="demo1_addValue"></label> |
|
|
178 |
<input type="button" id="demo1_add" value="Cache value"> |
|
|
179 |
</fieldset> |
|
|
180 |
<fieldset> |
|
|
181 |
<label for="demo1_retrieveKey">Key: <input type="text" id="demo1_retrieveKey"></label> |
|
|
182 |
<input type="button" id="demo1_retrieve" value="Retrieve value"> |
|
|
183 |
</fieldset> |
|
|
184 |
<fieldset> |
|
|
185 |
<input type="button" id="demo1_flush" value="Flush cache"></label> |
|
|
186 |
</fieldset> |
|
|
187 |
</form> |
|
|
188 |
|
|
|
189 |
<form id="demo2" class="demo"> |
|
|
190 |
<h6>CacheOffline Instance #2</h6> |
|
|
191 |
<fieldset> |
|
|
192 |
<label for="demo2_expires">Data expires after: <input type="text" id="demo2_expires" class="med" value="86400000"> milliseconds |
|
|
193 |
<input type="button" id="demo2_setExpires" value="Set expires"></label> |
|
|
194 |
</fieldset> |
|
|
195 |
<fieldset> |
|
|
196 |
<label for="demo2_addKey">Key: <input type="text" id="demo2_addKey"></label> |
|
|
197 |
<label for="demo2_addValue">Value: <input type="text" id="demo2_addValue"></label> |
|
|
198 |
<input type="button" id="demo2_add" value="Cache value"> |
|
|
199 |
</fieldset> |
|
|
200 |
<fieldset> |
|
|
201 |
<label for="demo2_retrieveKey">Key: <input type="text" id="demo2_retrieveKey"></label> |
|
|
202 |
<input type="button" id="demo2_retrieve" value="Retrieve value"> |
|
|
203 |
</fieldset> |
|
|
204 |
<fieldset> |
|
|
205 |
<input type="button" id="demo2_flush" value="Flush cache"></label> |
|
|
206 |
</fieldset> |
|
|
207 |
</form> |
|
|
208 |
<div id="out">(cache results here)</div> |
|
|
209 |
|
|
|
210 |
<script> |
|
|
211 |
YUI().use("node", "datatype-number", "cache-offline" ,function (Y) { |
|
|
212 |
var cache1 = new Y.CacheOffline({sandbox:"instance1"}), |
|
|
213 |
out = Y.one("#out"); |
|
|
214 |
|
|
|
215 |
Y.on("click", function(e){ |
|
|
216 |
cache1.set("expires", Y.DataType.Number.parse(Y.one("#demo1_expires").get("value"))); |
|
|
217 |
out.set('text', "Cache 1 \"expires\" set to " + cache1.get("expires") + "."); |
|
|
218 |
}, "#demo1_setExpires"); |
|
|
219 |
|
|
|
220 |
Y.on("click", function(e){ |
|
|
221 |
cache1.add(Y.one("#demo1_addKey").get("value"), Y.one("#demo1_addValue").get("value")); |
|
|
222 |
var msg = "Value cached. Cache 1 \"size\" is now " + cache1.get("size") + "."; |
|
|
223 |
out.set('text', msg); |
|
|
224 |
}, "#demo1_add"); |
|
|
225 |
|
|
|
226 |
Y.on("click", function(e){ |
|
|
227 |
var entry = cache1.retrieve(Y.one("#demo1_retrieveKey").get("value")), |
|
|
228 |
output = entry ? entry.response : "Value not cached."; |
|
|
229 |
out.set('text', output); |
|
|
230 |
}, "#demo1_retrieve"); |
|
|
231 |
|
|
|
232 |
Y.on("click", function(e){ |
|
|
233 |
cache1.flush(); |
|
|
234 |
out.set('text', "Cache 1 flushed."); |
|
|
235 |
}, "#demo1_flush"); |
|
|
236 |
|
|
|
237 |
var cache2 = new Y.CacheOffline({sandbox:"instance2"}); |
|
|
238 |
|
|
|
239 |
Y.on("click", function(e){ |
|
|
240 |
cache2.set("expires", Y.DataType.Number.parse(Y.one("#demo2_expires").get("value"))); |
|
|
241 |
out.set('text', "Cache 2 \"expires\" set to " + cache2.get("expires") + "."); |
|
|
242 |
}, "#demo2_setExpires"); |
|
|
243 |
|
|
|
244 |
Y.on("click", function(e){ |
|
|
245 |
cache2.add(Y.one("#demo2_addKey").get("value"), Y.one("#demo2_addValue").get("value")); |
|
|
246 |
var msg = "Value cached. Cache 2 \"size\" is now " + cache2.get("size") + "."; |
|
|
247 |
out.set('text', msg); |
|
|
248 |
}, "#demo2_add"); |
|
|
249 |
|
|
|
250 |
Y.on("click", function(e){ |
|
|
251 |
var entry = cache2.retrieve(Y.one("#demo2_retrieveKey").get("value")), |
|
|
252 |
output = entry ? entry.response : "Value not cached."; |
|
|
253 |
out.set('text', output); |
|
|
254 |
}, "#demo2_retrieve"); |
|
|
255 |
|
|
|
256 |
Y.on("click", function(e){ |
|
|
257 |
cache2.flush(); |
|
|
258 |
out.set('text', "Cache 2 flushed."); |
|
|
259 |
}, "#demo2_flush"); |
|
|
260 |
}); |
|
|
261 |
</script></pre> |
|
|
262 |
|
|
|
263 |
</div> |
|
|
264 |
</div> |
|
|
265 |
</div> |
|
|
266 |
|
|
|
267 |
<div class="yui3-u-1-4"> |
|
|
268 |
<div class="sidebar"> |
|
|
269 |
|
|
|
270 |
|
|
|
271 |
|
|
|
272 |
<div class="sidebox"> |
|
|
273 |
<div class="hd"> |
|
|
274 |
<h2 class="no-toc">Examples</h2> |
|
|
275 |
</div> |
|
|
276 |
|
|
|
277 |
<div class="bd"> |
|
|
278 |
<ul class="examples"> |
|
|
279 |
|
|
|
280 |
|
|
|
281 |
<li data-description="Basic caching functionality with the Cache Utility."> |
|
|
282 |
<a href="cache-basic.html">Basic Caching</a> |
|
|
283 |
</li> |
|
|
284 |
|
|
|
285 |
|
|
|
286 |
|
|
|
287 |
<li data-description="Offline caching implements HTML 5 localStorage when available, to allow data to persist across browser sessions."> |
|
|
288 |
<a href="cache-offline.html">Offline Caching</a> |
|
|
289 |
</li> |
|
|
290 |
|
|
|
291 |
|
|
|
292 |
|
|
|
293 |
|
|
|
294 |
|
|
|
295 |
|
|
|
296 |
</ul> |
|
|
297 |
</div> |
|
|
298 |
</div> |
|
|
299 |
|
|
|
300 |
|
|
|
301 |
|
|
|
302 |
<div class="sidebox"> |
|
|
303 |
<div class="hd"> |
|
|
304 |
<h2 class="no-toc">Examples That Use This Component</h2> |
|
|
305 |
</div> |
|
|
306 |
|
|
|
307 |
<div class="bd"> |
|
|
308 |
<ul class="examples"> |
|
|
309 |
|
|
|
310 |
|
|
|
311 |
|
|
|
312 |
|
|
|
313 |
|
|
|
314 |
|
|
|
315 |
<li data-description="Use the DataSourceCache plugin to enable caching and reduce server calls to remote sources."> |
|
|
316 |
<a href="../datasource/datasource-caching.html">DataSource with Caching</a> |
|
|
317 |
</li> |
|
|
318 |
|
|
|
319 |
|
|
|
320 |
|
|
|
321 |
<li data-description="The DataSourceCache plugin supports offline caching so that cached data persists across browser sessions."> |
|
|
322 |
<a href="../datasource/datasource-offlinecache.html">DataSource with Offline Cache</a> |
|
|
323 |
</li> |
|
|
324 |
|
|
|
325 |
|
|
|
326 |
</ul> |
|
|
327 |
</div> |
|
|
328 |
</div> |
|
|
329 |
|
|
|
330 |
</div> |
|
|
331 |
</div> |
|
|
332 |
</div> |
|
|
333 |
</div> |
|
|
334 |
|
|
|
335 |
<script src="../assets/vendor/prettify/prettify-min.js"></script> |
|
|
336 |
<script>prettyPrint();</script> |
|
|
337 |
|
|
|
338 |
<script> |
|
|
339 |
YUI.Env.Tests = { |
|
|
340 |
examples: [], |
|
|
341 |
project: '../assets', |
|
|
342 |
assets: '../assets/cache', |
|
|
343 |
name: 'cache-offline', |
|
|
344 |
title: 'Offline Caching', |
|
|
345 |
newWindow: '', |
|
|
346 |
auto: false |
|
|
347 |
}; |
|
|
348 |
YUI.Env.Tests.examples.push('cache-basic'); |
|
|
349 |
YUI.Env.Tests.examples.push('cache-offline'); |
|
|
350 |
YUI.Env.Tests.examples.push('datasource-caching'); |
|
|
351 |
YUI.Env.Tests.examples.push('datasource-offlinecache'); |
|
|
352 |
|
|
|
353 |
</script> |
|
|
354 |
<script src="../assets/yui/test-runner.js"></script> |
|
|
355 |
|
|
|
356 |
|
|
|
357 |
|
|
|
358 |
</body> |
|
|
359 |
</html> |