Upgrade to ExtJS 4.0.1 - Released 05/18/2011
[extjs.git] / docs / source / CookieProvider.html
1 <!DOCTYPE html>
2 <html>
3 <head>
4   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5   <title>The source code</title>
6   <link href="../prettify/prettify.css" type="text/css" rel="stylesheet" />
7   <script type="text/javascript" src="../prettify/prettify.js"></script>
8   <style type="text/css">
9     .highlight { display: block; background-color: #ddd; }
10   </style>
11   <script type="text/javascript">
12     function highlight() {
13       document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
14     }
15   </script>
16 </head>
17 <body onload="prettyPrint(); highlight();">
18   <pre class="prettyprint lang-js"><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'>/**
19 </span></span></span></span></span></span> * @class Ext.state.CookieProvider
20  * @extends Ext.state.Provider
21  * A Provider implementation which saves and retrieves state via cookies.
22  * The CookieProvider supports the usual cookie options, such as:
23  * &lt;ul&gt;
24  * &lt;li&gt;{@link #path}&lt;/li&gt;
25  * &lt;li&gt;{@link #expires}&lt;/li&gt;
26  * &lt;li&gt;{@link #domain}&lt;/li&gt;
27  * &lt;li&gt;{@link #secure}&lt;/li&gt;
28  * &lt;/ul&gt;
29  &lt;pre&gt;&lt;code&gt;
30    var cp = new Ext.state.CookieProvider({
31        path: &quot;/cgi-bin/&quot;,
32        expires: new Date(new Date().getTime()+(1000*60*60*24*30)), //30 days
33        domain: &quot;sencha.com&quot;
34    });
35    Ext.state.Manager.setProvider(cp);
36  &lt;/code&gt;&lt;/pre&gt;
37  
38  
39  * @cfg {String} path The path for which the cookie is active (defaults to root '/' which makes it active for all pages in the site)
40  * @cfg {Date} expires The cookie expiration date (defaults to 7 days from now)
41  * @cfg {String} domain The domain to save the cookie for.  Note that you cannot specify a different domain than
42  * your page is on, but you can specify a sub-domain, or simply the domain itself like 'sencha.com' to include
43  * all sub-domains if you need to access cookies across different sub-domains (defaults to null which uses the same
44  * domain the page is running on including the 'www' like 'www.sencha.com')
45  * @cfg {Boolean} secure True if the site is using SSL (defaults to false)
46  * @constructor
47  * Create a new CookieProvider
48  * @param {Object} config The configuration object
49  */
50 Ext.define('Ext.state.CookieProvider', {
51     extend: 'Ext.state.Provider',
52
53     constructor : function(config){
54         var me = this;
55         me.path = &quot;/&quot;;
56         me.expires = new Date(new Date().getTime()+(1000*60*60*24*7)); //7 days
57         me.domain = null;
58         me.secure = false;
59         me.callParent(arguments);
60         me.state = me.readCookies();
61     },
62     
63     // private
64     set : function(name, value){
65         var me = this;
66         
67         if(typeof value == &quot;undefined&quot; || value === null){
68             me.clear(name);
69             return;
70         }
71         me.setCookie(name, value);
72         me.callParent(arguments);
73     },
74
75     // private
76     clear : function(name){
77         this.clearCookie(name);
78         this.callParent(arguments);
79     },
80
81     // private
82     readCookies : function(){
83         var cookies = {},
84             c = document.cookie + &quot;;&quot;,
85             re = /\s?(.*?)=(.*?);/g,
86             prefix = this.prefix,
87             len = prefix.length,
88             matches,
89             name,
90             value;
91             
92         while((matches = re.exec(c)) != null){
93             name = matches[1];
94             value = matches[2];
95             if (name &amp;&amp; name.substring(0, len) == prefix){
96                 cookies[name.substr(len)] = this.decodeValue(value);
97             }
98         }
99         return cookies;
100     },
101
102     // private
103     setCookie : function(name, value){
104         var me = this;
105         
106         document.cookie = me.prefix + name + &quot;=&quot; + me.encodeValue(value) +
107            ((me.expires == null) ? &quot;&quot; : (&quot;; expires=&quot; + me.expires.toGMTString())) +
108            ((me.path == null) ? &quot;&quot; : (&quot;; path=&quot; + me.path)) +
109            ((me.domain == null) ? &quot;&quot; : (&quot;; domain=&quot; + me.domain)) +
110            ((me.secure == true) ? &quot;; secure&quot; : &quot;&quot;);
111     },
112
113     // private
114     clearCookie : function(name){
115         var me = this;
116         
117         document.cookie = me.prefix + name + &quot;=null; expires=Thu, 01-Jan-70 00:00:01 GMT&quot; +
118            ((me.path == null) ? &quot;&quot; : (&quot;; path=&quot; + me.path)) +
119            ((me.domain == null) ? &quot;&quot; : (&quot;; domain=&quot; + me.domain)) +
120            ((me.secure == true) ? &quot;; secure&quot; : &quot;&quot;);
121     }
122 });
123 </pre>
124 </body>
125 </html>