Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / 8039d4c217cd0324e191f3c7887803246070a194 / . / user_guide / helpers / cookie_helper.html
blob: 7e589f4b0b5037c01477fa191eaac308b4c089f4 [file] [log] [blame]
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Derek Allardafd99ac2008-01-19 19:59:14 +0000[diff] [blame]2<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]3<head>
4
Derek Allard8039d4c2008-05-31 02:47:56 +0000[diff] [blame^]5<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
Derek Jonesfd93d222008-05-06 15:18:50 +0000[diff] [blame]6<title>Cookie Helper : CodeIgniter User Guide</title>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]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
admin17a890d2006-09-27 20:42:42 +0000[diff] [blame]11<script type="text/javascript" src="../nav/nav.js"></script>
admin2296fc32006-09-27 21:07:02 +0000[diff] [blame]12<script type="text/javascript" src="../nav/prototype.lite.js"></script>
admin17a890d2006-09-27 20:42:42 +0000[diff] [blame]13<script type="text/javascript" src="../nav/moo.fx.js"></script>
Derek Allardb3412372007-10-25 12:15:16 +0000[diff] [blame]14<script type="text/javascript" src="../nav/user_guide_menu.js"></script>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]15
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]16<meta http-equiv='expires' content='-1' />
17<meta http-equiv= 'pragma' content='no-cache' />
18<meta name='robots' content='all' />
Derek Allard3d879d52008-01-18 19:41:32 +0000[diff] [blame]19<meta name='author' content='ExpressionEngine Dev Team' />
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]20<meta name='description' content='CodeIgniter User Guide' />
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]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.jpg" width="153" height="44" 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 Jones6b7b11f2008-05-06 16:07:27 +0000[diff] [blame]31<td><h1>CodeIgniter User Guide Version 1.6.2</h1></td>
adminc0d5d522006-10-30 19:40:35 +0000[diff] [blame]32<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]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">
Derek Jones7a9193a2008-01-21 18:39:20 +0000[diff] [blame]43<a href="http://codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]44<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
45Cookie Helper
46</td>
Derek Allardbc030912007-06-24 18:25:29 +0000[diff] [blame]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>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]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
Derek Allard140786f2008-04-01 16:06:08 +0000[diff] [blame]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:
Derek Allard72c459f2008-01-31 19:58:31 +0000[diff] [blame]74Array Method, and Discrete Parameters:</p>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]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&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'name'&nbsp;&nbsp;&nbsp;=> 'The Cookie Name',<br />
82&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'value'&nbsp;&nbsp;=> 'The Value',<br />
83&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'expire' => '86500',<br />
84&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'domain' => '.some-domain.com',<br />
85&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'path'&nbsp;&nbsp;&nbsp;=> '/',<br />
86&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'prefix' => 'myprefix_',<br />
87&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;);<br />
88<br />
89set_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
admine334c472006-10-21 19:44:22 +0000[diff] [blame]97number of seconds from <em>now</em> that you wish the cookie to be valid. If the expiration is set to
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]98zero 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
Derek Allard72c459f2008-01-31 19:58:31 +0000[diff] [blame]104<h4>Discrete Parameters</h4>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]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
admin885b0342006-09-21 05:36:15 +0000[diff] [blame]110<h2>get_cookie()</h2>
111
Derek Allard2b2b7cc2008-03-23 13:05:16 +0000[diff] [blame]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>
admin885b0342006-09-21 05:36:15 +0000[diff] [blame]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
Derek Allard2b2b7cc2008-03-23 13:05:16 +0000[diff] [blame]120<p><code>get_cookie('some_cookie', TRUE);</code></p>
admin885b0342006-09-21 05:36:15 +0000[diff] [blame]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
admine334c472006-10-21 19:44:22 +0000[diff] [blame]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
Derek Allard72c459f2008-01-31 19:58:31 +0000[diff] [blame]128of values in the first parameter or you can set discrete parameters.</p>
admin885b0342006-09-21 05:36:15 +0000[diff] [blame]129
130<code>delete_cookie($name, $domain, $path, $prefix)</code>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]131
132
133</div>
134<!-- END CONTENT -->
135
136
137<div id="footer">
138<p>
Derek Allarde4db2772008-05-07 03:23:27 +0000[diff] [blame]139Previous Topic:&nbsp;&nbsp;<a href="compatibility_helper.html">Compatibility Helper</a>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]140&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
141<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
142<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
Derek Allarde4db2772008-05-07 03:23:27 +0000[diff] [blame]143Next Topic:&nbsp;&nbsp;<a href="date_helper.html">Date Helper</a></p>
Derek Jones07870432008-02-13 03:49:26 +0000[diff] [blame]144<p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006-2008 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]145</div>
146
147</body>
148</html>