Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / src / state / CookieProvider.js
index 0d82d08..e1daafd 100644 (file)
-/*!
- * Ext JS Library 3.0.0
- * Copyright(c) 2006-2009 Ext JS, LLC
- * licensing@extjs.com
- * http://www.extjs.com/license
+/*
+
+This file is part of Ext JS 4
+
+Copyright (c) 2011 Sencha Inc
+
+Contact:  http://www.sencha.com/contact
+
+GNU General Public License Usage
+This file may be used under the terms of the GNU General Public License version 3.0 as published by the Free Software Foundation and appearing in the file LICENSE included in the packaging of this file.  Please review the following information to ensure the GNU General Public License version 3.0 requirements will be met: http://www.gnu.org/copyleft/gpl.html.
+
+If you are unsure which license is appropriate for your use, please contact the sales department at http://www.sencha.com/contact.
+
+*/
+/**
+ * A Provider implementation which saves and retrieves state via cookies. The CookieProvider supports the usual cookie
+ * options, such as:
+ *
+ * - {@link #path}
+ * - {@link #expires}
+ * - {@link #domain}
+ * - {@link #secure}
+ *
+ * Example:
+ *
+ *     Ext.create('Ext.state.CookieProvider', {
+ *         path: "/cgi-bin/",
+ *         expires: new Date(new Date().getTime()+(1000*60*60*24*30)), //30 days
+ *         domain: "sencha.com"
+ *     });
+ *
+ *     Ext.state.Manager.setProvider(cp);
+ *
+ * @constructor
+ * Creates a new CookieProvider.
+ * @param {Object} config (optional) Config object.
+ * @return {Object}
  */
