X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/c930e9176a5a85509c5b0230e2bff5c22a591432..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/docs/source/CookieProvider.html?ds=sidebyside diff --git a/docs/source/CookieProvider.html b/docs/source/CookieProvider.html index 52f59f9c..4b16d241 100644 --- a/docs/source/CookieProvider.html +++ b/docs/source/CookieProvider.html @@ -1,94 +1,144 @@ - -
--/** - * @class Ext.state.CookieProvider - * @extends Ext.state.Provider - * The default Provider implementation which saves state via cookies. - *- - \ No newline at end of file + + + + +
Usage: -- * @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 - * 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') - * @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 = 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(); -}; - -Ext.extend(Ext.state.CookieProvider, Ext.state.Provider, { - // private - set : function(name, value){ - if(typeof value == "undefined" || value === null){ - this.clear(name); - return; - } - this.setCookie(name, value); - Ext.state.CookieProvider.superclass.set.call(this, name, value); - }, - - // private - clear : function(name){ - this.clearCookie(name); - Ext.state.CookieProvider.superclass.clear.call(this, name); - }, - - // private - readCookies : function(){ - var cookies = {}; - var c = document.cookie + ";"; - var re = /\s?(.*?)=(.*?);/g; - var matches; - while((matches = re.exec(c)) != null){ - var name = matches[1]; - var value = matches[2]; - if(name && name.substring(0,3) == "ys-"){ - cookies[name.substr(3)] = this.decodeValue(value); - } - } - return cookies; - }, - - // 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" : ""); - }, - - // 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 cp = new Ext.state.CookieProvider({ - path: "/cgi-bin/", - expires: new Date(new Date().getTime()+(1000*60*60*24*30)), //30 days - domain: "extjs.com" - }); - Ext.state.Manager.setProvider(cp); -
/** + * 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} + */ +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" : ""); + } +}); ++ +