blob: ec8aa3250c3829099d7bb6cabf59b8fec60fc9c2 [file] [log] [blame]
Andrey Andreevdbf4a5a2012-03-13 12:08:59 +02001<?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
Andrey Andreevdbf4a5a2012-03-13 12:08:59 +02008 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05009 * Licensed under the Open Software License version 3.0
Andrey Andreevdbf4a5a2012-03-13 12:08:59 +020010 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -050011 * 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
Derek Allard2067d1a2008-11-13 22:59:24 +000028/**
29 * CodeIgniter Cookie Helpers
30 *
31 * @package CodeIgniter
32 * @subpackage Helpers
33 * @category Helpers
Derek Jonesf4a4bd82011-10-20 12:18:42 -050034 * @author EllisLab Dev Team
Derek Allard2067d1a2008-11-13 22:59:24 +000035 * @link http://codeigniter.com/user_guide/helpers/cookie_helper.html
36 */
37
38// ------------------------------------------------------------------------
39
40/**
41 * Set cookie
42 *
freewil4ad0fd82012-03-13 22:37:42 -040043 * Accepts seven parameters, or you can submit an associative
Derek Allard2067d1a2008-11-13 22:59:24 +000044 * array in the first parameter containing all the values.
45 *
Derek Allard2067d1a2008-11-13 22:59:24 +000046 * @param mixed
47 * @param string the value of the cookie
48 * @param string the number of seconds until expiration
Derek Jones37f4b9c2011-07-01 17:56:50 -050049 * @param string the cookie domain. Usually: .yourdomain.com
Derek Allard2067d1a2008-11-13 22:59:24 +000050 * @param string the cookie path
51 * @param string the cookie prefix
freewil4ad0fd82012-03-13 22:37:42 -040052 * @param bool true makes the cookie secure
53 * @param bool true makes the cookie accessible via http(s) only (no javascript)
Derek Allard2067d1a2008-11-13 22:59:24 +000054 * @return void
55 */
56if ( ! function_exists('set_cookie'))
57{
freewil4ad0fd82012-03-13 22:37:42 -040058 function set_cookie($name = '', $value = '', $expire = '', $domain = '', $path = '/', $prefix = '', $secure = FALSE, $httponly = FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +000059 {
Derek Allard2067d1a2008-11-13 22:59:24 +000060 // Set the config file options
61 $CI =& get_instance();
freewil4ad0fd82012-03-13 22:37:42 -040062 $CI->input->set_cookie($name, $value, $expire, $domain, $path, $prefix, $secure, $httponly);
Derek Allard2067d1a2008-11-13 22:59:24 +000063 }
64}
Barry Mienydd671972010-10-04 16:33:58 +020065
Derek Allard2067d1a2008-11-13 22:59:24 +000066// --------------------------------------------------------------------
67
68/**
69 * Fetch an item from the COOKIE array
70 *
Derek Allard2067d1a2008-11-13 22:59:24 +000071 * @param string
72 * @param bool
73 * @return mixed
74 */
75if ( ! function_exists('get_cookie'))
76{
77 function get_cookie($index = '', $xss_clean = FALSE)
78 {
Derek Jonesa04cfa72009-02-10 20:16:57 +000079 $CI =& get_instance();
Andrey Andreevdbf4a5a2012-03-13 12:08:59 +020080 $prefix = isset($_COOKIE[$index]) ? '' : config_item('cookie_prefix');
Derek Jones2c8dc582009-02-10 20:15:49 +000081 return $CI->input->cookie($prefix.$index, $xss_clean);
Derek Allard2067d1a2008-11-13 22:59:24 +000082 }
83}
84
85// --------------------------------------------------------------------
86
87/**
88 * Delete a COOKIE
89 *
90 * @param mixed
Andrey Andreevdbf4a5a2012-03-13 12:08:59 +020091 * @param string the cookie domain. Usually: .yourdomain.com
Derek Allard2067d1a2008-11-13 22:59:24 +000092 * @param string the cookie path
93 * @param string the cookie prefix
94 * @return void
95 */
96if ( ! function_exists('delete_cookie'))
97{
98 function delete_cookie($name = '', $domain = '', $path = '/', $prefix = '')
99 {
100 set_cookie($name, '', '', $domain, $path, $prefix);
101 }
102}
103
Derek Allard2067d1a2008-11-13 22:59:24 +0000104/* End of file cookie_helper.php */
Andrey Andreevdbf4a5a2012-03-13 12:08:59 +0200105/* Location: ./system/helpers/cookie_helper.php */