cookie_helper.php 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  1. <?php
  2. /**
  3. * CodeIgniter
  4. *
  5. * An open source application development framework for PHP
  6. *
  7. * This content is released under the MIT License (MIT)
  8. *
  9. * Copyright (c) 2014 - 2019, British Columbia Institute of Technology
  10. *
  11. * Permission is hereby granted, free of charge, to any person obtaining a copy
  12. * of this software and associated documentation files (the "Software"), to deal
  13. * in the Software without restriction, including without limitation the rights
  14. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  15. * copies of the Software, and to permit persons to whom the Software is
  16. * furnished to do so, subject to the following conditions:
  17. *
  18. * The above copyright notice and this permission notice shall be included in
  19. * all copies or substantial portions of the Software.
  20. *
  21. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  22. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  23. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  24. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  25. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  26. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  27. * THE SOFTWARE.
  28. *
  29. * @package CodeIgniter
  30. * @author EllisLab Dev Team
  31. * @copyright Copyright (c) 2008 - 2014, EllisLab, Inc. (https://ellislab.com/)
  32. * @copyright Copyright (c) 2014 - 2019, British Columbia Institute of Technology (https://bcit.ca/)
  33. * @license https://opensource.org/licenses/MIT MIT License
  34. * @link https://codeigniter.com
  35. * @since Version 1.0.0
  36. * @filesource
  37. */
  38. defined('BASEPATH') OR exit('No direct script access allowed');
  39. /**
  40. * CodeIgniter Cookie Helpers
  41. *
  42. * @package CodeIgniter
  43. * @subpackage Helpers
  44. * @category Helpers
  45. * @author EllisLab Dev Team
  46. * @link https://codeigniter.com/user_guide/helpers/cookie_helper.html
  47. */
  48. // ------------------------------------------------------------------------
  49. if ( ! function_exists('set_cookie'))
  50. {
  51. /**
  52. * Set cookie
  53. *
  54. * Accepts seven parameters, or you can submit an associative
  55. * array in the first parameter containing all the values.
  56. *
  57. * @param mixed
  58. * @param string the value of the cookie
  59. * @param string the number of seconds until expiration
  60. * @param string the cookie domain. Usually: .yourdomain.com
  61. * @param string the cookie path
  62. * @param string the cookie prefix
  63. * @param bool true makes the cookie secure
  64. * @param bool true makes the cookie accessible via http(s) only (no javascript)
  65. * @return void
  66. */
  67. function set_cookie($name, $value = '', $expire = '', $domain = '', $path = '/', $prefix = '', $secure = NULL, $httponly = NULL)
  68. {
  69. // Set the config file options
  70. get_instance()->input->set_cookie($name, $value, $expire, $domain, $path, $prefix, $secure, $httponly);
  71. }
  72. }
  73. // --------------------------------------------------------------------
  74. if ( ! function_exists('get_cookie'))
  75. {
  76. /**
  77. * Fetch an item from the COOKIE array
  78. *
  79. * @param string
  80. * @param bool
  81. * @return mixed
  82. */
  83. function get_cookie($index, $xss_clean = NULL)
  84. {
  85. is_bool($xss_clean) OR $xss_clean = (config_item('global_xss_filtering') === TRUE);
  86. $prefix = isset($_COOKIE[$index]) ? '' : config_item('cookie_prefix');
  87. return get_instance()->input->cookie($prefix.$index, $xss_clean);
  88. }
  89. }
  90. // --------------------------------------------------------------------
  91. if ( ! function_exists('delete_cookie'))
  92. {
  93. /**
  94. * Delete a COOKIE
  95. *
  96. * @param mixed
  97. * @param string the cookie domain. Usually: .yourdomain.com
  98. * @param string the cookie path
  99. * @param string the cookie prefix
  100. * @return void
  101. */
  102. function delete_cookie($name, $domain = '', $path = '/', $prefix = '')
  103. {
  104. set_cookie($name, '', '', $domain, $path, $prefix);
  105. }
  106. }