From 8ede1a2ecbb62577afd32996956c5feaf7ddf9b6 Mon Sep 17 00:00:00 2001 From: Derek Jones Date: Wed, 5 Oct 2011 13:34:52 -0500 Subject: replacing the old HTML user guide with a Sphinx-managed user guide --- user_guide/general/caching.html | 115 ---------------------------------------- 1 file changed, 115 deletions(-) delete mode 100644 user_guide/general/caching.html (limited to 'user_guide/general/caching.html') diff --git a/user_guide/general/caching.html b/user_guide/general/caching.html deleted file mode 100644 index b40e770a9..000000000 --- a/user_guide/general/caching.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -Web Page Caching : CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- - -

Web Page Caching

- -

CodeIgniter lets you cache your pages in order to achieve maximum performance.

- -

Although CodeIgniter is quite fast, the amount of dynamic information you display in your pages will correlate directly to the -server resources, memory, and processing cycles utilized, which affect your page load speeds. -By caching your pages, since they are saved in their fully rendered state, you can achieve performance that nears that of static web pages.

- - -

How Does Caching Work?

- -

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. -When a page is loaded for the first time, the cache file will be written to your application/cache folder. On subsequent page loads the cache file will be retrieved -and sent to the requesting user's browser. If it has expired, it will be deleted and refreshed before being sent to the browser.

- -

Note: The Benchmark tag is not cached so you can still view your page load speed when caching is enabled.

- -

Enabling Caching

- -

To enable caching, put the following tag in any of your controller functions:

- -$this->output->cache(n); - -

Where n is the number of minutes you wish the page to remain cached between refreshes.

- -

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 -most logical to you. Once the tag is in place, your pages will begin being cached.

- -

Warning: Because of the way CodeIgniter stores content for output, caching will only work if you are generating display for your controller with a view.

-

Note: Before the cache files can be written you must set the file permissions on your -application/cache folder such that it is writable.

- -

Deleting Caches

- -

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: -Removing the tag will not delete the cache immediately. It will have to expire normally. If you need to remove it earlier you -will need to manually delete it from your cache folder.

- - - -
- - - - - - - \ No newline at end of file -- cgit v1.2.3-24-g4f1b