jquery.cookie.js 3.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  1. /**
  2. * Cookie plugin
  3. *
  4. * Copyright (c) 2006 Klaus Hartl (stilbuero.de)
  5. * Dual licensed under the MIT and GPL licenses:
  6. * http://www.opensource.org/licenses/mit-license.php
  7. * http://www.gnu.org/licenses/gpl.html
  8. *
  9. */
  10. /**
  11. * Create a cookie with the given name and value and other optional parameters.
  12. *
  13. * @example $.cookie('the_cookie', 'the_value');
  14. * @desc Set the value of a cookie.
  15. * @example $.cookie('the_cookie', 'the_value', {expires: 7, path: '/', domain: 'jquery.com', secure: true});
  16. * @desc Create a cookie with all available options.
  17. * @example $.cookie('the_cookie', 'the_value');
  18. * @desc Create a session cookie.
  19. * @example $.cookie('the_cookie', null);
  20. * @desc Delete a cookie by passing null as value.
  21. *
  22. * @param String name The name of the cookie.
  23. * @param String value The value of the cookie.
  24. * @param Object options An object literal containing key/value pairs to provide optional cookie attributes.
  25. * @option Number|Date expires Either an integer specifying the expiration date from now on in days or a Date object.
  26. * If a negative value is specified (e.g. a date in the past), the cookie will be deleted.
  27. * If set to null or omitted, the cookie will be a session cookie and will not be retained
  28. * when the the browser exits.
  29. * @option String path The value of the path atribute of the cookie (default: path of page that created the cookie).
  30. * @option String domain The value of the domain attribute of the cookie (default: domain of page that created the cookie).
  31. * @option Boolean secure If true, the secure attribute of the cookie will be set and the cookie transmission will
  32. * require a secure protocol (like HTTPS).
  33. * @type undefined
  34. *
  35. * @name $.cookie
  36. * @cat Plugins/Cookie
  37. * @author Klaus Hartl/klaus.hartl@stilbuero.de
  38. */
  39. /**
  40. * Get the value of a cookie with the given name.
  41. *
  42. * @example $.cookie('the_cookie');
  43. * @desc Get the value of a cookie.
  44. *
  45. * @param String name The name of the cookie.
  46. * @return The value of the cookie.
  47. * @type String
  48. *
  49. * @name $.cookie
  50. * @cat Plugins/Cookie
  51. * @author Klaus Hartl/klaus.hartl@stilbuero.de
  52. */
  53. jQuery.cookie = function(name, value, options) {
  54. if (typeof value != 'undefined') { // name and value given, set cookie
  55. options = options || {};
  56. if (value === null) {
  57. value = '';
  58. options.expires = -1;
  59. }
  60. var expires = '';
  61. if (options.expires && (typeof options.expires == 'number' || options.expires.toUTCString)) {
  62. var date;
  63. if (typeof options.expires == 'number') {
  64. date = new Date();
  65. date.setTime(date.getTime() + (options.expires * 24 * 60 * 60 * 1000));
  66. } else {
  67. date = options.expires;
  68. }
  69. expires = '; expires=' + date.toUTCString(); // use expires attribute, max-age is not supported by IE
  70. }
  71. var path = options.path ? '; path=' + options.path : '';
  72. var domain = options.domain ? '; domain=' + options.domain : '';
  73. var secure = options.secure ? '; secure' : '';
  74. document.cookie = [name, '=', encodeURIComponent(value), expires, path, domain, secure].join('');
  75. } else { // only name given, get cookie
  76. var cookieValue = null;
  77. if (document.cookie && document.cookie != '') {
  78. var cookies = document.cookie.split(';');
  79. for (var i = 0; i < cookies.length; i++) {
  80. var cookie = jQuery.trim(cookies[i]);
  81. // Does this cookie string begin with the name we want?
  82. if (cookie.substring(0, name.length + 1) == (name + '=')) {
  83. cookieValue = decodeURIComponent(cookie.substring(name.length + 1));
  84. break;
  85. }
  86. }
  87. }
  88. return cookieValue;
  89. }
  90. };