[Sommaire] [Imprimer]

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