/lenasys/trunk

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/lenasys/trunk

« back to all changes in this revision

Viewing changes to codeigniter/user_guide/libraries/caching.html

  • Committer: Gustav Hatvigsson
  • Date: 2013-05-30 11:59:17 UTC
  • mfrom: (85.1.27 lenasys)
  • Revision ID: gustav.hartvigsson@gmail.com-20130530115917-nq06e5l455nfqok5
Merged Ohlssons changes:
added function to get ssn and name for the registrationspages in the user model.
added the registrationpage for students.
edited the registration page for instructors
edited the css for both the registrationpages

Show diffs side-by-side

added added

removed removed

Lines of Context:
codeigniter/user_guide/libraries/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>Caching Driver : 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.1.3</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
 
<a href="../general/drivers.html">Drivers</a> &nbsp;&#8250;&nbsp;
46
 
Caching Driver
47
 
</td>
48
 
<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>
49
 
</tr>
50
 
</table>
51
 
<!-- END BREADCRUMB -->
52
 
 
53
 
<br clear="all" />
54
 
 
55
 
 
56
 
<!-- START CONTENT -->
57
 
<div id="content">
58
 
 
59
 
<h1>Caching Driver</h1>
60
 
 
61
 
<p>CodeIgniter features wrappers around some of the most popular forms of fast and dynamic caching.  All but file-based caching require specific server requirements, and a Fatal Exception will be thrown if server requirements are not met.</p>
62
 
 
63
 
<h2>Table of Contents</h2>
64
 
<ul>
65
 
        <li><a href="#example_usage" title="Example Usage">Example Usage</a></li>
66
 
        <li><a href="#function_reference" title="Function Reference">Function Reference</a></li>
67
 
</ul>
68
 
 
69
 
<h3>Available Drivers</h3>
70
 
<ul>
71
 
        <li><a href="#apc" title="APC Cache">Alternative PHP Cache (APC) Caching</a></li>
72
 
        <li><a href="#file" title="File Caching">File-based Caching</a></li>
73
 
        <li><a href="#memcached" title="Memcached">Memcached Caching</a></li>
74
 
        <li><a href="#dummy" title="Dummy Caching">Dummy Cache</a></li>
75
 
</ul>
76
 
 
77
 
<h2 id="example_usage">Example Usage</h2>
78
 
 
79
 
<p>The following example will load the cache driver, specify <a href="#apc" title="APC">APC</a> as the driver to use, and fall back to file-based caching if APC is not available in the hosting environment.</p>
80
 
 
81
 
<code>
82
 
$this->load->driver('cache', array('adapter' => 'apc', 'backup' => 'file'));<br />
83
 
<br />
84
 
if ( ! $foo = $this->cache->get('foo'))<br />
85
 
{<br />
86
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;echo 'Saving to the cache!&lt;br />';<br />
87
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;$foo = 'foobarbaz!';<br />
88
 
<br />
89
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;// Save into the cache for 5 minutes<br />
90
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;$this->cache->save('foo', $foo, 300);<br />
91
 
}<br />
92
 
<br />
93
 
echo $foo;
94
 
</code>
95
 
 
96
 
<h1 id="function_reference">Function Reference</h1>
97
 
 
98
 
<h2>is_supported(<var>driver</var>['string'])</h2>
99
 
 
100
 
<p>This function is automatically called when accessing drivers via <samp>$this->cache->get()</samp>.  However, if the individual drivers are used, make sure to call this function to ensure the driver is supported in the hosting environment.</p>
101
 
 
102
 
<code>
103
 
if ($this->cache->apc->is_supported())<br />
104
 
{<br />
105
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if ($data = $this->cache->apc->get('my_cache'))<br />
106
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br />
107
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;// do things.<br />
108
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<br />
109
 
}
110
 
</code>
111
 
 
112
 
<h2>get(<var>id</var>['string'])</h2>
113
 
 
114
 
<p>This function will attempt to fetch an item from the cache store.  If the item does not exist, the function will return <samp>FALSE</samp>.</p>
115
 
<code>$foo = $this->cache->get('my_cached_item');</code>
116
 
 
117
 
