Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / 235fa2a469a93adca667f36d4b8526688ac6e558 / . / user_guide / general / caching.html
blob: c9a38a965f7da71e0f2afaa8ce8f577b78b1a120 [file] [log] [blame]
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html>
3<head>
4
Derek Allard404e35d2007-08-07 01:00:45 +0000[diff] [blame]5<title>CodeIgniter User Guide : Web Page Caching</title>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]6
7<style type='text/css' media='all'>@import url('../userguide.css');</style>
8<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
9
admin17a890d2006-09-27 20:42:42 +0000[diff] [blame]10<script type="text/javascript" src="../nav/nav.js"></script>
admin2296fc32006-09-27 21:07:02 +0000[diff] [blame]11<script type="text/javascript" src="../nav/prototype.lite.js"></script>
admin17a890d2006-09-27 20:42:42 +0000[diff] [blame]12<script type="text/javascript" src="../nav/moo.fx.js"></script>
Derek Allardb3412372007-10-25 12:15:16 +0000[diff] [blame]13<script type="text/javascript" src="../nav/user_guide_menu.js"></script>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]14
15<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
16<meta http-equiv='expires' content='-1' />
17<meta http-equiv= 'pragma' content='no-cache' />
18<meta name='robots' content='all' />
19<meta name='author' content='Rick Ellis' />
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]20<meta name='description' content='CodeIgniter User Guide' />
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]21
22</head>
23<body>
24
25<!-- START NAVIGATION -->
26<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div>
27<div id="nav2"><a name="top"></a><a href="javascript:void(0);" onclick="myHeight.toggle();"><img src="../images/nav_toggle.jpg" width="153" height="44" border="0" title="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div>
28<div id="masthead">
29<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
30<tr>
Derek Allard60ca9b72007-07-12 19:53:27 +0000[diff] [blame]31<td><h1>CodeIgniter User Guide Version 1.5.4</h1></td>
adminc0d5d522006-10-30 19:40:35 +0000[diff] [blame]32<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]33</tr>
34</table>
35</div>
36<!-- END NAVIGATION -->
37
38
39<!-- START BREADCRUMB -->
40<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
41<tr>
42<td id="breadcrumb">
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]43<a href="http://www.codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]44<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
45Page Caching
46</td>
Derek Allardbc030912007-06-24 18:25:29 +0000[diff] [blame]47<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="codeigniter.com/user_guide/" />Search User Guide&nbsp; <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" />&nbsp;<input type="submit" class="submit" name="sa" value="Go" /></form></td>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]48</tr>
49</table>
50<!-- END BREADCRUMB -->
51
52<br clear="all" />
53
54
55<!-- START CONTENT -->
56<div id="content">
57
58
59<h1>Web Page Caching</h1>
60
Derek Allardc6441282007-07-04 23:54:32 +0000[diff] [blame]61<p>CodeIgniter lets you cache your pages in order to achieve maximum performance.</p>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]62
Derek Allardc6441282007-07-04 23:54:32 +0000[diff] [blame]63<p>Although CodeIgniter is quite fast, the amount of dynamic information you display in your pages will correlate directly to the
admine334c472006-10-21 19:44:22 +0000[diff] [blame]64server resources, memory, and processing cycles utilized, which affect your page load speeds.
Derek Allardc6441282007-07-04 23:54:32 +0000[diff] [blame]65By caching your pages, since they are saved in their fully rendered state, you can achieve performance that nears that of static web pages.</p>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]66
67
68<h2>How Does Caching Work?</h2>
69
70<p>Caching can be enabled on a per-page basis, and you can set the length of time that a page should remain cached before being refreshed.
71When a page is loaded for the first time, the cache file will be written to your <dfn>system/cache</dfn> folder. On subsequent page loads the cache file will be retrieved
72and sent to the requesting user's browser. If it has expired, it will be deleted and refreshed before being sent to the browser.</p>
73
74<p>Note: The Benchmark tag is not cached so you can still view your page load speed when caching is enabled.</p>
75
76<h2>Enabling Caching</h2>
77
78<p>To enable caching, put the following tag in any of your controller functions:</p>
79
80<code>$this->output->cache(<var>n</var>);</code>
81
82<p>Where <var>n</var> is the number of <strong>minutes</strong> you wish the page to remain cached between refreshes.</p>
83
84<p>The above tag can go anywhere within a function. It is not affected by the order that it appears, so place it wherever it seems
85most logical to you. Once the tag is in place, your pages will begin being cached.</p>
86
Derek Allard69693932007-10-02 20:04:33 +0000[diff] [blame]87<p class="important"><strong>Warning:</strong> Because of the way CodeIgniter stores content for output, caching will only work if you are generating display for your controller with a <a href="./views.html">view</a>.</p>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]88<p class="important"><strong>Note:</strong> Before the cache files can be written you must set the file permissions on your
89<dfn>system/cache</dfn> folder such that it is writable (666 is usually appropriate).</p>
90
91<h2>Deleting Caches</h2>
92
Rick Ellis325197e2006-11-20 17:29:05 +0000[diff] [blame]93<p>If you no longer wish to cache a file you can remove the caching tag and it will no longer be refreshed when it expires. Note:
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]94Removing the tag will not delete the cache immediately. It will have to expire normally. If you need to remove it earlier you
95will need to manually delete it from your cache folder.</p>
96
97
98
99</div>
100<!-- END CONTENT -->
101
102
103<div id="footer">
104<p>
105Previous Topic:&nbsp;&nbsp;<a href="errors.html">Error Handling</a>
106&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
107<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
108<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
Derek Allard41859612007-04-01 16:38:46 +0000[diff] [blame]109Next Topic:&nbsp;&nbsp;<a href="profiling.html">Profiling Your Application</a>
Derek Allardc6441282007-07-04 23:54:32 +0000[diff] [blame]110</p>
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]111<p><a href="http://www.codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2007 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]112</div>
113
114</body>
115</html>