user_guide/general/caching.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   3 <head>
   4
   5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   6 <title>Web Page Caching : CodeIgniter User Guide</title>
   7
   8 <style type='text/css' media='all'>@import url('../userguide.css');</style>
   9 <link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
  10
  11 <script type="text/javascript" src="../nav/nav.js"></script>
  12 <script type="text/javascript" src="../nav/prototype.lite.js"></script>
  13 <script type="text/javascript" src="../nav/moo.fx.js"></script>
  14 <script type="text/javascript" src="../nav/user_guide_menu.js"></script>
  15
  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='ExpressionEngine Dev Team' />
  20 <meta name='description' content='CodeIgniter User Guide' />
  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_darker.jpg" width="154" height="43" 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>
  31 <td><h1>CodeIgniter User Guide Version 2.0.2</h1></td>
  32 <td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
  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">
  43 <a href="http://codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
  44 <a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
  45 Page Caching
  46 </td>
  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>
  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
  61 <p>CodeIgniter lets you cache your pages in order to achieve maximum performance.</p>
  62
  63 <p>Although CodeIgniter is quite fast, the amount of dynamic information you display in your pages will correlate directly to the
  64 server resources, memory, and processing cycles utilized, which affect your page load speeds.
  65 By caching your pages, since they are saved in their fully rendered state, you can achieve performance that nears that of static web pages.</p>
  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.
  71 When a page is loaded for the first time, the cache file will be written to your <dfn>application/cache</dfn> folder.  On subsequent page loads the cache file will be retrieved
  72 and 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
  85 most logical to you. Once the tag is in place, your pages will begin being cached.</p>
  86
  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>
  88 <p class="important"><strong>Note:</strong> Before the cache files can be written you must set the file permissions on your
  89 <dfn>application/cache</dfn> folder such that it is writable.</p>
  90
  91 <h2>Deleting Caches</h2>
  92
  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:
  94 Removing the tag will not delete the cache immediately.  It will have to expire normally.  If you need to remove it earlier you
  95 will 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>
 105 Previous 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;
 109 Next Topic:&nbsp;&nbsp;<a href="profiling.html">Profiling Your Application</a>
 110 </p>
 111 <p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006 - 2011 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">EllisLab, Inc.</a></p>
 112 </div>
 113
 114 </body>
 115 </html>