<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>YUI Library Examples: Cache Utility: Basic Caching</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../assets/yui.css" >
<style>
/*Supplemental CSS for the YUI distribution*/
#custom-doc { width: 95%; min-width: 950px; }
#pagetitle {background-image: url(../../assets/bg_hd.gif);}
/* #pagetitle h1 {background-image: url(../../assets/title_h_bg.gif);}*/
</style>
<link rel="stylesheet" type="text/css" href="../../assets/dpSyntaxHighlighter.css">
<link type="text/css" rel="stylesheet" href="../../build/cssfonts/fonts-min.css" />
<script type="text/javascript" src="../../build/yui/yui-min.js"></script>
<style type="text/css">
/* custom styles for this example */
#demo fieldset {display:block; margin:1em;}
#demo .short {width:2em;}
</style>
</head>
<body id="yahoo-com" class=" yui-skin-sam">
<div id="custom-doc" class="yui-t2">
<div id="hd">
<div id="ygunav">
<p>
<em>
<a href="http://developer.yahoo.com/yui/3/">YUI 3.x Home</a> <i> - </i>
</em>
</p>
<form action="http://search.yahoo.com/search" id="sitesearchform">
<input name="vs" type="hidden" value="developer.yahoo.com">
<input name="vs" type="hidden" value="yuiblog.com">
<div id="sitesearch">
<label for="searchinput">Site Search (YDN & YUIBlog): </label>
<input type="text" id="searchinput" name="p">
<input type="submit" value="Search" id="searchsubmit" class="ygbt">
</div>
</form>
</div>
<div id="ygma"><a href="../../"><img src="../../assets/logo.gif" border="0" width="200" height="93"></a></div>
<div id="pagetitle"><h1>YUI Library Examples: Cache Utility: Basic Caching</h1></div>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<div class="yui-ge">
<div class="yui-u first example" id="main">
<h2>Cache Utility: Basic Caching</h2>
<div id="example" class="promo">
<div class="example-intro">
The Cache Utility provides a basic caching mechanism for storing key/value pairs in local JavaScript memory.
</div>
<div class="module example-container ">
<div class="hd exampleHd">
<p class="newWindowButton yui-skin-sam">
<a href="cache_basic_clean.html" target="_blank">View example in new window.</a>
</p>
</div> <div id="example-canvas" class="bd">
<!--BEGIN SOURCE CODE FOR EXAMPLE =============================== -->
<form id="demo">
<fieldset>
<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>
<label for="demo_setUniqueKeys">Enforce unique keys: <input type="checkbox" id="demo_setUniqueKeys"></label>
</fieldset>
<fieldset>
<label for="demo_addKey">Key: <input type="text" id="demo_addKey"></label>
<label for="demo_addValue">Value: <input type="text" id="demo_addValue"></label>
<input type="button" id="demo_add" value="Cache value">
</fieldset>
<fieldset>
<label for="demo_retrieveKey">Key: <input type="text" id="demo_retrieveKey"></label>
<input type="button" id="demo_retrieve" value="Retrieve value">
</fieldset>
<fieldset>
<input type="button" id="demo_flush" value="Flush cache"></label>
</fieldset>
</form>
<script type="text/javascript">
YUI({base:"../../build/", timeout: 10000}).use("node", "datatype-number", "cache" ,function (Y) {
var cache = new Y.Cache();
Y.on("click", function(e){
cache.set("max", Y.DataType.Number.parse(Y.get("#demo_max").get("value")));
alert("Cache max set to " + cache.get("max") + ".");
}, "#demo_setMax");
Y.on("click", function(e){
cache.set("uniqueKeys", Y.get("#demo_setUniqueKeys").get("checked"));
alert("Cache uniqueKeys set to " + cache.get("uniqueKeys") + ".");
}, "#demo_setUniqueKeys");
Y.on("click", function(e){
cache.add(Y.get("#demo_addKey").get("value"), Y.get("#demo_addValue").get("value"));
var msg = cache.get("max") ?
"Value cached. Cache size is now " + cache.get("size") + "." :
"Cache max is " + cache.get("max") + ". Value not cached."
alert(msg);
}, "#demo_add");
Y.on("click", function(e){
var entry = cache.retrieve(Y.get("#demo_retrieveKey").get("value")),
output = entry ? entry.response : "Value not cached.";
alert(output);
}, "#demo_retrieve");
Y.on("click", function(e){
cache.flush();
alert("Cache flushed.");
}, "#demo_flush");
});
</script>
<!--END SOURCE CODE FOR EXAMPLE =============================== -->
</div>
</div>
</div>
<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>
<span class="co1">// Configure Cache maximum size in the constructor</span>
<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>
<span class="co1">// Add entries to the Cache</span>
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>
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>
<span class="co1">// Retrieve a cached entry</span>
<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>
<span class="co1">// Cached entry is an object with a request property and a response property</span>
<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>
<span class="st0">"/cached value: "</span> <span class="sy0">+</span> cachedentry.<span class="me1">response</span><span class="br0">)</span><span class="sy0">;</span>
<span class="co1">// Flush the cache</span>
cache.<span class="me1">flush</span><span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span>
<span class="br0">}</span><span class="br0">)</span><span class="sy0">;</span></pre></div><textarea id="syntax1-plain">YUI().use("cache", function(Y) {
// Configure Cache maximum size in the constructor
var cache = new Y.Cache({max:5});
// Add entries to the Cache
cache.add("key1", "value1");
cache.add("key2", "value2");
// Retrieve a cached entry
var cachedentry = cache.retrieve("key1");
// Cached entry is an object with a request property and a response property
alert("cached key: " + cachedentry.request +
"/cached value: " + cachedentry.response);
// Flush the cache
cache.flush();
});</textarea></div> </div>
<div class="yui-u sidebar">
<div id="examples" class="mod box4">
<div class="hd">
<h4>
Cache Utility Examples:</h4>
</div>
<div class="bd">
<ul>
<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>
</div>
</div>
<div class="mod box4">
<div class="hd">
<h4>More Cache Utility Resources:</h4>
</div>
<div class="bd">
<ul>
<!-- <li><a href="http://developer.yahoo.com/yui/cache/">User's Guide</a> (external)</li> -->
<li><a href="../../api/module_cache.html">API Documentation</a></li></ul>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="yui-b toc3" id="tocWrapper">
<!-- TABLE OF CONTENTS -->
<div id="toc">
<ul>
<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>
</div>
</div>
</div><!--closes bd-->
<div id="ft">
<p class="first">Copyright © 2009 Yahoo! Inc. All rights reserved.</p>
<p><a href="http://privacy.yahoo.com/privacy/us/devel/index.html">Privacy Policy</a> -
<a href="http://docs.yahoo.com/info/terms/">Terms of Service</a> -
<a href="http://docs.yahoo.com/info/copyright/copyright.html">Copyright Policy</a> -
<a href="http://careers.yahoo.com/">Job Openings</a></p>
</div>
</div>
<script language="javascript">
var yuiConfig = {base:"../../build/", timeout: 10000};
</script>
<script src="../../assets/syntax.js"></script>
<script src="../../assets/dpSyntaxHighlighter.js"></script>
<script language="javascript">
dp.SyntaxHighlighter.HighlightAll('code');
</script>
</body>
</html>