-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathusage.html
More file actions
326 lines (309 loc) · 8.35 KB
/
usage.html
File metadata and controls
326 lines (309 loc) · 8.35 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Cache Class - Usage - Fuel Documentation</title>
<link href="../../assets/css/main.css" media="screen" rel="stylesheet" />
<script type="text/javascript" src="../../assets/js/jquery-1.4.4.min.js"></script>
<script type="text/javascript" src="../../assets/js/nav.js"></script>
<script type="text/javascript" src="../../assets/js/highlight.pack.js"></script>
<script type="text/javascript">
$(function() {
show_nav('classes', '../../');
});
hljs.tabReplace = ' ';
hljs.initHighlightingOnLoad();
</script>
</head>
<body>
<header>
<h1>Fuel Documentation</h1>
</header>
<div id="main-nav"></div>
<section id="content">
<h2>Cache Class</h2>
<p>The cache class allows you to cache the result of a resource heavy operation.</p>
<section>
<h2>Usage</h2>
<p>Using caches can be done in 2 ways: through static usage of the Cache class and through cache objects
returned by the Cache::factory(). This section covers static usage which will always work with the same
driver as specified in the <a href="config.html">configuration</a>.</p>
<p>Using cache objects and Cache::factory() is explained in the <a href="advanced.html">advanced</a>
section.</p>
<article>
<h4 id="method_set">set($identifier, $contents = null, $expiration = false, $dependencies = array())</h4>
<p>Writes a cache.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$identifier</kbd></th>
<td><i>string</i></td>
<td>Name of the cache</td>
</tr>
<tr>
<th><kbd>$contents</kbd></th>
<td><i>mixed</i></td>
<td>Contents to be cached</td>
</tr>
<tr>
<th><kbd>$expiration</kbd></th>
<td><i>int</i></td>
<td>Amount of seconds until the cache expires. null will make it never expire, false
makes it use the default expiration set in config.</td>
</tr>
<tr>
<th><kbd>$dependencies</kbd></th>
<td><i>array</i></td>
<td>Array of identifiers this cache depends on, this cache expires if one of those
is newer or doesn't exist anymore.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>void</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>// Cache 'String to be cached' for 3 hours with identifier "test"
Cache::set('test', 'String to be cached.', 3600 * 3);</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_get">get($identifier, $use_expiration = true)</h4>
<p>Retrieves a cache.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$identifier</kbd></th>
<td><i>string</i></td>
<td>Name of the cache</td>
</tr>
<tr>
<th><kbd>$use_expiration</kbd></th>
<td><i>true</i></td>
<td>Disable cache expiration for this fetching by setting this to false</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>mixed - cache contents</td>
</tr>
<tr>
<th>Throws</th>
<td>CacheNotFoundException when Cache doesn't exist or CacheExpiredException when it has expired</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>// try to retrieve the cache and save to $content var
try
{
$content = Cache::get('test');
}
catch (\CacheNotFoundException $e)
{
/*
Catching the CacheNotFoundException exception will catch
both CacheNotFoundException and CacheExpiredException.
Use this when cathing the exception.
*/
}
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_delete">delete($identifier)</h4>
<p>Deletes a cache.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$identifier</kbd></th>
<td><i>string</i></td>
<td>Name of the cache</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>void</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>Cache::delete('test');</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_delete_all">delete_all($section = null, $driver = null)</h4>
<p>Flushes the whole cache for a specific storage driver or just a subsection of it.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$section</kbd></th>
<td><i>string</i></td>
<td>Name of a section or directory of the cache, null to delete everything</td>
</tr>
<tr>
<th><kbd>$driver</kbd></th>
<td><i>string</i></td>
<td>Name of the driver to use, null to use the default driver.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>void</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>// Delete the whole cache for the default driver
Cache::delete_all();
// Delete the subdirectory "test" of file
Cache::delete_all('test', 'file');</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_call">call($identifier, $callback, $args = array(), $expiration = null, $dependencies = array())</h4>
<p>Cache the result of any callable function or method.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$identifier</kbd></th>
<td><i>string</i></td>
<td>Name of the cache</td>
</tr>
<tr>
<th><kbd>$callback</kbd></th>
<td><i>mixed</i></td>
<td>Any valid PHP callback</td>
</tr>
<tr>
<th><kbd>$args</kbd></th>
<td><i>array</i></td>
<td>Any arguments for the callback</td>
</tr>
<tr>
<th><kbd>$expiration</kbd></th>
<td><i>int</i></td>
<td>Amount of seconds until the cache expires. null will make it never expire, false
makes it use the default expiration set in config.</td>
</tr>
<tr>
<th><kbd>$dependencies</kbd></th>
<td><i>array</i></td>
<td>Array of identifiers this cache depends on, this cache expires if one of those
is newer or doesn't exist anymore.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>void</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>// Cache the result of a model find
Cache::call('article_something', array('Model_Article', 'find'), array("all", array( 'where' => array('something' => $something) ));
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
</section>
</section>
<section id="footer">
<p>
<a href="http://fuelphp.com">Fuel</a> is released under the MIT license.<br />
© 2010 - 2011 Fuel Development Team
</p>
</section>
</body>
</html>