Direct.js
上传用户:dawnssy
上传日期:2022-08-06
资源大小:9345k
文件大小:8k
源码类别:

JavaScript

开发平台:

JavaScript

  1. /*!  * Ext JS Library 3.1.0  * Copyright(c) 2006-2009 Ext JS, LLC  * licensing@extjs.com  * http://www.extjs.com/license  */ /**
  2.  * @class Ext.Direct
  3.  * @extends Ext.util.Observable
  4.  * <p><b><u>Overview</u></b></p>
  5.  * 
  6.  * <p>Ext.Direct aims to streamline communication between the client and server
  7.  * by providing a single interface that reduces the amount of common code
  8.  * typically required to validate data and handle returned data packets
  9.  * (reading data, error conditions, etc).</p>
  10.  *  
  11.  * <p>The Ext.direct namespace includes several classes for a closer integration
  12.  * with the server-side. The Ext.data namespace also includes classes for working
  13.  * with Ext.data.Stores which are backed by data from an Ext.Direct method.</p>
  14.  * 
  15.  * <p><b><u>Specification</u></b></p>
  16.  * 
  17.  * <p>For additional information consult the 
  18.  * <a href="http://extjs.com/products/extjs/direct.php">Ext.Direct Specification</a>.</p>
  19.  *   
  20.  * <p><b><u>Providers</u></b></p>
  21.  * 
  22.  * <p>Ext.Direct uses a provider architecture, where one or more providers are
  23.  * used to transport data to and from the server. There are several providers
  24.  * that exist in the core at the moment:</p><div class="mdetail-params"><ul>
  25.  * 
  26.  * <li>{@link Ext.direct.JsonProvider JsonProvider} for simple JSON operations</li>
  27.  * <li>{@link Ext.direct.PollingProvider PollingProvider} for repeated requests</li>
  28.  * <li>{@link Ext.direct.RemotingProvider RemotingProvider} exposes server side
  29.  * on the client.</li>
  30.  * </ul></div>
  31.  * 
  32.  * <p>A provider does not need to be invoked directly, providers are added via
  33.  * {@link Ext.Direct}.{@link Ext.Direct#add add}.</p>
  34.  * 
  35.  * <p><b><u>Router</u></b></p>
  36.  * 
  37.  * <p>Ext.Direct utilizes a "router" on the server to direct requests from the client
  38.  * to the appropriate server-side method. Because the Ext.Direct API is completely
  39.  * platform-agnostic, you could completely swap out a Java based server solution
  40.  * and replace it with one that uses C# without changing the client side JavaScript
  41.  * at all.</p>
  42.  * 
  43.  * <p><b><u>Server side events</u></b></p>
  44.  * 
  45.  * <p>Custom events from the server may be handled by the client by adding
  46.  * listeners, for example:</p>
  47.  * <pre><code>
  48. {"type":"event","name":"message","data":"Successfully polled at: 11:19:30 am"}
  49. // add a handler for a 'message' event sent by the server 
  50. Ext.Direct.on('message', function(e){
  51.     out.append(String.format('&lt;p>&lt;i>{0}&lt;/i>&lt;/p>', e.data));
  52.             out.el.scrollTo('t', 100000, true);
  53. });
  54.  * </code></pre>
  55.  * @singleton
  56.  */
  57. Ext.Direct = Ext.extend(Ext.util.Observable, {
  58.     /**
  59.      * Each event type implements a getData() method. The default event types are:
  60.      * <div class="mdetail-params"><ul>
  61.      * <li><b><tt>event</tt></b> : Ext.Direct.Event</li>
  62.      * <li><b><tt>exception</tt></b> : Ext.Direct.ExceptionEvent</li>
  63.      * <li><b><tt>rpc</tt></b> : Ext.Direct.RemotingEvent</li>
  64.      * </ul></div>
  65.      * @property eventTypes
  66.      * @type Object
  67.      */
  68.     /**
  69.      * Four types of possible exceptions which can occur:
  70.      * <div class="mdetail-params"><ul>
  71.      * <li><b><tt>Ext.Direct.exceptions.TRANSPORT</tt></b> : 'xhr'</li>
  72.      * <li><b><tt>Ext.Direct.exceptions.PARSE</tt></b> : 'parse'</li>
  73.      * <li><b><tt>Ext.Direct.exceptions.LOGIN</tt></b> : 'login'</li>
  74.      * <li><b><tt>Ext.Direct.exceptions.SERVER</tt></b> : 'exception'</li>
  75.      * </ul></div>
  76.      * @property exceptions
  77.      * @type Object
  78.      */
  79.     exceptions: {
  80.         TRANSPORT: 'xhr',
  81.         PARSE: 'parse',
  82.         LOGIN: 'login',
  83.         SERVER: 'exception'
  84.     },
  85.     
  86.     // private
  87.     constructor: function(){
  88.         this.addEvents(
  89.             /**
  90.              * @event event
  91.              * Fires after an event.
  92.              * @param {event} e The {@link Ext.Direct#eventTypes Ext.Direct.Event type} that occurred.
  93.              * @param {Ext.direct.Provider} provider The {@link Ext.direct.Provider Provider}.
  94.              */
  95.             'event',
  96.             /**
  97.              * @event exception
  98.              * Fires after an event exception.
  99.              * @param {event} e The {@link Ext.Direct#eventTypes Ext.Direct.Event type} that occurred.
  100.              */
  101.             'exception'
  102.         );
  103.         this.transactions = {};
  104.         this.providers = {};
  105.     },
  106.     /**
  107.      * Adds an Ext.Direct Provider and creates the proxy or stub methods to execute server-side methods.
  108.      * If the provider is not already connected, it will auto-connect.
  109.      * <pre><code>
  110. var pollProv = new Ext.direct.PollingProvider({
  111.     url: 'php/poll2.php'
  112. }); 
  113. Ext.Direct.addProvider(
  114.     {
  115.         "type":"remoting",       // create a {@link Ext.direct.RemotingProvider} 
  116.         "url":"php/router.php", // url to connect to the Ext.Direct server-side router.
  117.         "actions":{              // each property within the actions object represents a Class 
  118.             "TestAction":[       // array of methods within each server side Class   
  119.             {
  120.                 "name":"doEcho", // name of method
  121.                 "len":1
  122.             },{
  123.                 "name":"multiply",
  124.                 "len":1
  125.             },{
  126.                 "name":"doForm",
  127.                 "formHandler":true, // handle form on server with Ext.Direct.Transaction 
  128.                 "len":1
  129.             }]
  130.         },
  131.         "namespace":"myApplication",// namespace to create the Remoting Provider in
  132.     },{
  133.         type: 'polling', // create a {@link Ext.direct.PollingProvider} 
  134.         url:  'php/poll.php'
  135.     },
  136.     pollProv // reference to previously created instance
  137. );
  138.      * </code></pre>
  139.      * @param {Object/Array} provider Accepts either an Array of Provider descriptions (an instance
  140.      * or config object for a Provider) or any number of Provider descriptions as arguments.  Each
  141.      * Provider description instructs Ext.Direct how to create client-side stub methods.
  142.      */
  143.     addProvider : function(provider){        
  144.         var a = arguments;
  145.         if(a.length > 1){
  146.             for(var i = 0, len = a.length; i < len; i++){
  147.                 this.addProvider(a[i]);
  148.             }
  149.             return;
  150.         }
  151.         
  152.         // if provider has not already been instantiated
  153.         if(!provider.events){
  154.             provider = new Ext.Direct.PROVIDERS[provider.type](provider);
  155.         }
  156.         provider.id = provider.id || Ext.id();
  157.         this.providers[provider.id] = provider;
  158.         provider.on('data', this.onProviderData, this);
  159.         provider.on('exception', this.onProviderException, this);
  160.         if(!provider.isConnected()){
  161.             provider.connect();
  162.         }
  163.         return provider;
  164.     },
  165.     /**
  166.      * Retrieve a {@link Ext.direct.Provider provider} by the
  167.      * <b><tt>{@link Ext.direct.Provider#id id}</tt></b> specified when the provider is
  168.      * {@link #addProvider added}.
  169.      * @param {String} id Unique identifier assigned to the provider when calling {@link #addProvider} 
  170.      */
  171.     getProvider : function(id){
  172.         return this.providers[id];
  173.     },
  174.     removeProvider : function(id){
  175.         var provider = id.id ? id : this.providers[id.id];
  176.         provider.un('data', this.onProviderData, this);
  177.         provider.un('exception', this.onProviderException, this);
  178.         delete this.providers[provider.id];
  179.         return provider;
  180.     },
  181.     addTransaction: function(t){
  182.         this.transactions[t.tid] = t;
  183.         return t;
  184.     },
  185.     removeTransaction: function(t){
  186.         delete this.transactions[t.tid || t];
  187.         return t;
  188.     },
  189.     getTransaction: function(tid){
  190.         return this.transactions[tid.tid || tid];
  191.     },
  192.     onProviderData : function(provider, e){
  193.         if(Ext.isArray(e)){
  194.             for(var i = 0, len = e.length; i < len; i++){
  195.                 this.onProviderData(provider, e[i]);
  196.             }
  197.             return;
  198.         }
  199.         if(e.name && e.name != 'event' && e.name != 'exception'){
  200.             this.fireEvent(e.name, e);
  201.         }else if(e.type == 'exception'){
  202.             this.fireEvent('exception', e);
  203.         }
  204.         this.fireEvent('event', e, provider);
  205.     },
  206.     createEvent : function(response, extraProps){
  207.         return new Ext.Direct.eventTypes[response.type](Ext.apply(response, extraProps));
  208.     }
  209. });
  210. // overwrite impl. with static instance
  211. Ext.Direct = new Ext.Direct();
  212. Ext.Direct.TID = 1;
  213. Ext.Direct.PROVIDERS = {};