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-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> * @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  */
  47 Ext.define('Ext.state.CookieProvider', {
  48     extend: 'Ext.state.Provider',
  49
  50 <span id='Ext-state-CookieProvider-method-constructor'>    /**
  51 </span>     * Creates a new CookieProvider.
  52      * @param {Object} config (optional) Config object.
  53      */
  54     constructor : function(config){
  55         var me = this;
  56         me.path = &quot;/&quot;;
  57         me.expires = new Date(new Date().getTime()+(1000*60*60*24*7)); //7 days
  58         me.domain = null;
  59         me.secure = false;
  60         me.callParent(arguments);
  61         me.state = me.readCookies();
  62     },
  63
  64     // private
  65     set : function(name, value){
  66         var me = this;
  67
  68         if(typeof value == &quot;undefined&quot; || value === null){
  69             me.clear(name);
  70             return;
  71         }
  72         me.setCookie(name, value);
  73         me.callParent(arguments);
  74     },
  75
  76     // private
  77     clear : function(name){
  78         this.clearCookie(name);
  79         this.callParent(arguments);
  80     },
  81
  82     // private
  83     readCookies : function(){
  84         var cookies = {},
  85             c = document.cookie + &quot;;&quot;,
  86             re = /\s?(.*?)=(.*?);/g,
  87             prefix = this.prefix,
  88             len = prefix.length,
  89             matches,
  90             name,
  91             value;
  92
  93         while((matches = re.exec(c)) != null){
  94             name = matches[1];
  95             value = matches[2];
  96             if (name &amp;&amp; name.substring(0, len) == prefix){
  97                 cookies[name.substr(len)] = this.decodeValue(value);
  98             }
  99         }
 100         return cookies;
 101     },
 102
 103     // private
 104     setCookie : function(name, value){
 105         var me = this;
 106
 107         document.cookie = me.prefix + name + &quot;=&quot; + me.encodeValue(value) +
 108            ((me.expires == null) ? &quot;&quot; : (&quot;; expires=&quot; + me.expires.toGMTString())) +
 109            ((me.path == null) ? &quot;&quot; : (&quot;; path=&quot; + me.path)) +
 110            ((me.domain == null) ? &quot;&quot; : (&quot;; domain=&quot; + me.domain)) +
 111            ((me.secure == true) ? &quot;; secure&quot; : &quot;&quot;);
 112     },
 113
 114     // private
 115     clearCookie : function(name){
 116         var me = this;
 117
 118         document.cookie = me.prefix + name + &quot;=null; expires=Thu, 01-Jan-70 00:00:01 GMT&quot; +
 119            ((me.path == null) ? &quot;&quot; : (&quot;; path=&quot; + me.path)) +
 120            ((me.domain == null) ? &quot;&quot; : (&quot;; domain=&quot; + me.domain)) +
 121            ((me.secure == true) ? &quot;; secure&quot; : &quot;&quot;);
 122     }
 123 });
 124 </pre>
 125 </body>
 126 </html>