blob: b46f805407aaf1c54098e02ec56fc79b1c6fe864 [file] [log] [blame]
Derek Jones37f4b9c2011-07-01 17:56:50 -05001<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
Derek Allard2067d1a2008-11-13 22:59:24 +00002/**
3 * CodeIgniter
4 *
Phil Sturgeon07c1ac82012-03-09 17:03:37 +00005 * An open source application development framework for PHP 5.2.4 or newer
Derek Allard2067d1a2008-11-13 22:59:24 +00006 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05007 * NOTICE OF LICENSE
8 *
9 * Licensed under the Open Software License version 3.0
10 *
11 * This source file is subject to the Open Software License (OSL 3.0) that is
12 * bundled with this package in the files license.txt / license.rst. It is
13 * also available through the world wide web at this URL:
14 * http://opensource.org/licenses/OSL-3.0
15 * If you did not receive a copy of the license and are unable to obtain it
16 * through the world wide web, please send an email to
17 * licensing@ellislab.com so we can send you a copy immediately.
18 *
Derek Allard2067d1a2008-11-13 22:59:24 +000019 * @package CodeIgniter
Derek Jonesf4a4bd82011-10-20 12:18:42 -050020 * @author EllisLab Dev Team
Greg Aker0defe5d2012-01-01 18:46:41 -060021 * @copyright Copyright (c) 2008 - 2012, EllisLab, Inc. (http://ellislab.com/)
Derek Jonesf4a4bd82011-10-20 12:18:42 -050022 * @license http://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
Derek Allard2067d1a2008-11-13 22:59:24 +000023 * @link http://codeigniter.com
24 * @since Version 1.0
25 * @filesource
26 */
27
28// ------------------------------------------------------------------------
29
30/**
31 * CodeIgniter Cookie Helpers
32 *
33 * @package CodeIgniter
34 * @subpackage Helpers
35 * @category Helpers
Derek Jonesf4a4bd82011-10-20 12:18:42 -050036 * @author EllisLab Dev Team
Derek Allard2067d1a2008-11-13 22:59:24 +000037 * @link http://codeigniter.com/user_guide/helpers/cookie_helper.html
38 */
39
40// ------------------------------------------------------------------------
41
42/**
43 * Set cookie
44 *
45 * Accepts six parameter, or you can submit an associative
46 * array in the first parameter containing all the values.
47 *
48 * @access public
49 * @param mixed
50 * @param string the value of the cookie
51 * @param string the number of seconds until expiration
Derek Jones37f4b9c2011-07-01 17:56:50 -050052 * @param string the cookie domain. Usually: .yourdomain.com
Derek Allard2067d1a2008-11-13 22:59:24 +000053 * @param string the cookie path
54 * @param string the cookie prefix
55 * @return void
56 */
57if ( ! function_exists('set_cookie'))
58{
Phil Sturgeond8d1e242011-02-16 17:23:16 +000059 function set_cookie($name = '', $value = '', $expire = '', $domain = '', $path = '/', $prefix = '', $secure = FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +000060 {
Derek Allard2067d1a2008-11-13 22:59:24 +000061 // Set the config file options
62 $CI =& get_instance();
Phil Sturgeond8d1e242011-02-16 17:23:16 +000063 $CI->input->set_cookie($name, $value, $expire, $domain, $path, $prefix, $secure);
Derek Allard2067d1a2008-11-13 22:59:24 +000064 }
65}
Barry Mienydd671972010-10-04 16:33:58 +020066
Derek Allard2067d1a2008-11-13 22:59:24 +000067// --------------------------------------------------------------------
68
69/**
70 * Fetch an item from the COOKIE array
71 *
72 * @access public
73 * @param string
74 * @param bool
75 * @return mixed
76 */
77if ( ! function_exists('get_cookie'))
78{
79 function get_cookie($index = '', $xss_clean = FALSE)
80 {
Derek Jonesa04cfa72009-02-10 20:16:57 +000081 $CI =& get_instance();
Barry Mienydd671972010-10-04 16:33:58 +020082
Derek Jones2c8dc582009-02-10 20:15:49 +000083 $prefix = '';
Barry Mienydd671972010-10-04 16:33:58 +020084
Derek Jones2c8dc582009-02-10 20:15:49 +000085 if ( ! isset($_COOKIE[$index]) && config_item('cookie_prefix') != '')
86 {
87 $prefix = config_item('cookie_prefix');
88 }
Barry Mienydd671972010-10-04 16:33:58 +020089
Derek Jones2c8dc582009-02-10 20:15:49 +000090 return $CI->input->cookie($prefix.$index, $xss_clean);
Derek Allard2067d1a2008-11-13 22:59:24 +000091 }
92}
93
94// --------------------------------------------------------------------
95
96/**
97 * Delete a COOKIE
98 *
99 * @param mixed
Derek Jones37f4b9c2011-07-01 17:56:50 -0500100 * @param string the cookie domain. Usually: .yourdomain.com
Derek Allard2067d1a2008-11-13 22:59:24 +0000101 * @param string the cookie path
102 * @param string the cookie prefix
103 * @return void
104 */
105if ( ! function_exists('delete_cookie'))
106{
107 function delete_cookie($name = '', $domain = '', $path = '/', $prefix = '')
108 {
109 set_cookie($name, '', '', $domain, $path, $prefix);
110 }
111}
112
113
114/* End of file cookie_helper.php */
Derek Jonesa3ffbbb2008-05-11 18:18:29 +0000115/* Location: ./system/helpers/cookie_helper.php */