| Derek Allard | 2067d1a | 2008-11-13 22:59:24 +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 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>Cookie Helper : 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> |
| Derek Jones | 733310d | 2009-02-11 01:13:43 +0000 | [diff] [blame] | 31 | <td><h1>CodeIgniter User Guide Version 1.7.1</h1></td> |
| Derek Allard | 2067d1a | 2008-11-13 22:59:24 +0000 | [diff] [blame] | 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> › |
| 44 | <a href="../index.html">User Guide Home</a> › |
| 45 | Cookie Helper |
| 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 <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> |
| 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>Cookie Helper</h1> |
| 60 | |
| 61 | <p>The Cookie Helper file contains functions that assist in working with cookies.</p> |
| 62 | |
| 63 | |
| 64 | <h2>Loading this Helper</h2> |
| 65 | |
| 66 | <p>This helper is loaded using the following code:</p> |
| 67 | <code>$this->load->helper('cookie');</code> |
| 68 | |
| 69 | <p>The following functions are available:</p> |
| 70 | |
| 71 | <h2>set_cookie()</h2> |
| 72 | |
| 73 | <p>Sets a cookie containing the values you specify. There are two ways to pass information to this function so that a cookie can be set: |
| 74 | Array Method, and Discrete Parameters:</p> |
| 75 | |
| 76 | <h4>Array Method</h4> |
| 77 | |
| 78 | <p>Using this method, an associative array is passed to the first parameter:</p> |
| 79 | |
| 80 | <code>$cookie = array(<br /> |
| 81 | 'name' => 'The Cookie Name',<br /> |
| 82 | 'value' => 'The Value',<br /> |
| 83 | 'expire' => '86500',<br /> |
| 84 | 'domain' => '.some-domain.com',<br /> |
| 85 | 'path' => '/',<br /> |
| 86 | 'prefix' => 'myprefix_',<br /> |
| 87 | );<br /> |
| 88 | <br /> |
| 89 | set_cookie($cookie); |
| 90 | </code> |
| 91 | |
| 92 | <p><strong>Notes:</strong></p> |
| 93 | |
| 94 | <p>Only the name and value are required.</p> |
| 95 | |
| 96 | <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 |
| 97 | number of seconds from <em>now</em> that you wish the cookie to be valid. If the expiration is set to |
| 98 | zero the cookie will only last as long as the browser is open.</p> |
| 99 | <p>To delete a cookie set it with the expiration blank.</p> |
| 100 | <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> |
| 101 | <p>The path is usually not needed since the function sets a root path.</p> |
| 102 | <p>The prefix is only needed if you need to avoid name collisions with other identically named cookies for your server.</p> |
| 103 | |
| 104 | <h4>Discrete Parameters</h4> |
| 105 | |
| 106 | <p>If you prefer, you can set the cookie by passing data using individual parameters:</p> |
| 107 | |
| 108 | <code>set_cookie($name, $value, $expire, $domain, $path, $prefix);</code> |
| 109 | |
| 110 | <h2>get_cookie()</h2> |
| 111 | |
| 112 | <p>Lets you fetch a cookie. The first parameter will contain the name of the cookie you are looking for (including any prefixes):</p> |
| 113 | |
| 114 | <code>get_cookie('some_cookie');</code> |
| 115 | |
| 116 | <p>The function returns FALSE (boolean) if the item you are attempting to retrieve does not exist.</p> |
| 117 | |
| 118 | <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> |
| 119 | |
| 120 | <p><code>get_cookie('some_cookie', TRUE);</code></p> |
| 121 | <h2>delete_cookie()</h2> |
| 122 | |
| 123 | <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> |
| 124 | |
| 125 | <code>delete_cookie("name");</code> |
| 126 | |
| 127 | <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 |
| 128 | of values in the first parameter or you can set discrete parameters.</p> |
| 129 | |
| 130 | <code>delete_cookie($name, $domain, $path, $prefix)</code> |
| 131 | |
| 132 | |
| 133 | </div> |
| 134 | <!-- END CONTENT --> |
| 135 | |
| 136 | |
| 137 | <div id="footer"> |
| 138 | <p> |
| 139 | Previous Topic: <a href="compatibility_helper.html">Compatibility Helper</a> |
| 140 | · |
| 141 | <a href="#top">Top of Page</a> · |
| 142 | <a href="../index.html">User Guide Home</a> · |
| 143 | Next Topic: <a href="date_helper.html">Date Helper</a></p> |
| 144 | <p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006-2008 · <a href="http://ellislab.com/">Ellislab, Inc.</a></p> |
| 145 | </div> |
| 146 | |
| 147 | </body> |
| admin | b0dd10f | 2006-08-25 17:25:49 +0000 | [diff] [blame] | 148 | </html> |