|
0
|
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> |
|
|
2 |
<html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#"> |
|
|
3 |
<head> |
|
|
4 |
<meta http-equiv="content-type" content="text/html; charset=UTF-8" /> |
|
|
5 |
<title>API: cache cache.js (YUI Library)</title> |
|
|
6 |
|
|
|
7 |
<link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" /> |
|
|
8 |
<link rel="stylesheet" type="text/css" href="assets/api.css" /> |
|
|
9 |
|
|
|
10 |
<script type="text/javascript" src="assets/api-js"></script> |
|
|
11 |
<script type="text/javascript" src="assets/ac-js"></script> |
|
|
12 |
</head> |
|
|
13 |
|
|
|
14 |
<body id="yahoo-com"> |
|
|
15 |
|
|
|
16 |
<div id="doc3" class="yui-t2"> |
|
|
17 |
<div id="hd"> |
|
|
18 |
<h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1> |
|
|
19 |
<h3>cache <span class="subtitle">3.0.0</span></h3> |
|
|
20 |
<a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a> |
|
|
21 |
> <a href="./module_cache.html" title="cache">cache</a> |
|
|
22 |
|
|
|
23 |
> cache.js (source view) |
|
|
24 |
<form onsubmit="return false"> |
|
|
25 |
<div id="propertysearch"> |
|
|
26 |
Search: <input autocomplete="off" id="searchinput" /> |
|
|
27 |
<div id="searchresults"> |
|
|
28 |
|
|
|
29 |
</div> |
|
|
30 |
</div> |
|
|
31 |
</form> |
|
|
32 |
</div> |
|
|
33 |
|
|
|
34 |
<div id="bd"> |
|
|
35 |
<div id="yui-main"> |
|
|
36 |
<div class="yui-b"> |
|
|
37 |
<form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form"> |
|
|
38 |
<fieldset> |
|
|
39 |
<legend>Filters</legend> |
|
|
40 |
<span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span> |
|
|
41 |
<span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span> |
|
|
42 |
<span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span> |
|
|
43 |
</fieldset> |
|
|
44 |
</form> |
|
|
45 |
|
|
|
46 |
<div id="srcout"> |
|
|
47 |
<style> |
|
|
48 |
#doc3 .classopts { display:none; } |
|
|
49 |
</style> |
|
|
50 |
<div class="highlight" ><pre><span class="c">/**</span> |
|
|
51 |
<span class="c"> * The Cache utility provides a common configurable interface for components to</span> |
|
|
52 |
<span class="c"> * cache and retrieve data from a local JavaScript struct.</span> |
|
|
53 |
<span class="c"> *</span> |
|
|
54 |
<span class="c"> * @module cache</span> |
|
|
55 |
<span class="c"> */</span> |
|
|
56 |
<span class="k">var</span> <span class="nx">LANG</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Lang</span><span class="o">,</span> |
|
|
57 |
|
|
|
58 |
<span class="c">/**</span> |
|
|
59 |
<span class="c"> * Base class for the YUI Cache utility.</span> |
|
|
60 |
<span class="c"> * @class Cache</span> |
|
|
61 |
<span class="c"> * @extends Plugin.Base</span> |
|
|
62 |
<span class="c"> * @constructor</span> |
|
|
63 |
<span class="c"> */</span> |
|
|
64 |
<span class="nx">Cache</span> <span class="o">=</span> <span class="k">function</span><span class="o">()</span> <span class="o">{</span> |
|
|
65 |
<span class="nx">Cache</span><span class="o">.</span><span class="nx">superclass</span><span class="o">.</span><span class="nx">constructor</span><span class="o">.</span><span class="nx">apply</span><span class="o">(</span><span class="k">this</span><span class="o">,</span> <span class="nx">arguments</span><span class="o">);</span> |
|
|
66 |
<span class="o">};</span> |
|
|
67 |
|
|
|
68 |
<span class="c">/////////////////////////////////////////////////////////////////////////////</span> |
|
|
69 |
<span class="c"></span> <span class="c">//</span> |
|
|
70 |
<span class="c"></span> <span class="c">// Cache static properties</span> |
|
|
71 |
<span class="c"></span> <span class="c">//</span> |
|
|
72 |
<span class="c"></span> <span class="c">/////////////////////////////////////////////////////////////////////////////</span> |
|
|
73 |
<span class="c"></span><span class="nx">Y</span><span class="o">.</span><span class="nx">mix</span><span class="o">(</span><span class="nx">Cache</span><span class="o">,</span> <span class="o">{</span> |
|
|
74 |
<span class="c">/**</span> |
|
|
75 |
<span class="c"> * The namespace for the plugin. This will be the property on the host which</span> |
|
|
76 |
<span class="c"> * references the plugin instance.</span> |
|
|
77 |
<span class="c"> *</span> |
|
|
78 |
<span class="c"> * @property NS</span> |
|
|
79 |
<span class="c"> * @type String</span> |
|
|
80 |
<span class="c"> * @static</span> |
|
|
81 |
<span class="c"> * @final</span> |
|
|
82 |
<span class="c"> * @value "cache"</span> |
|
|
83 |
<span class="c"> */</span> |
|
|
84 |
<span class="nx">NS</span><span class="o">:</span> <span class="s2">"cache"</span><span class="o">,</span> |
|
|
85 |
|
|
|
86 |
|
|
|
87 |
<span class="c">/**</span> |
|
|
88 |
<span class="c"> * Class name.</span> |
|
|
89 |
<span class="c"> *</span> |
|
|
90 |
<span class="c"> * @property NAME</span> |
|
|
91 |
<span class="c"> * @type String</span> |
|
|
92 |
<span class="c"> * @static </span> |
|
|
93 |
<span class="c"> * @final</span> |
|
|
94 |
<span class="c"> * @value "cache"</span> |
|
|
95 |
<span class="c"> */</span> |
|
|
96 |
<span class="nx">NAME</span><span class="o">:</span> <span class="s2">"cache"</span><span class="o">,</span> |
|
|
97 |
|
|
|
98 |
|
|
|
99 |
<span class="nx">ATTRS</span><span class="o">:</span> <span class="o">{</span> |
|
|
100 |
<span class="c">/////////////////////////////////////////////////////////////////////////////</span> |
|
|
101 |
<span class="c"></span> <span class="c">//</span> |
|
|
102 |
<span class="c"></span> <span class="c">// Cache Attributes</span> |
|
|
103 |
<span class="c"></span> <span class="c">//</span> |
|
|
104 |
<span class="c"></span> <span class="c">/////////////////////////////////////////////////////////////////////////////</span> |
|
|
105 |
<span class="c"></span> |
|
|
106 |
<span class="c">/**</span> |
|
|
107 |
<span class="c"> * @attribute max</span> |
|
|
108 |
<span class="c"> * @description Maximum number of entries the Cache can hold.</span> |
|
|
109 |
<span class="c"> * Set to 0 to turn off caching.</span> |
|
|
110 |
<span class="c"> * @type Number</span> |
|
|
111 |
<span class="c"> * @default 0</span> |
|
|
112 |
<span class="c"> */</span> |
|
|
113 |
<span class="nx">max</span><span class="o">:</span> <span class="o">{</span> |
|
|
114 |
<span class="nx">value</span><span class="o">:</span> <span class="m">0</span><span class="o">,</span> |
|
|
115 |
<span class="nx">validator</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">value</span><span class="o">)</span> <span class="o">{</span> |
|
|
116 |
<span class="k">return</span> <span class="o">(</span><span class="nx">LANG</span><span class="o">.</span><span class="nx">isNumber</span><span class="o">(</span><span class="nx">value</span><span class="o">));</span> |
|
|
117 |
<span class="o">},</span> |
|
|
118 |
<span class="nx">setter</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">value</span><span class="o">)</span> <span class="o">{</span> |
|
|
119 |
<span class="c">// If the cache is full, make room by removing stalest element (index=0)</span> |
|
|
120 |
<span class="c"></span> <span class="k">var</span> <span class="nx">entries</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">_entries</span><span class="o">;</span> |
|
|
121 |
<span class="k">if</span><span class="o">(</span><span class="nx">value</span> <span class="o">></span> <span class="m">0</span><span class="o">)</span> <span class="o">{</span> |
|
|
122 |
<span class="k">if</span><span class="o">(</span><span class="nx">entries</span><span class="o">)</span> <span class="o">{</span> |
|
|
123 |
<span class="k">while</span><span class="o">(</span><span class="nx">entries</span><span class="o">.</span><span class="nx">length</span> <span class="o">></span> <span class="nx">value</span><span class="o">)</span> <span class="o">{</span> |
|
|
124 |
<span class="nx">entries</span><span class="o">.</span><span class="nx">shift</span><span class="o">();</span> |
|
|
125 |
<span class="o">}</span> |
|
|
126 |
<span class="o">}</span> |
|
|
127 |
<span class="o">}</span> |
|
|
128 |
<span class="k">else</span> <span class="o">{</span> |
|
|
129 |
<span class="k">this</span><span class="o">.</span><span class="nx">_entries</span> <span class="o">=</span> <span class="o">[];</span> |
|
|
130 |
<span class="o">}</span> |
|
|
131 |
<span class="k">return</span> <span class="nx">value</span><span class="o">;</span> |
|
|
132 |
<span class="o">}</span> |
|
|
133 |
<span class="o">},</span> |
|
|
134 |
|
|
|
135 |
<span class="c">/**</span> |
|
|
136 |
<span class="c"> * @attribute size</span> |
|
|
137 |
<span class="c"> * @description Number of entries currently cached.</span> |
|
|
138 |
<span class="c"> * @type Number</span> |
|
|
139 |
<span class="c"> */</span> |
|
|
140 |
<span class="nx">size</span><span class="o">:</span> <span class="o">{</span> |
|
|
141 |
<span class="nx">readOnly</span><span class="o">:</span> <span class="kc">true</span><span class="o">,</span> |
|
|
142 |
<span class="nx">getter</span><span class="o">:</span> <span class="k">function</span><span class="o">()</span> <span class="o">{</span> |
|
|
143 |
<span class="k">return</span> <span class="k">this</span><span class="o">.</span><span class="nx">_entries</span><span class="o">.</span><span class="nx">length</span><span class="o">;</span> |
|
|
144 |
<span class="o">}</span> |
|
|
145 |
<span class="o">},</span> |
|
|
146 |
|
|
|
147 |
<span class="c">/**</span> |
|
|
148 |
<span class="c"> * @attribute uniqueKeys</span> |
|
|
149 |
<span class="c"> * @description Validate uniqueness of stored keys. Default is false and</span> |
|
|
150 |
<span class="c"> * is more performant.</span> |
|
|
151 |
<span class="c"> * @type Number</span> |
|
|
152 |
<span class="c"> */</span> |
|
|
153 |
<span class="nx">uniqueKeys</span><span class="o">:</span> <span class="o">{</span> |
|
|
154 |
<span class="nx">value</span><span class="o">:</span> <span class="kc">false</span><span class="o">,</span> |
|
|
155 |
<span class="nx">validator</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">value</span><span class="o">)</span> <span class="o">{</span> |
|
|
156 |
<span class="k">return</span> <span class="o">(</span><span class="nx">LANG</span><span class="o">.</span><span class="nx">isBoolean</span><span class="o">(</span><span class="nx">value</span><span class="o">));</span> |
|
|
157 |
<span class="o">}</span> |
|
|
158 |
<span class="o">},</span> |
|
|
159 |
|
|
|
160 |
<span class="c">/**</span> |
|
|
161 |
<span class="c"> * @attribute entries</span> |
|
|
162 |
<span class="c"> * @description Cached entries.</span> |
|
|
163 |
<span class="c"> * @type Array</span> |
|
|
164 |
<span class="c"> */</span> |
|
|
165 |
<span class="nx">entries</span><span class="o">:</span> <span class="o">{</span> |
|
|
166 |
<span class="nx">readOnly</span><span class="o">:</span> <span class="kc">true</span><span class="o">,</span> |
|
|
167 |
<span class="nx">getter</span><span class="o">:</span> <span class="k">function</span><span class="o">()</span> <span class="o">{</span> |
|
|
168 |
<span class="k">return</span> <span class="k">this</span><span class="o">.</span><span class="nx">_entries</span><span class="o">;</span> |
|
|
169 |
<span class="o">}</span> |
|
|
170 |
<span class="o">}</span> |
|
|
171 |
<span class="o">}</span> |
|
|
172 |
<span class="o">});</span> |
|
|
173 |
|
|
|
174 |
<span class="nx">Y</span><span class="o">.</span><span class="nx">extend</span><span class="o">(</span><span class="nx">Cache</span><span class="o">,</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Plugin</span><span class="o">.</span><span class="nx">Base</span><span class="o">,</span> <span class="o">{</span> |
|
|
175 |
<span class="c">/////////////////////////////////////////////////////////////////////////////</span> |
|
|
176 |
<span class="c"></span> <span class="c">//</span> |
|
|
177 |
<span class="c"></span> <span class="c">// Cache private properties</span> |
|
|
178 |
<span class="c"></span> <span class="c">//</span> |
|
|
179 |
<span class="c"></span> <span class="c">/////////////////////////////////////////////////////////////////////////////</span> |
|
|
180 |
<span class="c"></span> |
|
|
181 |
<span class="c">/**</span> |
|
|
182 |
<span class="c"> * Array of request/response objects indexed chronologically.</span> |
|
|
183 |
<span class="c"> *</span> |
|
|
184 |
<span class="c"> * @property _entries</span> |
|
|
185 |
<span class="c"> * @type Object[]</span> |
|
|
186 |
<span class="c"> * @private</span> |
|
|
187 |
<span class="c"> */</span> |
|
|
188 |
<span class="nx">_entries</span><span class="o">:</span> <span class="kc">null</span><span class="o">,</span> |
|
|
189 |
|
|
|
190 |
<span class="c">/////////////////////////////////////////////////////////////////////////////</span> |
|
|
191 |
<span class="c"></span> <span class="c">//</span> |
|
|
192 |
<span class="c"></span> <span class="c">// Cache private methods</span> |
|
|
193 |
<span class="c"></span> <span class="c">//</span> |
|
|
194 |
<span class="c"></span> <span class="c">/////////////////////////////////////////////////////////////////////////////</span> |
|
|
195 |
<span class="c"></span> |
|
|
196 |
<span class="c">/**</span> |
|
|
197 |
<span class="c"> * @method initializer</span> |
|
|
198 |
<span class="c"> * @description Internal init() handler.</span> |
|
|
199 |
<span class="c"> * @param config {Object} Config object.</span> |
|
|
200 |
<span class="c"> * @private </span> |
|
|
201 |
<span class="c"> */</span> |
|
|
202 |
<span class="nx">initializer</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">config</span><span class="o">)</span> <span class="o">{</span> |
|
|
203 |
|
|
|
204 |
<span class="c">/**</span> |
|
|
205 |
<span class="c"> * @event add</span> |
|
|
206 |
<span class="c"> * @description Fired when an entry is added.</span> |
|
|
207 |
<span class="c"> * @param e {Event.Facade} Event Facade with the following properties:</span> |
|
|
208 |
<span class="c"> * <dl></span> |
|
|
209 |
<span class="c"> * <dt>entry (Object)</dt> <dd>The cached entry.</dd></span> |
|
|
210 |
<span class="c"> * </dl></span> |
|
|
211 |
<span class="c"> * @preventable _defAddFn</span> |
|
|
212 |
<span class="c"> */</span> |
|
|
213 |
<span class="k">this</span><span class="o">.</span><span class="nx">publish</span><span class="o">(</span><span class="s2">"add"</span><span class="o">,</span> <span class="o">{</span><span class="nx">defaultFn</span><span class="o">:</span> <span class="k">this</span><span class="o">.</span><span class="nx">_defAddFn</span><span class="o">});</span> |
|
|
214 |
|
|
|
215 |
<span class="c">/**</span> |
|
|
216 |
<span class="c"> * @event flush</span> |
|
|
217 |
<span class="c"> * @description Fired when the cache is flushed.</span> |
|
|
218 |
<span class="c"> * @param e {Event.Facade} Event Facade object.</span> |
|
|
219 |
<span class="c"> * @preventable _defFlushFn</span> |
|
|
220 |
<span class="c"> */</span> |
|
|
221 |
<span class="k">this</span><span class="o">.</span><span class="nx">publish</span><span class="o">(</span><span class="s2">"flush"</span><span class="o">,</span> <span class="o">{</span><span class="nx">defaultFn</span><span class="o">:</span> <span class="k">this</span><span class="o">.</span><span class="nx">_defFlushFn</span><span class="o">});</span> |
|
|
222 |
|
|
|
223 |
<span class="c">/**</span> |
|
|
224 |
<span class="c"> * @event request</span> |
|
|
225 |
<span class="c"> * @description Fired when an entry is requested from the cache.</span> |
|
|
226 |
<span class="c"> * @param e {Event.Facade} Event Facade with the following properties:</span> |
|
|
227 |
<span class="c"> * <dl></span> |
|
|
228 |
<span class="c"> * <dt>request (Object)</dt> <dd>The request object.</dd></span> |
|
|
229 |
<span class="c"> * </dl></span> |
|
|
230 |
<span class="c"> */</span> |
|
|
231 |
|
|
|
232 |
<span class="c">/**</span> |
|
|
233 |
<span class="c"> * @event retrieve</span> |
|
|
234 |
<span class="c"> * @description Fired when an entry is retrieved from the cache.</span> |
|
|
235 |
<span class="c"> * @param e {Event.Facade} Event Facade with the following properties:</span> |
|
|
236 |
<span class="c"> * <dl></span> |
|
|
237 |
<span class="c"> * <dt>entry (Object)</dt> <dd>The retrieved entry.</dd></span> |
|
|
238 |
<span class="c"> * </dl></span> |
|
|
239 |
<span class="c"> */</span> |
|
|
240 |
|
|
|
241 |
<span class="c">// Initialize internal values</span> |
|
|
242 |
<span class="c"></span> <span class="k">this</span><span class="o">.</span><span class="nx">_entries</span> <span class="o">=</span> <span class="o">[];</span> |
|
|
243 |
<span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s2">"Cache initialized"</span><span class="o">,</span> <span class="s2">"info"</span><span class="o">,</span> <span class="s2">"cache"</span><span class="o">);</span> |
|
|
244 |
<span class="o">},</span> |
|
|
245 |
|
|
|
246 |
<span class="c">/**</span> |
|
|
247 |
<span class="c"> * @method destructor</span> |
|
|
248 |
<span class="c"> * @description Internal destroy() handler.</span> |
|
|
249 |
<span class="c"> * @private </span> |
|
|
250 |
<span class="c"> */</span> |
|
|
251 |
<span class="nx">destructor</span><span class="o">:</span> <span class="k">function</span><span class="o">()</span> <span class="o">{</span> |
|
|
252 |
<span class="k">this</span><span class="o">.</span><span class="nx">_entries</span> <span class="o">=</span> <span class="kc">null</span><span class="o">;</span> |
|
|
253 |
<span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s2">"Cache destroyed"</span><span class="o">,</span> <span class="s2">"info"</span><span class="o">,</span> <span class="s2">"cache"</span><span class="o">);</span> |
|
|
254 |
<span class="o">},</span> |
|
|
255 |
|
|
|
256 |
<span class="c">/////////////////////////////////////////////////////////////////////////////</span> |
|
|
257 |
<span class="c"></span> <span class="c">//</span> |
|
|
258 |
<span class="c"></span> <span class="c">// Cache protected methods</span> |
|
|
259 |
<span class="c"></span> <span class="c">//</span> |
|
|
260 |
<span class="c"></span> <span class="c">/////////////////////////////////////////////////////////////////////////////</span> |
|
|
261 |
<span class="c"></span> |
|
|
262 |
<span class="c">/**</span> |
|
|
263 |
<span class="c"> * Adds entry to cache.</span> |
|
|
264 |
<span class="c"> *</span> |
|
|
265 |
<span class="c"> * @method _defAddFn</span> |
|
|
266 |
<span class="c"> * @param e {Event.Facade} Event Facade with the following properties:</span> |
|
|
267 |
<span class="c"> * <dl></span> |
|
|
268 |
<span class="c"> * <dt>entry (Object)</dt> <dd>The cached entry.</dd></span> |
|
|
269 |
<span class="c"> * </dl></span> |
|
|
270 |
<span class="c"> * @protected</span> |
|
|
271 |
<span class="c"> */</span> |
|
|
272 |
<span class="nx">_defAddFn</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">e</span><span class="o">)</span> <span class="o">{</span> |
|
|
273 |
<span class="k">var</span> <span class="nx">entries</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">_entries</span><span class="o">,</span> |
|
|
274 |
<span class="nx">max</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="s2">"max"</span><span class="o">),</span> |
|
|
275 |
<span class="nx">entry</span> <span class="o">=</span> <span class="nx">e</span><span class="o">.</span><span class="nx">entry</span><span class="o">;</span> |
|
|
276 |
|
|
|
277 |
<span class="k">if</span><span class="o">(</span><span class="k">this</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="s2">"uniqueKeys"</span><span class="o">)</span> <span class="o">&&</span> <span class="o">(</span><span class="k">this</span><span class="o">.</span><span class="nx">retrieve</span><span class="o">(</span><span class="nx">e</span><span class="o">.</span><span class="nx">entry</span><span class="o">.</span><span class="nx">request</span><span class="o">)))</span> <span class="o">{</span> |
|
|
278 |
<span class="nx">entries</span><span class="o">.</span><span class="nx">shift</span><span class="o">();</span> |
|
|
279 |
<span class="o">}</span> |
|
|
280 |
|
|
|
281 |
|
|
|
282 |
<span class="c">// If the cache at or over capacity, make room by removing stalest element (index=0)</span> |
|
|
283 |
<span class="c"></span> <span class="k">while</span><span class="o">(</span><span class="nx">entries</span><span class="o">.</span><span class="nx">length</span><span class="o">>=</span><span class="nx">max</span><span class="o">)</span> <span class="o">{</span> |
|
|
284 |
<span class="nx">entries</span><span class="o">.</span><span class="nx">shift</span><span class="o">();</span> |
|
|
285 |
<span class="o">}</span> |
|
|
286 |
|
|
|
287 |
<span class="c">// Add entry to cache in the newest position, at the end of the array</span> |
|
|
288 |
<span class="c"></span> <span class="nx">entries</span><span class="o">[</span><span class="nx">entries</span><span class="o">.</span><span class="nx">length</span><span class="o">]</span> <span class="o">=</span> <span class="nx">entry</span><span class="o">;</span> |
|
|
289 |
<span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s2">"Cached entry: "</span> <span class="o">+</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">dump</span><span class="o">(</span><span class="nx">entry</span><span class="o">),</span> <span class="s2">"info"</span><span class="o">,</span> <span class="s2">"cache"</span><span class="o">);</span> |
|
|
290 |
<span class="o">},</span> |
|
|
291 |
|
|
|
292 |
<span class="c">/**</span> |
|
|
293 |
<span class="c"> * Flushes cache.</span> |
|
|
294 |
<span class="c"> *</span> |
|
|
295 |
<span class="c"> * @method _defFlushFn</span> |
|
|
296 |
<span class="c"> * @param e {Event.Facade} Event Facade object.</span> |
|
|
297 |
<span class="c"> * @protected </span> |
|
|
298 |
<span class="c"> */</span> |
|
|
299 |
<span class="nx">_defFlushFn</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">e</span><span class="o">)</span> <span class="o">{</span> |
|
|
300 |
<span class="k">this</span><span class="o">.</span><span class="nx">_entries</span> <span class="o">=</span> <span class="o">[];</span> |
|
|
301 |
<span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s2">"Cache flushed"</span><span class="o">,</span> <span class="s2">"info"</span><span class="o">,</span> <span class="s2">"cache"</span><span class="o">);</span> |
|
|
302 |
<span class="o">},</span> |
|
|
303 |
|
|
|
304 |
<span class="c">/**</span> |
|
|
305 |
<span class="c"> * Default overridable method compares current request with given cache entry.</span> |
|
|
306 |
<span class="c"> * Returns true if current request matches the cached request, otherwise</span> |
|
|
307 |
<span class="c"> * false. Implementers should override this method to customize the</span> |
|
|
308 |
<span class="c"> * cache-matching algorithm.</span> |
|
|
309 |
<span class="c"> *</span> |
|
|
310 |
<span class="c"> * @method _isMatch</span> |
|
|
311 |
<span class="c"> * @param request {Object} Request object.</span> |
|
|
312 |
<span class="c"> * @param entry {Object} Cached entry.</span> |
|
|
313 |
<span class="c"> * @return {Boolean} True if current request matches given cached request, false otherwise.</span> |
|
|
314 |
<span class="c"> * @protected</span> |
|
|
315 |
<span class="c"> */</span> |
|
|
316 |
<span class="nx">_isMatch</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">request</span><span class="o">,</span> <span class="nx">entry</span><span class="o">)</span> <span class="o">{</span> |
|
|
317 |
<span class="k">return</span> <span class="o">(</span><span class="nx">request</span> <span class="o">===</span> <span class="nx">entry</span><span class="o">.</span><span class="nx">request</span><span class="o">);</span> |
|
|
318 |
<span class="o">},</span> |
|
|
319 |
|
|
|
320 |
<span class="c">/////////////////////////////////////////////////////////////////////////////</span> |
|
|
321 |
<span class="c"></span> <span class="c">//</span> |
|
|
322 |
<span class="c"></span> <span class="c">// Cache public methods</span> |
|
|
323 |
<span class="c"></span> <span class="c">//</span> |
|
|
324 |
<span class="c"></span> <span class="c">/////////////////////////////////////////////////////////////////////////////</span> |
|
|
325 |
<span class="c"></span> |
|
|
326 |
<span class="c">/**</span> |
|
|
327 |
<span class="c"> * Adds a new entry to the cache of the format</span> |
|
|
328 |
<span class="c"> * {request:request, response:response, payload:payload}.</span> |
|
|
329 |
<span class="c"> * If cache is full, evicts the stalest entry before adding the new one.</span> |
|
|
330 |
<span class="c"> *</span> |
|
|
331 |
<span class="c"> * @method add</span> |
|
|
332 |
<span class="c"> * @param request {Object} Request value.</span> |
|
|
333 |
<span class="c"> * @param response {Object} Response value.</span> |
|
|
334 |
<span class="c"> * @param payload {Object} (optional) Arbitrary data payload.</span> |
|
|
335 |
<span class="c"> */</span> |
|
|
336 |
<span class="nx">add</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">request</span><span class="o">,</span> <span class="nx">response</span><span class="o">,</span> <span class="nx">payload</span><span class="o">)</span> <span class="o">{</span> |
|
|
337 |
<span class="k">if</span><span class="o">(</span><span class="k">this</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="s2">"entries"</span><span class="o">)</span> <span class="o">&&</span> <span class="o">(</span><span class="k">this</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="s2">"max"</span><span class="o">)></span><span class="m">0</span><span class="o">)</span> <span class="o">&&</span> |
|
|
338 |
<span class="o">(</span><span class="nx">LANG</span><span class="o">.</span><span class="nx">isValue</span><span class="o">(</span><span class="nx">request</span><span class="o">)</span> <span class="o">||</span> <span class="nx">LANG</span><span class="o">.</span><span class="nx">isNull</span><span class="o">(</span><span class="nx">request</span><span class="o">)</span> <span class="o">||</span> <span class="nx">LANG</span><span class="o">.</span><span class="nx">isUndefined</span><span class="o">(</span><span class="nx">request</span><span class="o">)))</span> <span class="o">{</span> |
|
|
339 |
<span class="k">this</span><span class="o">.</span><span class="nx">fire</span><span class="o">(</span><span class="s2">"add"</span><span class="o">,</span> <span class="o">{</span><span class="nx">entry</span><span class="o">:</span> <span class="o">{</span><span class="nx">request</span><span class="o">:</span><span class="nx">request</span><span class="o">,</span> <span class="nx">response</span><span class="o">:</span><span class="nx">response</span><span class="o">,</span> <span class="nx">payload</span><span class="o">:</span><span class="nx">payload</span><span class="o">}});</span> |
|
|
340 |
<span class="o">}</span> |
|
|
341 |
<span class="k">else</span> <span class="o">{</span> |
|
|
342 |
<span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s2">"Could not add "</span> <span class="o">+</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">dump</span><span class="o">(</span><span class="nx">response</span><span class="o">)</span> <span class="o">+</span> <span class="s2">" to cache for "</span> <span class="o">+</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">dump</span><span class="o">(</span><span class="nx">request</span><span class="o">),</span> <span class="s2">"info"</span><span class="o">,</span> <span class="s2">"cache"</span><span class="o">);</span> |
|
|
343 |
<span class="o">}</span> |
|
|
344 |
<span class="o">},</span> |
|
|
345 |
|
|
|
346 |
<span class="c">/**</span> |
|
|
347 |
<span class="c"> * Flushes cache.</span> |
|
|
348 |
<span class="c"> *</span> |
|
|
349 |
<span class="c"> * @method flush</span> |
|
|
350 |
<span class="c"> */</span> |
|
|
351 |
<span class="nx">flush</span><span class="o">:</span> <span class="k">function</span><span class="o">()</span> <span class="o">{</span> |
|
|
352 |
<span class="k">this</span><span class="o">.</span><span class="nx">fire</span><span class="o">(</span><span class="s2">"flush"</span><span class="o">);</span> |
|
|
353 |
<span class="o">},</span> |
|
|
354 |
|
|
|
355 |
<span class="c">/**</span> |
|
|
356 |
<span class="c"> * Retrieves cached entry for given request, if available, and refreshes</span> |
|
|
357 |
<span class="c"> * entry in the cache. Returns null if there is no cache match.</span> |
|
|
358 |
<span class="c"> *</span> |
|
|
359 |
<span class="c"> * @method retrieve</span> |
|
|
360 |
<span class="c"> * @param request {Object} Request object.</span> |
|
|
361 |
<span class="c"> * @return {Object} Cached entry object with the properties request, response, and payload, or null.</span> |
|
|
362 |
<span class="c"> */</span> |
|
|
363 |
<span class="nx">retrieve</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">request</span><span class="o">)</span> <span class="o">{</span> |
|
|
364 |
<span class="c">// If cache is enabled...</span> |
|
|
365 |
<span class="c"></span> <span class="k">var</span> <span class="nx">entries</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">_entries</span><span class="o">,</span> |
|
|
366 |
<span class="nx">length</span> <span class="o">=</span> <span class="nx">entries</span><span class="o">.</span><span class="nx">length</span><span class="o">,</span> |
|
|
367 |
<span class="nx">entry</span> <span class="o">=</span> <span class="kc">null</span><span class="o">,</span> |
|
|
368 |
<span class="nx">i</span> <span class="o">=</span> <span class="nx">length</span><span class="o">-</span><span class="m">1</span><span class="o">;</span> |
|
|
369 |
|
|
|
370 |
<span class="k">if</span><span class="o">((</span><span class="k">this</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="s2">"max"</span><span class="o">)</span> <span class="o">></span> <span class="m">0</span><span class="o">)</span> <span class="o">&&</span> <span class="o">(</span><span class="nx">length</span> <span class="o">></span> <span class="m">0</span><span class="o">))</span> <span class="o">{</span> |
|
|
371 |
<span class="k">this</span><span class="o">.</span><span class="nx">fire</span><span class="o">(</span><span class="s2">"request"</span><span class="o">,</span> <span class="o">{</span><span class="nx">request</span><span class="o">:</span> <span class="nx">request</span><span class="o">});</span> |
|
|
372 |
|
|
|
373 |
<span class="c">// Loop through each cached entry starting from the newest</span> |
|
|
374 |
<span class="c"></span> <span class="k">for</span><span class="o">(;</span> <span class="nx">i</span> <span class="o">>=</span> <span class="m">0</span><span class="o">;</span> <span class="nx">i</span><span class="o">--)</span> <span class="o">{</span> |
|
|
375 |
<span class="nx">entry</span> <span class="o">=</span> <span class="nx">entries</span><span class="o">[</span><span class="nx">i</span><span class="o">];</span> |
|
|
376 |
|
|
|
377 |
<span class="c">// Execute matching function</span> |
|
|
378 |
<span class="c"></span> <span class="k">if</span><span class="o">(</span><span class="k">this</span><span class="o">.</span><span class="nx">_isMatch</span><span class="o">(</span><span class="nx">request</span><span class="o">,</span> <span class="nx">entry</span><span class="o">))</span> <span class="o">{</span> |
|
|
379 |
<span class="k">this</span><span class="o">.</span><span class="nx">fire</span><span class="o">(</span><span class="s2">"retrieve"</span><span class="o">,</span> <span class="o">{</span><span class="nx">entry</span><span class="o">:</span> <span class="nx">entry</span><span class="o">});</span> |
|
|
380 |
|
|
|
381 |
<span class="c">// Refresh the position of the cache hit</span> |
|
|
382 |
<span class="c"></span> <span class="k">if</span><span class="o">(</span><span class="nx">i</span> <span class="o"><</span> <span class="nx">length</span><span class="o">-</span><span class="m">1</span><span class="o">)</span> <span class="o">{</span> |
|
|
383 |
<span class="c">// Remove element from its original location</span> |
|
|
384 |
<span class="c"></span> <span class="nx">entries</span><span class="o">.</span><span class="nx">splice</span><span class="o">(</span><span class="nx">i</span><span class="o">,</span><span class="m">1</span><span class="o">);</span> |
|
|
385 |
<span class="c">// Add as newest</span> |
|
|
386 |
<span class="c"></span> <span class="nx">entries</span><span class="o">[</span><span class="nx">entries</span><span class="o">.</span><span class="nx">length</span><span class="o">]</span> <span class="o">=</span> <span class="nx">entry</span><span class="o">;</span> |
|
|
387 |
<span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s2">"Refreshed cache entry: "</span> <span class="o">+</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">dump</span><span class="o">(</span><span class="nx">entry</span><span class="o">)</span> <span class="o">+</span> |
|
|
388 |
<span class="s2">" for request: "</span> <span class="o">+</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">dump</span><span class="o">(</span><span class="nx">request</span><span class="o">),</span> <span class="s2">"info"</span><span class="o">,</span> <span class="s2">"cache"</span><span class="o">);</span> |
|
|
389 |
<span class="o">}</span> |
|
|
390 |
|
|
|
391 |
<span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s2">"Retrieved cached response: "</span> <span class="o">+</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">dump</span><span class="o">(</span><span class="nx">entry</span><span class="o">)</span> <span class="o">+</span> |
|
|
392 |
<span class="s2">" for request: "</span> <span class="o">+</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">dump</span><span class="o">(</span><span class="nx">request</span><span class="o">),</span> <span class="s2">"info"</span><span class="o">,</span> <span class="s2">"cache"</span><span class="o">);</span> |
|
|
393 |
<span class="k">return</span> <span class="nx">entry</span><span class="o">;</span> |
|
|
394 |
<span class="o">}</span> |
|
|
395 |
<span class="o">}</span> |
|
|
396 |
<span class="o">}</span> |
|
|
397 |
<span class="k">return</span> <span class="kc">null</span><span class="o">;</span> |
|
|
398 |
<span class="o">}</span> |
|
|
399 |
<span class="o">});</span> |
|
|
400 |
|
|
|
401 |
<span class="nx">Y</span><span class="o">.</span><span class="nx">Cache</span> <span class="o">=</span> <span class="nx">Cache</span><span class="o">;</span> |
|
|
402 |
|
|
|
403 |
</pre></div> |
|
|
404 |
|
|
|
405 |
</div> |
|
|
406 |
</div> |
|
|
407 |
</div> |
|
|
408 |
<div class="yui-b"> |
|
|
409 |
<div class="nav"> |
|
|
410 |
|
|
|
411 |
<div id="moduleList" class="module"> |
|
|
412 |
<h4>Modules</h4> |
|
|
413 |
<ul class="content"> |
|
|
414 |
<li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
|
415 |
<li class=""><a href="module_async-queue.html" title="async-queue">async-queue</a></li> |
|
|
416 |
<li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
|
417 |
<li class=""><a href="module_base.html" title="base">base</a></li> |
|
|
418 |
<li class="selected"><a href="module_cache.html" title="cache">cache</a></li> |
|
|
419 |
<li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
|
420 |
<li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
|
421 |
<li class=""><a href="module_console.html" title="console">console</a></li> |
|
|
422 |
<li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
|
423 |
<li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
|
424 |
<li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
|
425 |
<li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
|
426 |
<li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
|
427 |
<li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
|
428 |
<li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
|
429 |
<li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
|
430 |
<li class=""><a href="module_event.html" title="event">event</a></li> |
|
|
431 |
<li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
|
432 |
<li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
|
433 |
<li class=""><a href="module_history.html" title="history">history</a></li> |
|
|
434 |
<li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
|
435 |
<li class=""><a href="module_io.html" title="io">io</a></li> |
|
|
436 |
<li class=""><a href="module_json.html" title="json">json</a></li> |
|
|
437 |
<li class=""><a href="module_node.html" title="node">node</a></li> |
|
|
438 |
<li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
|
439 |
<li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
|
440 |
<li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
|
441 |
<li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
|
442 |
<li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
|
443 |
<li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
|
444 |
<li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li> |
|
|
445 |
<li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
|
446 |
<li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
|
447 |
<li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
|
448 |
<li class=""><a href="module_test.html" title="test">test</a></li> |
|
|
449 |
<li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
|
450 |
<li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
|
451 |
<li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
|
452 |
<li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
|
453 |
<li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
|
454 |
<li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
|
455 |
</ul> |
|
|
456 |
</div> |
|
|
457 |
|
|
|
458 |
<div id="classList" class="module"> |
|
|
459 |
<h4>Classes</h4> |
|
|
460 |
<ul class="content"> |
|
|
461 |
<li class=""><a href="Cache.html" title="Cache">Cache</a></li> |
|
|
462 |
</ul> |
|
|
463 |
</div> |
|
|
464 |
|
|
|
465 |
<div id="fileList" class="module"> |
|
|
466 |
<h4>Files</h4> |
|
|
467 |
<ul class="content"> |
|
|
468 |
<li class="selected"><a href="cache.js.html" title="cache.js">cache.js</a></li> |
|
|
469 |
</ul> |
|
|
470 |
</div> |
|
|
471 |
|
|
|
472 |
|
|
|
473 |
|
|
|
474 |
|
|
|
475 |
|
|
|
476 |
</div> |
|
|
477 |
</div> |
|
|
478 |
</div> |
|
|
479 |
<div id="ft"> |
|
|
480 |
<hr /> |
|
|
481 |
Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
|
482 |
</div> |
|
|
483 |
</div> |
|
|
484 |
<script type="text/javascript"> |
|
|
485 |
ALL_YUI_PROPS = [{"access": "", "host": "Cache", "name": "add", "url": "Cache.html#method_add", "type": "method"}, {"access": "", "host": "Cache", "name": "add", "url": "Cache.html#event_add", "type": "event"}, {"access": "protected", "host": "Cache", "name": "_defAddFn", "url": "Cache.html#method__defAddFn", "type": "method"}, {"access": "protected", "host": "Cache", "name": "_defFlushFn", "url": "Cache.html#method__defFlushFn", "type": "method"}, {"access": "private", "host": "Cache", "name": "destructor", "url": "Cache.html#method_destructor", "type": "method"}, {"access": "private", "host": "Cache", "name": "_entries", "url": "Cache.html#property__entries", "type": "property"}, {"access": "", "host": "Cache", "name": "entries", "url": "Cache.html#config_entries", "type": "config"}, {"access": "", "host": "Cache", "name": "entriesChange", "url": "Cache.html#event_entriesChange", "type": "event"}, {"access": "", "host": "Cache", "name": "flush", "url": "Cache.html#method_flush", "type": "method"}, {"access": "", "host": "Cache", "name": "flush", "url": "Cache.html#event_flush", "type": "event"}, {"access": "private", "host": "Cache", "name": "initializer", "url": "Cache.html#method_initializer", "type": "method"}, {"access": "protected", "host": "Cache", "name": "_isMatch", "url": "Cache.html#method__isMatch", "type": "method"}, {"access": "", "host": "Cache", "name": "max", "url": "Cache.html#config_max", "type": "config"}, {"access": "", "host": "Cache", "name": "maxChange", "url": "Cache.html#event_maxChange", "type": "event"}, {"access": "", "host": "Cache", "name": "NAME", "url": "Cache.html#property_NAME", "type": "property"}, {"access": "", "host": "Cache", "name": "NS", "url": "Cache.html#property_NS", "type": "property"}, {"access": "", "host": "Cache", "name": "request", "url": "Cache.html#event_request", "type": "event"}, {"access": "", "host": "Cache", "name": "retrieve", "url": "Cache.html#method_retrieve", "type": "method"}, {"access": "", "host": "Cache", "name": "retrieve", "url": "Cache.html#event_retrieve", "type": "event"}, {"access": "", "host": "Cache", "name": "size", "url": "Cache.html#config_size", "type": "config"}, {"access": "", "host": "Cache", "name": "sizeChange", "url": "Cache.html#event_sizeChange", "type": "event"}, {"access": "", "host": "Cache", "name": "uniqueKeys", "url": "Cache.html#config_uniqueKeys", "type": "config"}, {"access": "", "host": "Cache", "name": "uniqueKeysChange", "url": "Cache.html#event_uniqueKeysChange", "type": "event"}]; |
|
|
486 |
</script> |
|
|
487 |
</body> |
|
|
488 |
</html> |