Upgrade to ExtJS 3.0.0 - Released 07/06/2009

[extjs.git] / src / util / Cookies.js

diff --git a/src/util/Cookies.js b/src/util/Cookies.js
new file mode 100644 (file)
index 0000000..201f09d
--- /dev/null
+++ b/src/util/Cookies.js
@@ -0,0 +1,96 @@
+/*!
+ * Ext JS Library 3.0.0
+ * Copyright(c) 2006-2009 Ext JS, LLC
+ * licensing@extjs.com
+ * http://www.extjs.com/license
+ */
+/**\r
+ * @class Ext.util.Cookies\r
+ * Utility class for managing and interacting with cookies.\r
+ * @singleton\r
+ */\r
+Ext.util.Cookies = {\r
+    /**\r
+     * Create a cookie with the specified name and value. Additional settings\r
+     * for the cookie may be optionally specified (for example: expiration,\r
+     * access restriction, SSL).\r
+     * @param {Object} name\r
+     * @param {Object} value\r
+     * @param {Object} expires (Optional) Specify an expiration date the\r
+     * cookie is to persist until.  Note that the specified Date object will\r
+     * be converted to Greenwich Mean Time (GMT). \r
+     * @param {String} path (Optional) Setting a path on the cookie restricts\r
+     * access to pages that match that path. Defaults to all pages (<tt>'/'</tt>). \r
+     * @param {String} domain (Optional) Setting a domain restricts access to\r
+     * pages on a given domain (typically used to allow cookie access across\r
+     * subdomains). For example, "extjs.com" will create a cookie that can be\r
+     * accessed from any subdomain of extjs.com, including www.extjs.com,\r
+     * support.extjs.com, etc.\r
+     * @param {Boolean} secure (Optional) Specify true to indicate that the cookie\r
+     * should only be accessible via SSL on a page using the HTTPS protocol.\r
+     * Defaults to <tt>false</tt>. Note that this will only work if the page\r
+     * calling this code uses the HTTPS protocol, otherwise the cookie will be\r
+     * created with default options.\r
+     */\r
+    set : function(name, value){\r
+        var argv = arguments;\r
+        var argc = arguments.length;\r
+        var expires = (argc > 2) ? argv[2] : null;\r
+        var path = (argc > 3) ? argv[3] : '/';\r
+        var domain = (argc > 4) ? argv[4] : null;\r
+        var secure = (argc > 5) ? argv[5] : false;\r
+        document.cookie = name + "=" + escape(value) + ((expires === null) ? "" : ("; expires=" + expires.toGMTString())) + ((path === null) ? "" : ("; path=" + path)) + ((domain === null) ? "" : ("; domain=" + domain)) + ((secure === true) ? "; secure" : "");\r
+    },\r
+\r
+    /**\r
+     * Retrieves cookies that are accessible by the current page. If a cookie\r
+     * does not exist, <code>get()</code> returns <tt>null</tt>.  The following\r
+     * example retrieves the cookie called "valid" and stores the String value\r
+     * in the variable <tt>validStatus</tt>.\r
+     * <pre><code>\r
+     * var validStatus = Ext.util.Cookies.get("valid");\r
+     * </code></pre>\r
+     * @param {Object} name The name of the cookie to get\r
+     * @return {Mixed} Returns the cookie value for the specified name;\r
+     * null if the cookie name does not exist.\r
+     */\r
+    get : function(name){\r
+        var arg = name + "=";\r
+        var alen = arg.length;\r
+        var clen = document.cookie.length;\r
+        var i = 0;\r
+        var j = 0;\r
+        while(i < clen){\r
+            j = i + alen;\r
+            if(document.cookie.substring(i, j) == arg){\r
+                return Ext.util.Cookies.getCookieVal(j);\r
+            }\r
+            i = document.cookie.indexOf(" ", i) + 1;\r
+            if(i === 0){\r
+                break;\r
+            }\r
+        }\r
+        return null;\r
+    },\r
+\r
+    /**\r
+     * Removes a cookie with the provided name from the browser\r
+     * if found.\r
+     * @param {Object} name The name of the cookie to remove\r
+     */\r
+    clear : function(name){\r
+        if(Ext.util.Cookies.get(name)){\r
+            document.cookie = name + "=" + "; expires=Thu, 01-Jan-70 00:00:01 GMT";\r
+        }\r
+    },\r
+    /**\r
+     * @private\r
+     */\r
+    getCookieVal : function(offset){\r
+        var endstr = document.cookie.indexOf(";", offset);\r
+        if(endstr == -1){\r
+            endstr = document.cookie.length;\r
+        }\r
+        return unescape(document.cookie.substring(offset, endstr));\r
+    }\r
+};
\ No newline at end of file