<h2>save(<var>id</var>['string'], <var>data</var>['mixed'], <var>ttl</var>['int'])</h2>
118
 
 
119
 
<p>This function will save an item to the cache store.  If saving fails, the function will return <samp>FALSE</samp>.</p>
120
 
<p>The optional third parameter (Time To Live) defaults to 60 seconds.</p>
121
 
<code>$this->cache->save('cache_item_id', 'data_to_cache');</code>
122
 
 
123
 
<h2>delete(<var>id</var>['string'])</h2>
124
 
 
125
 
<p>This function will delete a specific item from the cache store.  If item deletion fails, the function will return <samp>FALSE</samp>.</p>
126
 
<code>$this->cache->delete('cache_item_id');</code>
127
 
 
128
 
<h2>clean()</h2>
129
 
 
130
 
<p>This function will 'clean' the entire cache.  If the deletion of the cache files fails, the function will return <samp>FALSE</samp>.</p>
131
 
 
132
 
<code>$this->cache->clean();</code>
133
 
 
134
 
<h2>cache_info()</h2>
135
 
 
136
 
<p>This function will return information on the entire cache.</p>
137
 
 
138
 
<code>var_dump($this->cache->cache_info());</code>
139
 
 
140
 
<h2>get_metadata(<var>id</var>['string'])</h2>
141
 
 
142
 
<p>This function will return detailed information on a specific item in the cache.</p>
143
 
 
144
 
<code>var_dump($this->cache->get_metadata('my_cached_item'));</code>
145
 
 
146
 
<h1>Drivers</h1>
147
 
 
148
 
<h2 id="apc">Alternative PHP Cache (APC) Caching</h2>
149
 
 
150
 
<p>All of the functions listed above can be accessed without passing a specific adapter to the driver loader as follows:</p>
151
 
<code>$this->load->driver('cache');<br />
152
 
        $this->cache->apc->save('foo', 'bar', 10);</code>
153
 
<p>For more information on APC, please see <a href="http://php.net/apc">http://php.net/apc</a></p>
154
 
 
155
 
<h2 id="file">File-based Caching</h2>
156
 
 
157
 
<p>Unlike caching from the Output Class, the driver file-based caching allows for pieces of view files to be cached.  Use this with care, and make sure to benchmark your application, as a point can come where disk I/O will negate positive gains by caching.</p>
158
 
 
159
 
<p>All of the functions listed above can be accessed without passing a specific adapter to the driver loader as follows:</p>
160
 
<code>$this->load->driver('cache');<br />
161
 
        $this->cache->file->save('foo', 'bar', 10);</code>
162
 
 
163
 
<h2 id="memcached">Memcached Caching</h2>
164
 
 
165
 
<p>Multiple Memcached servers can be specified in the memcached.php configuration file, located in the <samp>application/config/</samp> directory.
166
 
 
167
 
<p>All of the functions listed above can be accessed without passing a specific adapter to the driver loader as follows:</p>
168
 
<code>$this->load->driver('cache');<br />
169
 
        $this->cache->memcached->save('foo', 'bar', 10);</code>
170
 
 
171
 
<p>For more information on Memcached, please see <a href="http://php.net/memcached">http://php.net/memcached</a></p>
172
 
 
173
 
<h2 id="dummy">Dummy Cache</h2>
174
 
 
175
 
<p>This is a caching backend that will always 'miss.'  It stores no data, but lets you keep your caching code in place in environments that don't support your chosen cache.</p>
176
 
 
177
 
</div>
178
 
<!-- END CONTENT -->
179
 
 
180
 
 
181
 
<div id="footer">
182
 
<p>
183
 
Previous Topic:&nbsp;&nbsp;<a href="zip.html">Zip Encoding Class</a>
184
 
&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
185
 
<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
186
 
<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
187
 
Next Topic:&nbsp;&nbsp;<a href="../database/index.html">Database Class</a>
188
 
</p>
189
 
<p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006 - 2012 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">EllisLab, Inc.</a></p>
190
 
</div>
191
 
 
192
 
</body>
193
 
</html>
 
 
b'\\ No newline at end of file'