Upgrade to ExtJS 3.0.0 - Released 07/06/2009
[extjs.git] / docs / source / CookieProvider.html
diff --git a/docs/source/CookieProvider.html b/docs/source/CookieProvider.html
new file mode 100644 (file)
index 0000000..52f59f9
--- /dev/null
@@ -0,0 +1,94 @@
+<html>\r
+<head>\r
+  <title>The source code</title>\r
+    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
+    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
+</head>\r
+<body  onload="prettyPrint();">\r
+    <pre class="prettyprint lang-js">\r
+<div id="cls-Ext.state.CookieProvider"></div>/**\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
+});</pre>    \r
+</body>\r
+</html>
\ No newline at end of file