Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / source / CookieProvider.html
index c6fa668..818501f 100644 (file)
@@ -1,83 +1,82 @@
-<html>
-<head>
-  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    
-  <title>The source code</title>
-    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
-    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
-</head>
-<body  onload="prettyPrint();">
-    <pre class="prettyprint lang-js">/*!
- * Ext JS Library 3.3.1
- * Copyright(c) 2006-2010 Sencha Inc.
- * licensing@sencha.com
- * http://www.sencha.com/license
- */
-
-<div id="cls-Ext.state.CookieProvider"></div>/**
- * @class Ext.state.CookieProvider
+<!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre><span id='Ext-state.CookieProvider-method-constructor'><span id='Ext-state.CookieProvider-cfg-secure'><span id='Ext-state.CookieProvider-cfg-domain'><span id='Ext-state.CookieProvider-cfg-expires'><span id='Ext-state.CookieProvider-cfg-path'><span id='Ext-state.CookieProvider'>/**
+</span></span></span></span></span></span> * @class Ext.state.CookieProvider
  * @extends Ext.state.Provider
- * The default Provider implementation which saves state via cookies.
- * <br />Usage:
- <pre><code>
+ * A Provider implementation which saves and retrieves state via cookies.
+ * The CookieProvider supports the usual cookie options, such as:
+ * &lt;ul&gt;
+ * &lt;li&gt;{@link #path}&lt;/li&gt;
+ * &lt;li&gt;{@link #expires}&lt;/li&gt;
+ * &lt;li&gt;{@link #domain}&lt;/li&gt;
+ * &lt;li&gt;{@link #secure}&lt;/li&gt;
+ * &lt;/ul&gt;
+ &lt;pre&gt;&lt;code&gt;
    var cp = new Ext.state.CookieProvider({
-       path: "/cgi-bin/",
+       path: &quot;/cgi-bin/&quot;,
        expires: new Date(new Date().getTime()+(1000*60*60*24*30)), //30 days
-       domain: "extjs.com"
+       domain: &quot;sencha.com&quot;
    });
    Ext.state.Manager.setProvider(cp);
- </code></pre>
+ &lt;/code&gt;&lt;/pre&gt;
  * @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 'extjs.com' to include
+ * 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.extjs.com')
+ * domain the page is running on including the 'www' like 'www.sencha.com')
  * @cfg {Boolean} secure True if the site is using SSL (defaults to false)
  * @constructor
  * Create a new CookieProvider
  * @param {Object} config The configuration object
  */
-Ext.state.CookieProvider = Ext.extend(Ext.state.Provider, {
-    
+Ext.define('Ext.state.CookieProvider', {
+    extend: 'Ext.state.Provider',
+
     constructor : function(config){
-        Ext.state.CookieProvider.superclass.constructor.call(this);
-        this.path = "/";
-        this.expires = new Date(new Date().getTime()+(1000*60*60*24*7)); //7 days
-        this.domain = null;
-        this.secure = false;
-        Ext.apply(this, config);
-        this.state = this.readCookies();
+        var me = this;
+        me.path = &quot;/&quot;;
+        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){
-        if(typeof value == "undefined" || value === null){
-            this.clear(name);
+        var me = this;
+        
+        if(typeof value == &quot;undefined&quot; || value === null){
+            me.clear(name);
             return;
         }
-        this.setCookie(name, value);
-        Ext.state.CookieProvider.superclass.set.call(this, name, value);
+        me.setCookie(name, value);
+        me.callParent(arguments);
     },
 
     // private
     clear : function(name){
         this.clearCookie(name);
-        Ext.state.CookieProvider.superclass.clear.call(this, name);
+        this.callParent(arguments);
     },
 
     // private
     readCookies : function(){
         var cookies = {},
-            c = document.cookie + ";",
+            c = document.cookie + &quot;;&quot;,
             re = /\s?(.*?)=(.*?);/g,
-           matches,
+            prefix = this.prefix,
+            len = prefix.length,
+            matches,
             name,
             value;
-       while((matches = re.exec(c)) != null){
+            
+        while((matches = re.exec(c)) != null){
             name = matches[1];
             value = matches[2];
-            if(name && name.substring(0,3) == "ys-"){
-                cookies[name.substr(3)] = this.decodeValue(value);
+            if (name &amp;&amp; name.substring(0, len) == prefix){
+                cookies[name.substr(len)] = this.decodeValue(value);
             }
         }
         return cookies;
@@ -85,20 +84,23 @@ Ext.state.CookieProvider = Ext.extend(Ext.state.Provider, {
 
     // private
     setCookie : function(name, value){
-        document.cookie = "ys-"+ name + "=" + this.encodeValue(value) +
-           ((this.expires == null) ? "" : ("; expires=" + this.expires.toGMTString())) +
-           ((this.path == null) ? "" : ("; path=" + this.path)) +
-           ((this.domain == null) ? "" : ("; domain=" + this.domain)) +
-           ((this.secure == true) ? "; secure" : "");
+        var me = this;
+        
+        document.cookie = me.prefix + name + &quot;=&quot; + me.encodeValue(value) +
+           ((me.expires == null) ? &quot;&quot; : (&quot;; expires=&quot; + me.expires.toGMTString())) +
+           ((me.path == null) ? &quot;&quot; : (&quot;; path=&quot; + me.path)) +
+           ((me.domain == null) ? &quot;&quot; : (&quot;; domain=&quot; + me.domain)) +
+           ((me.secure == true) ? &quot;; secure&quot; : &quot;&quot;);
     },
 
     // private
     clearCookie : function(name){
-        document.cookie = "ys-" + name + "=null; expires=Thu, 01-Jan-70 00:00:01 GMT" +
-           ((this.path == null) ? "" : ("; path=" + this.path)) +
-           ((this.domain == null) ? "" : ("; domain=" + this.domain)) +
-           ((this.secure == true) ? "; secure" : "");
+        var me = this;
+        
+        document.cookie = me.prefix + name + &quot;=null; expires=Thu, 01-Jan-70 00:00:01 GMT&quot; +
+           ((me.path == null) ? &quot;&quot; : (&quot;; path=&quot; + me.path)) +
+           ((me.domain == null) ? &quot;&quot; : (&quot;; domain=&quot; + me.domain)) +
+           ((me.secure == true) ? &quot;; secure&quot; : &quot;&quot;);
     }
-});</pre>    
-</body>
-</html>
\ No newline at end of file
+});
+</pre></pre></body></html>
\ No newline at end of file