add extjs 6.0.1 sources

[extjs.git] / extjs / classic / classic / src / state / Provider.js

/**\r
 * @class Ext.state.Provider\r
 * <p>Abstract base class for state provider implementations. The provider is responsible\r
 * for setting values  and extracting values to/from the underlying storage source. The \r
 * storage source can vary and the details should be implemented in a subclass. For example\r
 * a provider could use a server side database or the browser localstorage where supported.</p>\r
 *\r
 * <p>This class provides methods for encoding and decoding <b>typed</b> variables including \r
 * dates and defines the Provider interface. By default these methods put the value and the\r
 * type information into a delimited string that can be stored. These should be overridden in \r
 * a subclass if you want to change the format of the encoded value and subsequent decoding.</p>\r
 */\r
Ext.define('Ext.state.Provider', {\r
    mixins: {\r
        observable: 'Ext.util.Observable'\r
    },\r
    \r
    /**\r
     * @cfg {String} prefix A string to prefix to items stored in the underlying state store. \r
     * Defaults to <tt>'ext-'</tt>\r
     */\r
    prefix: 'ext-',\r
    \r
    /**\r
     * @event statechange\r
     * Fires when a state change occurs.\r
     * @param {Ext.state.Provider} this This state provider\r
     * @param {String} key The state key which was changed\r
     * @param {String} value The encoded value for the state\r
     */\r
\r
    constructor : function(config){\r
        var me = this;\r
        Ext.apply(me, config);\r
        me.state = {};\r
        me.mixins.observable.constructor.call(me);\r
    },\r
    \r
    /**\r
     * Returns the current value for a key\r
     * @param {String} name The key name\r
     * @param {Object} defaultValue A default value to return if the key's value is not found\r
     * @return {Object} The state data\r
     */\r
    get : function(name, defaultValue){\r
        var ret = this.state[name];\r
        return ret === undefined ? defaultValue : ret;\r
    },\r
\r
    /**\r
     * Clears a value from the state\r
     * @param {String} name The key name\r
     */\r
    clear : function(name){\r
        var me = this;\r
        delete me.state[name];\r
        me.fireEvent("statechange", me, name, null);\r
    },\r
\r
    /**\r
     * Sets the value for a key\r
     * @param {String} name The key name\r
     * @param {Object} value The value to set\r
     */\r
    set : function(name, value){\r
        var me = this;\r
        me.state[name] = value;\r
        me.fireEvent("statechange", me, name, value);\r
    },\r
\r
    /**\r
     * Decodes a string previously encoded with {@link #encodeValue}.\r
     * @param {String} value The value to decode\r
     * @return {Object} The decoded value\r
     */\r
    decodeValue : function(value){\r
\r
        // a -> Array\r
        // n -> Number\r
        // d -> Date\r
        // b -> Boolean\r
        // s -> String\r
        // o -> Object\r
        // -> Empty (null)\r
\r
        var me = this,\r
            re = /^(a|n|d|b|s|o|e)\:(.*)$/,\r
            matches = re.exec(unescape(value)),\r
            all, type, keyValue, values, vLen, v;\r
            \r
        if (!matches || !matches[1]) {\r
            return; // non state\r
        }\r
        \r
        type = matches[1];\r
        value = matches[2];\r
        switch (type) {\r
            case 'e':\r
                return null;\r
            case 'n':\r
                return parseFloat(value);\r
            case 'd':\r
                return new Date(Date.parse(value));\r
            case 'b':\r
                return (value === '1');\r
            case 'a':\r
                all = [];\r
                if (value) {\r
                    values = value.split('^');\r
                    vLen   = values.length;\r
\r
                    for (v = 0; v < vLen; v++) {\r
                        value = values[v];\r
                        all.push(me.decodeValue(value));\r
                    }\r
                }\r
                return all;\r
           case 'o':\r
                all = {};\r
                if (value) {\r
                    values = value.split('^');\r
                    vLen   = values.length;\r
\r
                    for (v = 0; v < vLen; v++) {\r
                        value = values[v];\r
                        keyValue         = value.split('=');\r
                        all[keyValue[0]] = me.decodeValue(keyValue[1]);\r
                    }\r
                }\r
                return all;\r
           default:\r
                return value;\r
        }\r
    },\r
\r
    /**\r
     * Encodes a value including type information.  Decode with {@link #decodeValue}.\r
     * @param {Object} value The value to encode\r
     * @return {String} The encoded value\r
     */\r
    encodeValue : function(value){\r
        var flat = '',\r
            i = 0,\r
            enc, len, key;\r
            \r
        if (value == null) {\r
            return 'e:1';    \r
        } else if(typeof value === 'number') {\r
            enc = 'n:' + value;\r
        } else if(typeof value === 'boolean') {\r
            enc = 'b:' + (value ? '1' : '0');\r
        } else if(Ext.isDate(value)) {\r
            enc = 'd:' + value.toUTCString();\r
        } else if(Ext.isArray(value)) {\r
            for (len = value.length; i < len; i++) {\r
                flat += this.encodeValue(value[i]);\r
                if (i !== len - 1) {\r
                    flat += '^';\r
                }\r
            }\r
            enc = 'a:' + flat;\r
        } else if (typeof value === 'object') {\r
            for (key in value) {\r
                if (typeof value[key] !== 'function' && value[key] !== undefined) {\r
                    flat += key + '=' + this.encodeValue(value[key]) + '^';\r
                }\r
            }\r
            enc = 'o:' + flat.substring(0, flat.length-1);\r
        } else {\r
            enc = 's:' + value;\r
        }\r
        return escape(enc);\r
    }\r
});