root / ui / static / jquery.cookie.js @ 2ee4f989
History | View | Annotate | Download (3.6 kB)
1 | 201d192a | Dimitris Moraitis | /*jslint browser: true */ /*global jQuery: true */ |
---|---|---|---|
2 | 201d192a | Dimitris Moraitis | |
3 | 201d192a | Dimitris Moraitis | /**
|
4 | 201d192a | Dimitris Moraitis | * jQuery Cookie plugin
|
5 | 201d192a | Dimitris Moraitis | *
|
6 | 201d192a | Dimitris Moraitis | * Copyright (c) 2010 Klaus Hartl (stilbuero.de)
|
7 | 201d192a | Dimitris Moraitis | * Dual licensed under the MIT and GPL licenses:
|
8 | 201d192a | Dimitris Moraitis | * http://www.opensource.org/licenses/mit-license.php
|
9 | 201d192a | Dimitris Moraitis | * http://www.gnu.org/licenses/gpl.html
|
10 | 201d192a | Dimitris Moraitis | *
|
11 | 201d192a | Dimitris Moraitis | */
|
12 | 201d192a | Dimitris Moraitis | |
13 | 201d192a | Dimitris Moraitis | // TODO JsDoc
|
14 | 201d192a | Dimitris Moraitis | |
15 | 201d192a | Dimitris Moraitis | /**
|
16 | 201d192a | Dimitris Moraitis | * Create a cookie with the given key and value and other optional parameters.
|
17 | 201d192a | Dimitris Moraitis | *
|
18 | 201d192a | Dimitris Moraitis | * @example $.cookie('the_cookie', 'the_value');
|
19 | 201d192a | Dimitris Moraitis | * @desc Set the value of a cookie.
|
20 | 201d192a | Dimitris Moraitis | * @example $.cookie('the_cookie', 'the_value', { expires: 7, path: '/', domain: 'jquery.com', secure: true });
|
21 | 201d192a | Dimitris Moraitis | * @desc Create a cookie with all available options.
|
22 | 201d192a | Dimitris Moraitis | * @example $.cookie('the_cookie', 'the_value');
|
23 | 201d192a | Dimitris Moraitis | * @desc Create a session cookie.
|
24 | 201d192a | Dimitris Moraitis | * @example $.cookie('the_cookie', null);
|
25 | 201d192a | Dimitris Moraitis | * @desc Delete a cookie by passing null as value. Keep in mind that you have to use the same path and domain
|
26 | 201d192a | Dimitris Moraitis | * used when the cookie was set.
|
27 | 201d192a | Dimitris Moraitis | *
|
28 | 201d192a | Dimitris Moraitis | * @param String key The key of the cookie.
|
29 | 201d192a | Dimitris Moraitis | * @param String value The value of the cookie.
|
30 | 201d192a | Dimitris Moraitis | * @param Object options An object literal containing key/value pairs to provide optional cookie attributes.
|
31 | 201d192a | Dimitris Moraitis | * @option Number|Date expires Either an integer specifying the expiration date from now on in days or a Date object.
|
32 | 201d192a | Dimitris Moraitis | * If a negative value is specified (e.g. a date in the past), the cookie will be deleted.
|
33 | 201d192a | Dimitris Moraitis | * If set to null or omitted, the cookie will be a session cookie and will not be retained
|
34 | 201d192a | Dimitris Moraitis | * when the the browser exits.
|
35 | 201d192a | Dimitris Moraitis | * @option String path The value of the path atribute of the cookie (default: path of page that created the cookie).
|
36 | 201d192a | Dimitris Moraitis | * @option String domain The value of the domain attribute of the cookie (default: domain of page that created the cookie).
|
37 | 201d192a | Dimitris Moraitis | * @option Boolean secure If true, the secure attribute of the cookie will be set and the cookie transmission will
|
38 | 201d192a | Dimitris Moraitis | * require a secure protocol (like HTTPS).
|
39 | 201d192a | Dimitris Moraitis | * @type undefined
|
40 | 201d192a | Dimitris Moraitis | *
|
41 | 201d192a | Dimitris Moraitis | * @name $.cookie
|
42 | 201d192a | Dimitris Moraitis | * @cat Plugins/Cookie
|
43 | 201d192a | Dimitris Moraitis | * @author Klaus Hartl/klaus.hartl@stilbuero.de
|
44 | 201d192a | Dimitris Moraitis | */
|
45 | 201d192a | Dimitris Moraitis | |
46 | 201d192a | Dimitris Moraitis | /**
|
47 | 201d192a | Dimitris Moraitis | * Get the value of a cookie with the given key.
|
48 | 201d192a | Dimitris Moraitis | *
|
49 | 201d192a | Dimitris Moraitis | * @example $.cookie('the_cookie');
|
50 | 201d192a | Dimitris Moraitis | * @desc Get the value of a cookie.
|
51 | 201d192a | Dimitris Moraitis | *
|
52 | 201d192a | Dimitris Moraitis | * @param String key The key of the cookie.
|
53 | 201d192a | Dimitris Moraitis | * @return The value of the cookie.
|
54 | 201d192a | Dimitris Moraitis | * @type String
|
55 | 201d192a | Dimitris Moraitis | *
|
56 | 201d192a | Dimitris Moraitis | * @name $.cookie
|
57 | 201d192a | Dimitris Moraitis | * @cat Plugins/Cookie
|
58 | 201d192a | Dimitris Moraitis | * @author Klaus Hartl/klaus.hartl@stilbuero.de
|
59 | 201d192a | Dimitris Moraitis | */
|
60 | 201d192a | Dimitris Moraitis | jQuery.cookie = function (key, value, options) { |
61 | 201d192a | Dimitris Moraitis | |
62 | 201d192a | Dimitris Moraitis | // key and at least value given, set cookie...
|
63 | 201d192a | Dimitris Moraitis | if (arguments.length > 1 && String(value) !== "[object Object]") { |
64 | 201d192a | Dimitris Moraitis | options = jQuery.extend({}, options); |
65 | 201d192a | Dimitris Moraitis | |
66 | 201d192a | Dimitris Moraitis | if (value === null || value === undefined) { |
67 | 201d192a | Dimitris Moraitis | options.expires = -1;
|
68 | 201d192a | Dimitris Moraitis | } |
69 | 201d192a | Dimitris Moraitis | |
70 | 201d192a | Dimitris Moraitis | if (typeof options.expires === 'number') { |
71 | 201d192a | Dimitris Moraitis | var days = options.expires, t = options.expires = new Date(); |
72 | 201d192a | Dimitris Moraitis | t.setDate(t.getDate() + days); |
73 | 201d192a | Dimitris Moraitis | } |
74 | 201d192a | Dimitris Moraitis | |
75 | 201d192a | Dimitris Moraitis | value = String(value); |
76 | 201d192a | Dimitris Moraitis | |
77 | 201d192a | Dimitris Moraitis | return (document.cookie = [
|
78 | 201d192a | Dimitris Moraitis | encodeURIComponent(key), '=',
|
79 | 201d192a | Dimitris Moraitis | options.raw ? value : encodeURIComponent(value), |
80 | 201d192a | Dimitris Moraitis | options.expires ? '; expires=' + options.expires.toUTCString() : '', // use expires attribute, max-age is not supported by IE |
81 | 201d192a | Dimitris Moraitis | options.path ? '; path=' + options.path : '', |
82 | 201d192a | Dimitris Moraitis | options.domain ? '; domain=' + options.domain : '', |
83 | 201d192a | Dimitris Moraitis | options.secure ? '; secure' : '' |
84 | 201d192a | Dimitris Moraitis | ].join(''));
|
85 | 201d192a | Dimitris Moraitis | } |
86 | 201d192a | Dimitris Moraitis | |
87 | 201d192a | Dimitris Moraitis | // key and possibly options given, get cookie...
|
88 | 201d192a | Dimitris Moraitis | options = value || {}; |
89 | 201d192a | Dimitris Moraitis | var result, decode = options.raw ? function (s) { return s; } : decodeURIComponent; |
90 | 201d192a | Dimitris Moraitis | return (result = new RegExp('(?:^|; )' + encodeURIComponent(key) + '=([^;]*)').exec(document.cookie)) ? decode(result[1]) : null; |
91 | 201d192a | Dimitris Moraitis | }; |