add extjs 6.0.1 sources

[extjs.git] / extjs / examples / kitchensink / classic / samples / controller / Direct.js

/**\r
 * This Controller handles initialization requests for the Ext Direct API\r
 * shared by different examples; in itself it is an example of dynamic\r
 * API manipulation.\r
 *\r
 * The primary reason to have a global Controller handling Ext Direct\r
 * is to keep Direct configuration centralized for the application,\r
 * as well as avoid binding transient ViewControlles to Provider\r
 * instances unless necessary.\r
 */\r
\r
Ext.define('KitchenSink.controller.Direct', {\r
    extend: 'Ext.app.Controller',\r
    \r
    requires: [\r
        'Ext.direct.RemotingProvider',\r
        'Ext.direct.Manager',\r
        'Ext.app.domain.Direct'\r
    ],\r
    \r
    id: 'Direct',\r
    \r
    config: {\r
        /**\r
         * @cfg {String} apiUrl\r
         * Default URL to use for Ext Direct service discovery requests.\r
         */\r
        apiUrl: 'data/direct/api.php',\r
        \r
        /**\r
         * @cfg {String} [varName="Ext.REMOTING_API"]\r
         * Default variable name to use for Ext Direct API declaration.\r
         */\r
        varName: 'Ext.REMOTING_API',\r
        \r
        listen: {\r
            controller: {\r
                // We're listening to these events from any Controller.\r
                // That includes ViewControllers, too.\r
                '*': {\r
                    directconnect: 'onDirectConnect',\r
                    directdisconnect: 'onDirectDisconnect',\r
                    directgetprovider: 'onDirectGetProvider'\r
                }\r
            }\r
        }\r
    },\r
    \r
    init: function() {\r
        this.providers = {};\r
    },\r
    \r
    destroy: function() {\r
        var providers = this.providers,\r
            url;\r
        \r
        for (url in providers) {\r
            providers[url].disconnect();\r
            providers[url] = null;\r
        }\r
        \r
        this.callParent();\r
    },\r
    \r
    /**\r
     * Request remote API from the server, and create a new Direct provider\r
     * when API declaration is received; alternatively create a new provider\r
     * if the caller provided a configuration blob for it.\r
     *\r
     * @param {Object} options Options to configure Provider request, and to\r
     * return to the caller in synchronous fashion.\r
     */\r
    onDirectConnect: function(options) {\r
        var me = this,\r
            providerCfg = options.providerCfg,\r
            url, provider, request;\r
        \r
        url = (providerCfg && providerCfg.url) || options.apiUrl  || me.getApiUrl();\r
        \r
        // The provider at that URI may have been initialized already\r
        provider = me.providers[url];\r
        \r
        // ViewController may not have specific API URL defined in its\r
        // configuration, which means we need to return the URL used.\r
        options.url = url;\r
        \r
        if (provider) {\r
            provider.connect();\r
            \r
            options.success = true;\r
            \r
            return;\r
        }\r
        \r
        request = Ext.apply({\r
            url: url,\r
            varName: options.varName || me.getVarName()\r
        }, providerCfg);\r
        \r
        // We may be passed a provider configuration object that contains\r
        // sufficient information to create a Provider instance. In that\r
        // case, loadProvider will add it and fire the callback immediately.\r
        Ext.direct.Manager.loadProvider(request, me.providerCallback, me);\r
    },\r
    \r
    /**\r
     * Request to disconnect a Direct provider. This event is fired\r
     * by ViewControllers being destroyed, to notify Direct controller\r
     * that they no longer need the specified provider.\r
     *\r
     * @param {String} url Service URL for a provider\r
     */\r
    onDirectDisconnect: function(url) {\r
        var provider = this.providers[url];\r
        \r
        if (provider) {\r
            provider.disconnect();\r
        }\r
    },\r
    \r
    /**\r
     * Return a provider by its URL to the caller.\r
     */\r
    onDirectGetProvider: function(options) {\r
        options.provider = this.providers[options.url];\r
    },\r
    \r
    providerCallback: function(apiUrl, provider) {\r
        var me = this;\r
        \r
        // Error message can be returned instead of provider\r
        if (Ext.isString(provider)) {\r
            me.fireEvent('providerfail', apiUrl, provider);\r
            \r
            return;\r
        }\r
        \r
        // We don't need to connect the provider as it was\r
        // connected automatically by the Direct Manager\r
        me.providers[apiUrl] = provider;\r
        \r
        me.fireEvent('providerinit', apiUrl);\r
    }\r
});\r