Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / 49e31258bc85245b087d6b7b5ac02edb1b680bc6 / . / user_guide / helpers / cookie_helper.html
blob: 889c3346e808d50d3ebe6f1027c99146f5ecf697 [file] [log] [blame]
Derek Allard2067d1a2008-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>
Pascal Kriete1f622292011-04-07 12:06:51 -0400[diff] [blame]31<td><h1>CodeIgniter User Guide Version 2.0.2</h1></td>
Derek Allard2067d1a2008-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> &nbsp;&#8250;&nbsp;
44<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
45Cookie 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&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>
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
Razican114ab092011-04-25 17:26:45 +0200[diff] [blame]73<p>This helper function gives you view file friendly syntax to set browser cookies. Refer to the <a href="../libraries/input.html">Input class</a> for a description of use, as this function is an alias to $this->input->set_cookie().</p>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]74
75<h2>get_cookie()</h2>
76
Razican114ab092011-04-25 17:26:45 +0200[diff] [blame]77<p>This helper function gives you view file friendly syntax to get browser cookies. Refer to the <a href="../libraries/input.html">Input class</a> for a description of use, as this function is an alias to $this->input->cookie().</p>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]78
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]79
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]80<h2>delete_cookie()</h2>
81
Razican114ab092011-04-25 17:26:45 +0200[diff] [blame]82<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>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]83
84<code>delete_cookie("name");</code>
85
Razican114ab092011-04-25 17:26:45 +0200[diff] [blame]86<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 Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]87of values in the first parameter or you can set discrete parameters.</p>
88
89<code>delete_cookie($name, $domain, $path, $prefix)</code>
90
91
92</div>
93<!-- END CONTENT -->
94
95
96<div id="footer">
97<p>
kenjis49e31252011-04-15 11:37:15 +0900[diff] [blame^]98Previous Topic:&nbsp;&nbsp;<a href="captcha_helper.html">CAPTCHA Helper</a>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]99&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
100<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
101<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
102Next Topic:&nbsp;&nbsp;<a href="date_helper.html">Date Helper</a></p>
Derek Jones898949f2011-01-28 07:42:16 -0600[diff] [blame]103<p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006 - 2011 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">EllisLab, Inc.</a></p>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]104</div>
105
106</body>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]107</html>