-\r
-/**\r
- * @class Ext.state.CookieProvider\r
- * @extends Ext.state.Provider\r
- * The default Provider implementation which saves state via cookies.\r
- * <br />Usage:\r
- <pre><code>\r
-   var cp = new Ext.state.CookieProvider({\r
-       path: "/cgi-bin/",\r
-       expires: new Date(new Date().getTime()+(1000*60*60*24*30)), //30 days\r
-       domain: "extjs.com"\r
-   });\r
-   Ext.state.Manager.setProvider(cp);\r
- </code></pre>\r
- * @cfg {String} path The path for which the cookie is active (defaults to root '/' which makes it active for all pages in the site)\r
- * @cfg {Date} expires The cookie expiration date (defaults to 7 days from now)\r
- * @cfg {String} domain The domain to save the cookie for.  Note that you cannot specify a different domain than\r
- * your page is on, but you can specify a sub-domain, or simply the domain itself like 'extjs.com' to include\r
- * all sub-domains if you need to access cookies across different sub-domains (defaults to null which uses the same\r
- * domain the page is running on including the 'www' like 'www.extjs.com')\r
- * @cfg {Boolean} secure True if the site is using SSL (defaults to false)\r
- * @constructor\r
- * Create a new CookieProvider\r
- * @param {Object} config The configuration object\r
- */\r
-Ext.state.CookieProvider = function(config){\r
-    Ext.state.CookieProvider.superclass.constructor.call(this);\r
-    this.path = "/";\r
-    this.expires = new Date(new Date().getTime()+(1000*60*60*24*7)); //7 days\r
-    this.domain = null;\r
-    this.secure = false;\r
-    Ext.apply(this, config);\r
-    this.state = this.readCookies();\r
-};\r
-\r
-Ext.extend(Ext.state.CookieProvider, Ext.state.Provider, {\r
-    // private\r
-    set : function(name, value){\r
-        if(typeof value == "undefined" || value === null){\r
-            this.clear(name);\r
-            return;\r
-        }\r
-        this.setCookie(name, value);\r
-        Ext.state.CookieProvider.superclass.set.call(this, name, value);\r
-    },\r
-\r
-    // private\r
-    clear : function(name){\r
-        this.clearCookie(name);\r
-        Ext.state.CookieProvider.superclass.clear.call(this, name);\r
-    },\r
-\r
-    // private\r
-    readCookies : function(){\r
-        var cookies = {};\r
-        var c = document.cookie + ";";\r
-        var re = /\s?(.*?)=(.*?);/g;\r
-       var matches;\r
-       while((matches = re.exec(c)) != null){\r
-            var name = matches[1];\r
-            var value = matches[2];\r
-            if(name && name.substring(0,3) == "ys-"){\r
-                cookies[name.substr(3)] = this.decodeValue(value);\r
-            }\r
-        }\r
-        return cookies;\r
-    },\r
-\r
-    // private\r
-    setCookie : function(name, value){\r
-        document.cookie = "ys-"+ name + "=" + this.encodeValue(value) +\r
-           ((this.expires == null) ? "" : ("; expires=" + this.expires.toGMTString())) +\r
-           ((this.path == null) ? "" : ("; path=" + this.path)) +\r
-           ((this.domain == null) ? "" : ("; domain=" + this.domain)) +\r
-           ((this.secure == true) ? "; secure" : "");\r
-    },\r
-\r
-    // private\r
-    clearCookie : function(name){\r
-        document.cookie = "ys-" + name + "=null; expires=Thu, 01-Jan-70 00:00:01 GMT" +\r
-           ((this.path == null) ? "" : ("; path=" + this.path)) +\r
-           ((this.domain == null) ? "" : ("; domain=" + this.domain)) +\r
-           ((this.secure == true) ? "; secure" : "");\r
-    }\r
-});
\ No newline at end of file
+Ext.define('Ext.state.CookieProvider', {
+    extend: 'Ext.state.Provider',
+
+    /**
+     * @cfg {String} path
+     * The path for which the cookie is active. Defaults to root '/' which makes it active for all pages in the site.
+     */
+
+    /**
+     * @cfg {Date} expires
+     * The cookie expiration date. Defaults to 7 days from now.
+     */
+
+    /**
+     * @cfg {String} domain
+     * The domain to save the cookie for. Note that you cannot specify a different domain than your page is on, but you can
+     * specify a sub-domain, or simply the domain itself like 'sencha.com' to include all sub-domains if you need to access
+     * cookies across different sub-domains. Defaults to null which uses the same domain the page is running on including
+     * the 'www' like 'www.sencha.com'.
+     */
+
+    /**
+     * @cfg {Boolean} [secure=false]
+     * True if the site is using SSL
+     */
+
+    /**
+     * Creates a new CookieProvider.
+     * @param {Object} [config] Config object.
+     */
+    constructor : function(config){
+        var me = this;
+        me.path = "/";
+        me.expires = new Date(new Date().getTime()+(1000*60*60*24*7)); //7 days
+        me.domain = null;
+        me.secure = false;
+        me.callParent(arguments);
+        me.state = me.readCookies();
+    },
+
+    // private
+    set : function(name, value){
+        var me = this;
+
+        if(typeof value == "undefined" || value === null){
+            me.clear(name);
+            return;
+        }
+        me.setCookie(name, value);
+        me.callParent(arguments);
+    },
+
+    // private
+    clear : function(name){
+        this.clearCookie(name);
+        this.callParent(arguments);
+    },
+
+    // private
+    readCookies : function(){
+        var cookies = {},
+            c = document.cookie + ";",
+            re = /\s?(.*?)=(.*?);/g,
+            prefix = this.prefix,
+            len = prefix.length,
+            matches,
+            name,
+            value;
+
+        while((matches = re.exec(c)) != null){
+            name = matches[1];
+            value = matches[2];
+            if (name && name.substring(0, len) == prefix){
+                cookies[name.substr(len)] = this.decodeValue(value);
+            }
+        }
+        return cookies;
+    },
+
+    // private
+    setCookie : function(name, value){
+        var me = this;
+
+        document.cookie = me.prefix + name + "=" + me.encodeValue(value) +
+           ((me.expires == null) ? "" : ("; expires=" + me.expires.toGMTString())) +
+           ((me.path == null) ? "" : ("; path=" + me.path)) +
+           ((me.domain == null) ? "" : ("; domain=" + me.domain)) +
+           ((me.secure == true) ? "; secure" : "");
+    },
+
+    // private
+    clearCookie : function(name){
+        var me = this;
+
+        document.cookie = me.prefix + name + "=null; expires=Thu, 01-Jan-70 00:00:01 GMT" +
+           ((me.path == null) ? "" : ("; path=" + me.path)) +
+           ((me.domain == null) ? "" : ("; domain=" + me.domain)) +
+           ((me.secure == true) ? "; secure" : "");
+    }
+});
+