<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Example: Basic Caching</title>
<link rel="stylesheet" href="http://fonts.googleapis.com/css?family=PT+Sans:400,700,400italic,700italic">
<link rel="stylesheet" href="../../build/cssgrids/cssgrids-min.css">
<link rel="stylesheet" href="../assets/css/main.css">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
<script src="../../build/yui/yui-min.js"></script>
</head>
<body>
<!--
<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>
-->
<div id="doc">
<div id="hd">
<h1><img src="http://yuilibrary.com/img/yui-logo.png"></h1>
</div>
<h1>Example: Basic Caching</h1>
<div class="yui3-g">
<div class="yui3-u-3-4">
<div id="main">
<div class="content"><div class="intro">
<p>The Cache Utility provides a basic caching mechanism for storing key/value pairs in local JavaScript memory.
</div>
<div class="example">
<style scoped>
/* custom styles for this example */
#demo fieldset {display:block; border:0;}
#demo .short {width:2em;}
#out {border:1px solid #CCC; padding:1em}
</style>
<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_expires">Data expires after: <input type="text" id="demo_expires" class="med" value="86400000"> milliseconds
<input type="button" id="demo_setExpires" value="Set expires"></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>
<div id="out">(cache results here)</div>
<script>
YUI().use("node", "datatype-number", "cache-base", "escape" , function (Y) {
var cache = new Y.Cache(),
out = Y.one('#out'),
escape = Y.Escape.html;
Y.on("click", function(e){
cache.set("max", Y.DataType.Number.parse(Y.one("#demo_max").get("value")));
var msg = "Cache max set to " + cache.get("max") + ".";
out.setHTML(escape(msg)); // Escape user input for example.
}, "#demo_setMax");
Y.on("click", function(e){
cache.set("uniqueKeys", Y.one("#demo_setUniqueKeys").get("checked"));
var msg = "Cache uniqueKeys set to " + cache.get("uniqueKeys") + ".";
out.setHTML(escape(msg)); // Escape user input for example.
}, "#demo_setUniqueKeys");
Y.on("click", function(e){
cache.set("expires", Y.DataType.Number.parse(Y.one("#demo_expires").get("value")));
var msg = "Cache \"expires\" set to " + cache.get("expires") + ".";
out.setHTML(escape(msg)); // Escape user input for example.
}, "#demo_setExpires");
Y.on("click", function(e){
cache.add(Y.one("#demo_addKey").get("value"), Y.one("#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."
out.setHTML(escape(msg)); // Escape user input for example.
}, "#demo_add");
Y.on("click", function(e){
var entry = cache.retrieve(Y.one("#demo_retrieveKey").get("value")),
msg = entry ? entry.response : "Value not cached.";
out.setHTML(escape(msg)); // Escape user input for example.
}, "#demo_retrieve");
Y.on("click", function(e){
cache.flush();
out.setHTML("Cache flushed.");
}, "#demo_flush");
});
</script>
</div>
<h2>Complete Example Source</h2>
<pre class="code prettyprint"><style scoped>
/* custom styles for this example */
#demo fieldset {display:block; border:0;}
#demo .short {width:2em;}
#out {border:1px solid #CCC; padding:1em}
</style>
<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_expires">Data expires after: <input type="text" id="demo_expires" class="med" value="86400000"> milliseconds
<input type="button" id="demo_setExpires" value="Set expires"></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>
<div id="out">(cache results here)</div>
<script>
YUI().use("node", "datatype-number", "cache-base", "escape" , function (Y) {
var cache = new Y.Cache(),
out = Y.one('#out'),
escape = Y.Escape.html;
Y.on("click", function(e){
cache.set("max", Y.DataType.Number.parse(Y.one("#demo_max").get("value")));
var msg = "Cache max set to " + cache.get("max") + ".";
out.setHTML(escape(msg)); // Escape user input for example.
}, "#demo_setMax");
Y.on("click", function(e){
cache.set("uniqueKeys", Y.one("#demo_setUniqueKeys").get("checked"));
var msg = "Cache uniqueKeys set to " + cache.get("uniqueKeys") + ".";
out.setHTML(escape(msg)); // Escape user input for example.
}, "#demo_setUniqueKeys");
Y.on("click", function(e){
cache.set("expires", Y.DataType.Number.parse(Y.one("#demo_expires").get("value")));
var msg = "Cache \"expires\" set to " + cache.get("expires") + ".";
out.setHTML(escape(msg)); // Escape user input for example.
}, "#demo_setExpires");
Y.on("click", function(e){
cache.add(Y.one("#demo_addKey").get("value"), Y.one("#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."
out.setHTML(escape(msg)); // Escape user input for example.
}, "#demo_add");
Y.on("click", function(e){
var entry = cache.retrieve(Y.one("#demo_retrieveKey").get("value")),
msg = entry ? entry.response : "Value not cached.";
out.setHTML(escape(msg)); // Escape user input for example.
}, "#demo_retrieve");
Y.on("click", function(e){
cache.flush();
out.setHTML("Cache flushed.");
}, "#demo_flush");
});
</script></pre>
</div>
</div>
</div>
<div class="yui3-u-1-4">
<div class="sidebar">
<div class="sidebox">
<div class="hd">
<h2 class="no-toc">Examples</h2>
</div>
<div class="bd">
<ul class="examples">
<li data-description="Basic caching functionality with the Cache Utility.">
<a href="cache-basic.html">Basic Caching</a>
</li>
<li data-description="Offline caching implements HTML 5 localStorage when available, to allow data to persist across browser sessions.">
<a href="cache-offline.html">Offline Caching</a>
</li>
</ul>
</div>
</div>
<div class="sidebox">
<div class="hd">
<h2 class="no-toc">Examples That Use This Component</h2>
</div>
<div class="bd">
<ul class="examples">
<li data-description="Use the DataSourceCache plugin to enable caching and reduce server calls to remote sources.">
<a href="../datasource/datasource-caching.html">DataSource with Caching</a>
</li>
<li data-description="The DataSourceCache plugin supports offline caching so that cached data persists across browser sessions.">
<a href="../datasource/datasource-offlinecache.html">DataSource with Offline Cache</a>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script>
YUI.Env.Tests = {
examples: [],
project: '../assets',
assets: '../assets/cache',
name: 'cache-basic',
title: 'Basic Caching',
newWindow: '',
auto: false
};
YUI.Env.Tests.examples.push('cache-basic');
YUI.Env.Tests.examples.push('cache-offline');
YUI.Env.Tests.examples.push('datasource-caching');
YUI.Env.Tests.examples.push('datasource-offlinecache');
</script>
<script src="../assets/yui/test-runner.js"></script>
</body>
</html>