add extjs 6.0.1 sources

[extjs.git] / extjs / classic / classic / src / util / Cookies.js

/**\r
 * Utility class for setting/reading values from browser cookies.\r
 * Values can be written using the {@link #set} method.\r
 * Values can be read using the {@link #get} method.\r
 * A cookie can be invalidated on the client machine using the {@link #clear} method.\r
 */\r
Ext.define('Ext.util.Cookies', {\r
    singleton: true,\r
    \r
    /**\r
     * Creates a cookie with the specified name and value. Additional settings for the cookie may be optionally specified\r
     * (for example: expiration, access restriction, SSL).\r
     * @param {String} name The name of the cookie to set.\r
     * @param {Object} value The value to set for the cookie.\r
     * @param {Object} [expires] Specify an expiration date the cookie is to persist until. Note that the specified Date\r
     * object will be converted to Greenwich Mean Time (GMT).\r
     * @param {String} [path] Setting a path on the cookie restricts access to pages that match that path. Defaults to all\r
     * pages ('/').\r
     * @param {String} [domain] Setting a domain restricts access to pages on a given domain (typically used to allow\r
     * cookie access across subdomains). For example, "sencha.com" will create a cookie that can be accessed from any\r
     * subdomain of sencha.com, including www.sencha.com, support.sencha.com, etc.\r
     * @param {Boolean} [secure] Specify true to indicate that the cookie should only be accessible via SSL on a page\r
     * using the HTTPS protocol. Defaults to false. Note that this will only work if the page calling this code uses the\r
     * HTTPS protocol, otherwise the cookie will be created with default options.\r
     */\r
    set : function(name, value){\r
        var argv = arguments,\r
            argc = arguments.length,\r
            expires = (argc > 2) ? argv[2] : null,\r
            path = (argc > 3) ? argv[3] : '/',\r
            domain = (argc > 4) ? argv[4] : null,\r
            secure = (argc > 5) ? argv[5] : false;\r
            \r
        document.cookie = name + "=" +\r
            escape(value) +\r
            ((expires === null) ? "" : ("; expires=" + expires.toUTCString())) +\r
            ((path === null) ? "" : ("; path=" + path)) +\r
            ((domain === null) ? "" : ("; domain=" + domain)) +\r
            ((secure === true) ? "; secure" : "");\r
    },\r
\r
    /**\r
     * Retrieves cookies that are accessible by the current page. If a cookie does not exist, `get()` returns null. The\r
     * following example retrieves the cookie called "valid" and stores the String value in the variable validStatus.\r
     *\r
     *     var validStatus = Ext.util.Cookies.get("valid");\r
     *\r
     * @param {String} name The name of the cookie to get\r
     * @return {Object} Returns the cookie value for the specified name;\r
     * null if the cookie name does not exist.\r
     */\r
    get : function(name) {\r
        var parts = document.cookie.split('; '),\r
            len = parts.length,\r
            item, i, ret;\r
\r
        // In modern browsers, a cookie with an empty string will be stored:\r
        // MyName=\r
        // In older versions of IE, it will be stored as:\r
        // MyName\r
        // So here we iterate over all the parts in an attempt to match the key.\r
        for (i = 0; i < len; ++i) {\r
            item = parts[i].split('=');\r
            if (item[0] === name) {\r
                ret = item[1];\r
                return ret ? unescape(ret) : '';\r
            }\r
        }\r
        return null;\r
    },\r
\r
    /**\r
     * Removes a cookie with the provided name from the browser\r
     * if found by setting its expiration date to sometime in the past.\r
     * @param {String} name The name of the cookie to remove\r
     * @param {String} [path] The path for the cookie.\r
     * This must be included if you included a path while setting the cookie.\r
     */\r
    clear : function(name, path){\r
        if (this.get(name)) {\r
            path = path || '/';\r
            document.cookie = name + '=' + '; expires=Thu, 01-Jan-1970 00:00:01 GMT; path=' + path;\r
        }\r
    }\r
});\r