| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | |
| <html> | |
| <head> | |
| <title>Code Igniter User Guide</title> | |
| <style type='text/css' media='all'>@import url('../userguide.css');</style> | |
| <link rel='stylesheet' type='text/css' media='all' href='../userguide.css' /> | |
| <script type="text/javascript" src="../nav/nav.js"></script> | |
| <script type="text/javascript" src="../nav/prototype.lite.js"></script> | |
| <script type="text/javascript" src="../nav/moo.fx.js"></script> | |
| <script type="text/javascript"> | |
| window.onload = function() { | |
| myHeight = new fx.Height('nav', {duration: 400}); | |
| myHeight.hide(); | |
| } | |
| </script> | |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | |
| <meta http-equiv='expires' content='-1' /> | |
| <meta http-equiv= 'pragma' content='no-cache' /> | |
| <meta name='robots' content='all' /> | |
| <meta name='author' content='Rick Ellis' /> | |
| <meta name='description' content='Code Igniter User Guide' /> | |
| </head> | |
| <body> | |
| <!-- START NAVIGATION --> | |
| <div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div> | |
| <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> | |
| <div id="masthead"> | |
| <table cellpadding="0" cellspacing="0" border="0" style="width:100%"> | |
| <tr> | |
| <td><h1>Code Igniter User Guide Version 1.5.0b3</h1></td> | |
| <td id="breadcrumb_right"><a href="../toc.html">Linear Table of Contents</a></td> | |
| </tr> | |
| </table> | |
| </div> | |
| <!-- END NAVIGATION --> | |
| <!-- START BREADCRUMB --> | |
| <table cellpadding="0" cellspacing="0" border="0" style="width:100%"> | |
| <tr> | |
| <td id="breadcrumb"> | |
| <a href="http://www.codeigniter.com/">Code Igniter Home</a> › | |
| <a href="../index.html">User Guide Home</a> › | |
| Cookie Helper | |
| </td> | |
| <td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="www.codeigniter.com/user_guide/" />Search User Guide <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" /> <input type="submit" class="submit" name="sa" value="Go" /></form></td> | |
| </tr> | |
| </table> | |
| <!-- END BREADCRUMB --> | |
| <br clear="all" /> | |
| <!-- START CONTENT --> | |
| <div id="content"> | |
| <h1>Cookie Helper</h1> | |
| <p>The Cookie Helper file contains functions that assist in working with cookies.</p> | |
| <h2>Loading this Helper</h2> | |
| <p>This helper is loaded using the following code:</p> | |
| <code>$this->load->helper('cookie');</code> | |
| <p>The following functions are available:</p> | |
| <h2>set_cookie()</h2> | |
| <p>Sets a cookie containing the values you specify. There are two ways to pass information this function so that a cookie can be set: | |
| Array Method, and Discreet Parameters:</p> | |
| <h4>Array Method</h4> | |
| <p>Using this method, an associative array is passed to the first parameter:</p> | |
| <code>$cookie = array(<br /> | |
| 'name' => 'The Cookie Name',<br /> | |
| 'value' => 'The Value',<br /> | |
| 'expire' => '86500',<br /> | |
| 'domain' => '.some-domain.com',<br /> | |
| 'path' => '/',<br /> | |
| 'prefix' => 'myprefix_',<br /> | |
| );<br /> | |
| <br /> | |
| set_cookie($cookie); | |
| </code> | |
| <p><strong>Notes:</strong></p> | |
| <p>Only the name and value are required.</p> | |
| <p>The expiration is set in <strong>seconds</strong>, which will be added to the current time. Do not include the time, but rather only the | |
| number of seconds from <em>now</em> that you wish the cookie to be valid. If the expiration is set to | |
| zero the cookie will only last as long as the browser is open.</p> | |
| <p>To delete a cookie set it with the expiration blank.</p> | |
| <p>For site-wide cookies regardless of how your site is requested, add your URL to the <strong>domain</strong> starting with a period, like this: .your-domain.com</p> | |
| <p>The path is usually not needed since the function sets a root path.</p> | |
| <p>The prefix is only needed if you need to avoid name collisions with other identically named cookies for your server.</p> | |
| <h4>Discreet Parameters</h4> | |
| <p>If you prefer, you can set the cookie by passing data using individual parameters:</p> | |
| <code>set_cookie($name, $value, $expire, $domain, $path, $prefix);</code> | |
| <h2>get_cookie()</h2> | |
| <p>Lets you fetch a cookie. The first parameter will contain the name of the cookie you are looking for:</p> | |
| <code>get_cookie('some_cookie');</code> | |
| <p>The function returns FALSE (boolean) if the item you are attempting to retrieve does not exist.</p> | |
| <p>The second optional parameter lets you run the data through the XSS filter. It's enabled by setting the second parameter to boolean TRUE;</p> | |
| <code>get_cookie('some_cookie', TRUE);</code> | |
| <h2>delete_cookie()</h2> | |
| <p>Lets you delete a cookie. Unless you've set a custom path or other values, only the name of the cookie is needed:</p> | |
| <code>delete_cookie("name");</code> | |
| <p>This function is otherwise identical to <dfn>set_cookie()</dfn>, except that it does not have the value and expiration parameters. You can submit an array | |
| of values in the first parameter or you can set discreet parameters.</p> | |
| <code>delete_cookie($name, $domain, $path, $prefix)</code> | |
| </div> | |
| <!-- END CONTENT --> | |
| <div id="footer"> | |
| <p> | |
| Previous Topic: <a href="array_helper.html">Array Helper</a> | |
| · | |
| <a href="#top">Top of Page</a> · | |
| <a href="../index.html">User Guide Home</a> · | |
| Next Topic: <a href="date_helper.html">Date Helper</a> | |
| <p> | |
| <p><a href="http://www.codeigniter.com">Code Igniter</a> · Copyright © 2006 · <a href="http://www.pmachine.com">pMachine, Inc.</a></p> | |
| </div> | |
| </body> | |
| </html> |