|
1 |
|
2 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> |
|
3 <html> |
|
4 <head> |
|
5 <title>YUI Library Examples: Cache Utility: Basic Caching</title> |
|
6 <meta http-equiv="content-type" content="text/html; charset=utf-8"> |
|
7 <link rel="stylesheet" type="text/css" href="../../assets/yui.css" > |
|
8 |
|
9 <style> |
|
10 /*Supplemental CSS for the YUI distribution*/ |
|
11 #custom-doc { width: 95%; min-width: 950px; } |
|
12 #pagetitle {background-image: url(../../assets/bg_hd.gif);} |
|
13 /* #pagetitle h1 {background-image: url(../../assets/title_h_bg.gif);}*/ |
|
14 </style> |
|
15 |
|
16 <link rel="stylesheet" type="text/css" href="../../assets/dpSyntaxHighlighter.css"> |
|
17 <link type="text/css" rel="stylesheet" href="../../build/cssfonts/fonts-min.css" /> |
|
18 <script type="text/javascript" src="../../build/yui/yui-min.js"></script> |
|
19 <style type="text/css"> |
|
20 /* custom styles for this example */ |
|
21 #demo fieldset {display:block; margin:1em;} |
|
22 #demo .short {width:2em;} |
|
23 </style> |
|
24 |
|
25 </head> |
|
26 <body id="yahoo-com" class=" yui-skin-sam"> |
|
27 <div id="custom-doc" class="yui-t2"> |
|
28 <div id="hd"> |
|
29 <div id="ygunav"> |
|
30 <p> |
|
31 <em> |
|
32 <a href="http://developer.yahoo.com/yui/3/">YUI 3.x Home</a> <i> - </i> |
|
33 </em> |
|
34 </p> |
|
35 <form action="http://search.yahoo.com/search" id="sitesearchform"> |
|
36 <input name="vs" type="hidden" value="developer.yahoo.com"> |
|
37 <input name="vs" type="hidden" value="yuiblog.com"> |
|
38 <div id="sitesearch"> |
|
39 <label for="searchinput">Site Search (YDN & YUIBlog): </label> |
|
40 <input type="text" id="searchinput" name="p"> |
|
41 <input type="submit" value="Search" id="searchsubmit" class="ygbt"> |
|
42 </div> |
|
43 </form> |
|
44 </div> |
|
45 <div id="ygma"><a href="../../"><img src="../../assets/logo.gif" border="0" width="200" height="93"></a></div> |
|
46 <div id="pagetitle"><h1>YUI Library Examples: Cache Utility: Basic Caching</h1></div> |
|
47 </div> |
|
48 <div id="bd"> |
|
49 |
|
50 |
|
51 <div id="yui-main"> |
|
52 <div class="yui-b"> |
|
53 <div class="yui-ge"> |
|
54 <div class="yui-u first example" id="main"> |
|
55 |
|
56 <h2>Cache Utility: Basic Caching</h2> |
|
57 |
|
58 <div id="example" class="promo"> |
|
59 <div class="example-intro"> |
|
60 The Cache Utility provides a basic caching mechanism for storing key/value pairs in local JavaScript memory. |
|
61 </div> |
|
62 |
|
63 <div class="module example-container "> |
|
64 <div class="hd exampleHd"> |
|
65 <p class="newWindowButton yui-skin-sam"> |
|
66 <a href="cache_basic_clean.html" target="_blank">View example in new window.</a> |
|
67 </p> |
|
68 </div> <div id="example-canvas" class="bd"> |
|
69 |
|
70 |
|
71 <!--BEGIN SOURCE CODE FOR EXAMPLE =============================== --> |
|
72 |
|
73 <form id="demo"> |
|
74 <fieldset> |
|
75 <label for="demo_max">Cache max: <input type="text" id="demo_max" class="short" value="0"> <input type="button" id="demo_setMax" value="Set max"></label> |
|
76 <label for="demo_setUniqueKeys">Enforce unique keys: <input type="checkbox" id="demo_setUniqueKeys"></label> |
|
77 </fieldset> |
|
78 <fieldset> |
|
79 <label for="demo_addKey">Key: <input type="text" id="demo_addKey"></label> |
|
80 <label for="demo_addValue">Value: <input type="text" id="demo_addValue"></label> |
|
81 <input type="button" id="demo_add" value="Cache value"> |
|
82 </fieldset> |
|
83 <fieldset> |
|
84 <label for="demo_retrieveKey">Key: <input type="text" id="demo_retrieveKey"></label> |
|
85 <input type="button" id="demo_retrieve" value="Retrieve value"> |
|
86 </fieldset> |
|
87 <fieldset> |
|
88 <input type="button" id="demo_flush" value="Flush cache"></label> |
|
89 </fieldset> |
|
90 </form> |
|
91 |
|
92 |
|
93 |
|
94 <script type="text/javascript"> |
|
95 YUI({base:"../../build/", timeout: 10000}).use("node", "datatype-number", "cache" ,function (Y) { |
|
96 var cache = new Y.Cache(); |
|
97 |
|
98 Y.on("click", function(e){ |
|
99 cache.set("max", Y.DataType.Number.parse(Y.get("#demo_max").get("value"))); |
|
100 alert("Cache max set to " + cache.get("max") + "."); |
|
101 }, "#demo_setMax"); |
|
102 |
|
103 Y.on("click", function(e){ |
|
104 cache.set("uniqueKeys", Y.get("#demo_setUniqueKeys").get("checked")); |
|
105 alert("Cache uniqueKeys set to " + cache.get("uniqueKeys") + "."); |
|
106 }, "#demo_setUniqueKeys"); |
|
107 |
|
108 Y.on("click", function(e){ |
|
109 cache.add(Y.get("#demo_addKey").get("value"), Y.get("#demo_addValue").get("value")); |
|
110 var msg = cache.get("max") ? |
|
111 "Value cached. Cache size is now " + cache.get("size") + "." : |
|
112 "Cache max is " + cache.get("max") + ". Value not cached." |
|
113 alert(msg); |
|
114 }, "#demo_add"); |
|
115 |
|
116 Y.on("click", function(e){ |
|
117 var entry = cache.retrieve(Y.get("#demo_retrieveKey").get("value")), |
|
118 output = entry ? entry.response : "Value not cached."; |
|
119 alert(output); |
|
120 }, "#demo_retrieve"); |
|
121 |
|
122 Y.on("click", function(e){ |
|
123 cache.flush(); |
|
124 alert("Cache flushed."); |
|
125 }, "#demo_flush"); |
|
126 }); |
|
127 </script> |
|
128 |
|
129 <!--END SOURCE CODE FOR EXAMPLE =============================== --> |
|
130 |
|
131 |
|
132 </div> |
|
133 </div> |
|
134 </div> |
|
135 |
|
136 <div id="syntax1" class="yui-syntax-highlight"><div class="numbers"><pre class="javascript" style="font-family:monospace;"><ol><li class="li1"><div class="de1">YUI<span class="br0">(</span><span class="br0">)</span>.<span class="kw2">use</span><span class="br0">(</span><span class="st0">"cache"</span><span class="sy0">,</span> <span class="kw2">function</span><span class="br0">(</span>Y<span class="br0">)</span> <span class="br0">{</span></div></li><li class="li1"><div class="de1"> <span class="co1">// Configure Cache maximum size in the constructor</span></div></li><li class="li1"><div class="de1"> <span class="kw2">var</span> cache <span class="sy0">=</span> <span class="kw2">new</span> Y.<span class="me1">Cache</span><span class="br0">(</span><span class="br0">{</span>max<span class="sy0">:</span><span class="nu0">5</span><span class="br0">}</span><span class="br0">)</span><span class="sy0">;</span></div></li><li class="li1"><div class="de1"> </div></li><li class="li2"><div class="de2"> <span class="co1">// Add entries to the Cache</span></div></li><li class="li1"><div class="de1"> cache.<span class="me1">add</span><span class="br0">(</span><span class="st0">"key1"</span><span class="sy0">,</span> <span class="st0">"value1"</span><span class="br0">)</span><span class="sy0">;</span></div></li><li class="li1"><div class="de1"> cache.<span class="me1">add</span><span class="br0">(</span><span class="st0">"key2"</span><span class="sy0">,</span> <span class="st0">"value2"</span><span class="br0">)</span><span class="sy0">;</span></div></li><li class="li1"><div class="de1"> </div></li><li class="li1"><div class="de1"> <span class="co1">// Retrieve a cached entry</span></div></li><li class="li2"><div class="de2"> <span class="kw2">var</span> cachedentry <span class="sy0">=</span> cache.<span class="me1">retrieve</span><span class="br0">(</span><span class="st0">"key1"</span><span class="br0">)</span><span class="sy0">;</span></div></li><li class="li1"><div class="de1"> </div></li><li class="li1"><div class="de1"> <span class="co1">// Cached entry is an object with a request property and a response property</span></div></li><li class="li1"><div class="de1"> <span class="kw3">alert</span><span class="br0">(</span><span class="st0">"cached key: "</span> <span class="sy0">+</span> cachedentry.<span class="me1">request</span> <span class="sy0">+</span></div></li><li class="li1"><div class="de1"> <span class="st0">"/cached value: "</span> <span class="sy0">+</span> cachedentry.<span class="me1">response</span><span class="br0">)</span><span class="sy0">;</span></div></li><li class="li2"><div class="de2"> </div></li><li class="li1"><div class="de1"> <span class="co1">// Flush the cache</span></div></li><li class="li1"><div class="de1"> cache.<span class="me1">flush</span><span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span></div></li><li class="li1"><div class="de1"><span class="br0">}</span><span class="br0">)</span><span class="sy0">;</span></div></li></ol></pre></div><div class="nonumbers"><pre class="javascript" style="font-family:monospace;">YUI<span class="br0">(</span><span class="br0">)</span>.<span class="kw2">use</span><span class="br0">(</span><span class="st0">"cache"</span><span class="sy0">,</span> <span class="kw2">function</span><span class="br0">(</span>Y<span class="br0">)</span> <span class="br0">{</span> |
|
137 <span class="co1">// Configure Cache maximum size in the constructor</span> |
|
138 <span class="kw2">var</span> cache <span class="sy0">=</span> <span class="kw2">new</span> Y.<span class="me1">Cache</span><span class="br0">(</span><span class="br0">{</span>max<span class="sy0">:</span><span class="nu0">5</span><span class="br0">}</span><span class="br0">)</span><span class="sy0">;</span> |
|
139 |
|
140 <span class="co1">// Add entries to the Cache</span> |
|
141 cache.<span class="me1">add</span><span class="br0">(</span><span class="st0">"key1"</span><span class="sy0">,</span> <span class="st0">"value1"</span><span class="br0">)</span><span class="sy0">;</span> |
|
142 cache.<span class="me1">add</span><span class="br0">(</span><span class="st0">"key2"</span><span class="sy0">,</span> <span class="st0">"value2"</span><span class="br0">)</span><span class="sy0">;</span> |
|
143 |
|
144 <span class="co1">// Retrieve a cached entry</span> |
|
145 <span class="kw2">var</span> cachedentry <span class="sy0">=</span> cache.<span class="me1">retrieve</span><span class="br0">(</span><span class="st0">"key1"</span><span class="br0">)</span><span class="sy0">;</span> |
|
146 |
|
147 <span class="co1">// Cached entry is an object with a request property and a response property</span> |
|
148 <span class="kw3">alert</span><span class="br0">(</span><span class="st0">"cached key: "</span> <span class="sy0">+</span> cachedentry.<span class="me1">request</span> <span class="sy0">+</span> |
|
149 <span class="st0">"/cached value: "</span> <span class="sy0">+</span> cachedentry.<span class="me1">response</span><span class="br0">)</span><span class="sy0">;</span> |
|
150 |
|
151 <span class="co1">// Flush the cache</span> |
|
152 cache.<span class="me1">flush</span><span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span> |
|
153 <span class="br0">}</span><span class="br0">)</span><span class="sy0">;</span></pre></div><textarea id="syntax1-plain">YUI().use("cache", function(Y) { |
|
154 // Configure Cache maximum size in the constructor |
|
155 var cache = new Y.Cache({max:5}); |
|
156 |
|
157 // Add entries to the Cache |
|
158 cache.add("key1", "value1"); |
|
159 cache.add("key2", "value2"); |
|
160 |
|
161 // Retrieve a cached entry |
|
162 var cachedentry = cache.retrieve("key1"); |
|
163 |
|
164 // Cached entry is an object with a request property and a response property |
|
165 alert("cached key: " + cachedentry.request + |
|
166 "/cached value: " + cachedentry.response); |
|
167 |
|
168 // Flush the cache |
|
169 cache.flush(); |
|
170 });</textarea></div> </div> |
|
171 <div class="yui-u sidebar"> |
|
172 |
|
173 |
|
174 <div id="examples" class="mod box4"> |
|
175 <div class="hd"> |
|
176 <h4> |
|
177 Cache Utility Examples:</h4> |
|
178 </div> |
|
179 <div class="bd"> |
|
180 <ul> |
|
181 <li class='selected'><a href='../cache/cache_basic.html'>Basic Caching</a></li><li><a href='../datasource/datasource_caching.html'>DataSource with Caching (included with examples for DataSource Utility)</a></li> </ul> |
|
182 </div> |
|
183 </div> |
|
184 |
|
185 <div class="mod box4"> |
|
186 <div class="hd"> |
|
187 <h4>More Cache Utility Resources:</h4> |
|
188 </div> |
|
189 <div class="bd"> |
|
190 <ul> |
|
191 <!-- <li><a href="http://developer.yahoo.com/yui/cache/">User's Guide</a> (external)</li> --> |
|
192 <li><a href="../../api/module_cache.html">API Documentation</a></li></ul> |
|
193 </div> |
|
194 </div> |
|
195 </div> |
|
196 </div> |
|
197 |
|
198 </div> |
|
199 </div> |
|
200 |
|
201 |
|
202 <div class="yui-b toc3" id="tocWrapper"> |
|
203 <!-- TABLE OF CONTENTS --> |
|
204 <div id="toc"> |
|
205 |
|
206 <ul> |
|
207 <li class="sect first">YUI 3 Resources</li><li class="item"><a title="YUI 3 -- Yahoo! User Interface (YUI) Library" href="http://developer.yahoo.com/yui/3/">YUI 3 Web Site</a></li><li class="item"><a title="Examples of every YUI utility and control in action" href="../../examples/">YUI 3 Examples</a></li><li class="item"><a title="Instantly searchable API documentation for the entire YUI library." href="../../api/">YUI 3 API Docs</a></li><li class="item"><a title="YUI 3 Dependency Configurator -- configure your custom YUI implementation" href="http://developer.yahoo.com/yui/3/configurator">YUI 3 Dependency Configurator</a></li><li class="item"><a title="The YUI 3 Forum on YUILibrary.com" href="http://yuilibrary.com/forum/viewforum.php?f=15">YUI 3 Forums (external)</a></li><li class="item"><a title="Found a bug or a missing feature? Let us know on YUILibrary.com." href="http://developer.yahoo.com/yui/articles/reportingbugs/">Bug Reports/Feature Requests</a></li><li class="item"><a title="YUI is free and open, offered under a BSD license." href="http://developer.yahoo.com/yui/license.html">YUI License</a></li><li class="item"><a title="Download and fork the YUI project on GitHub" href="http://github.com/yui">YUI on Github</a></li><li class="item"><a title="The Yahoo! User Interface Blog" href="http://yuiblog.com">YUI Blog (external)</a></li><li class="sect">YUI 3 Core - Examples</li><li class="item"><a title="YUI Global Object - Functional Examples" href="../../examples/yui/index.html">YUI Global Object</a></li><li class="item"><a title="Event - Functional Examples" href="../../examples/event/index.html">Event</a></li><li class="item"><a title="Node - Functional Examples" href="../../examples/node/index.html">Node</a></li><li class="sect">YUI 3 Component Infrastructure - Examples</li><li class="item"><a title="Attribute - Functional Examples" href="../../examples/attribute/index.html">Attribute</a></li><li class="item"><a title="Plugin - Functional Examples" href="../../examples/plugin/index.html">Plugin <img src='http://l.yimg.com/a/i/not/beta_1.gif'></a></li><li class="item"><a title="Widget - Functional Examples" href="../../examples/widget/index.html">Widget <img src='http://l.yimg.com/a/i/not/beta_1.gif'></a></li><li class="sect">YUI 3 Utilities - Examples</li><li class="item"><a title="Animation - Functional Examples" href="../../examples/anim/index.html">Animation</a></li><li class="item"><a title="AsyncQueue - Functional Examples" href="../../examples/async-queue/index.html">AsyncQueue</a></li><li class="item"><a title="Browser History - Functional Examples" href="../../examples/history/index.html">Browser History</a></li><li class="selected "><a title="Cache - Functional Examples" href="../../examples/cache/index.html">Cache</a></li><li class="item"><a title="Cookie - Functional Examples" href="../../examples/cookie/index.html">Cookie</a></li><li class="item"><a title="DataSchema - Functional Examples" href="../../examples/dataschema/index.html">DataSchema <img src='http://l.yimg.com/a/i/not/beta_1.gif'></a></li><li class="item"><a title="DataSource - Functional Examples" href="../../examples/datasource/index.html">DataSource <img src='http://l.yimg.com/a/i/not/beta_1.gif'></a></li><li class="item"><a title="DataType - Functional Examples" href="../../examples/datatype/index.html">DataType <img src='http://l.yimg.com/a/i/not/beta_1.gif'></a></li><li class="item"><a title="Drag & Drop - Functional Examples" href="../../examples/dd/index.html">Drag & Drop</a></li><li class="item"><a title="Get - Functional Examples" href="../../examples/get/index.html">Get</a></li><li class="item"><a title="ImageLoader - Functional Examples" href="../../examples/imageloader/index.html">ImageLoader</a></li><li class="item"><a title="IO - Functional Examples" href="../../examples/io/index.html">IO</a></li><li class="item"><a title="JSON (JavaScript Object Notation) - Functional Examples" href="../../examples/json/index.html">JSON</a></li><li class="item"><a title="Stylesheet - Functional Examples" href="../../examples/stylesheet/index.html">Stylesheet</a></li><li class="sect">YUI 3 Widgets - Examples</li><li class="item"><a title="Overlay - Functional Examples" href="../../examples/overlay/index.html">Overlay <img src='http://l.yimg.com/a/i/not/beta_1.gif'></a></li><li class="item"><a title="Slider - Functional Examples" href="../../examples/slider/index.html">Slider <img src='http://l.yimg.com/a/i/not/beta_1.gif'></a></li><li class="sect">YUI 3 Node Plugins - Examples</li><li class="item"><a title="FocusManager Node Plugin - Functional Examples" href="../../examples/node-focusmanager/index.html">FocusManager Node Plugin <img src='http://l.yimg.com/a/i/not/beta_1.gif'></a></li><li class="item"><a title="MenuNav Node Plugin - Functional Examples" href="../../examples/node-menunav/index.html">MenuNav Node Plugin <img src='http://l.yimg.com/a/i/not/beta_1.gif'></a></li><li class="sect">YUI 3 CSS - Examples</li><li class="item"><a title="YUI CSS Reset - Functional Examples" href="../../examples/cssreset/index.html">CSS Reset</a></li><li class="item"><a title="YUI Fonts - Functional Examples" href="../../examples/cssfonts/index.html">CSS Fonts</a></li><li class="item"><a title="YUI Base - Functional Examples" href="../../examples/cssbase/index.html">CSS Base</a></li><li class="sect">YUI 3 Developer Tools - Examples</li><li class="item"><a title="Console - Functional Examples" href="../../examples/console/index.html">Console <img src='http://l.yimg.com/a/i/not/beta_1.gif'></a></li><li class="item"><a title="Console Filters Plugin- Functional Examples" href="../../examples/console-filters/index.html">Plugin.ConsoleFilters <img src='http://l.yimg.com/a/i/not/beta_1.gif'></a></li><li class="item"><a title="Profiler - Functional Examples" href="../../examples/profiler/index.html">Profiler</a></li><li class="item"><a title="Test - Functional Examples" href="../../examples/test/index.html">Test</a></li><li class="sect">Other Useful YUI 3 Resources</li><li class="item"><a title="Answers to Frequently Asked Questions about the YUI Library" href="http://developer.yahoo.com/yui/articles/faq/">YUI FAQ (external)</a></li><li class="item"><a title="Yahoo!'s philosophy of Graded Browser Support" href="http://developer.yahoo.com/yui/articles/gbs/">Graded Browser Support (external)</a></li><li class="item"><a title="Videos and podcasts from the YUI Team and from the Yahoo! frontend engineering community." href="http://developer.yahoo.com/yui/theater/">YUI Theater (external)</a></li></ul> |
|
208 </div> |
|
209 </div> |
|
210 </div><!--closes bd--> |
|
211 |
|
212 <div id="ft"> |
|
213 <p class="first">Copyright © 2009 Yahoo! Inc. All rights reserved.</p> |
|
214 <p><a href="http://privacy.yahoo.com/privacy/us/devel/index.html">Privacy Policy</a> - |
|
215 <a href="http://docs.yahoo.com/info/terms/">Terms of Service</a> - |
|
216 <a href="http://docs.yahoo.com/info/copyright/copyright.html">Copyright Policy</a> - |
|
217 <a href="http://careers.yahoo.com/">Job Openings</a></p> |
|
218 </div> |
|
219 </div> |
|
220 <script language="javascript"> |
|
221 var yuiConfig = {base:"../../build/", timeout: 10000}; |
|
222 </script> |
|
223 <script src="../../assets/syntax.js"></script> |
|
224 <script src="../../assets/dpSyntaxHighlighter.js"></script> |
|
225 <script language="javascript"> |
|
226 dp.SyntaxHighlighter.HighlightAll('code'); |
|
227 </script> |
|
228 </body> |
|
229 </html> |