Bienvenue sur PostGIS.fr

Bienvenue sur PostGIS.fr , le site de la communauté des utilisateurs francophones de PostGIS.

PostGIS ajoute le support d'objets géographique à la base de données PostgreSQL. En effet, PostGIS "spatialise" le serverur PostgreSQL, ce qui permet de l'utiliser comme une base de données SIG.

Maintenu à jour, en fonction de nos disponibilités et des diverses sorties des outils que nous testons, nous vous proposons l'ensemble de nos travaux publiés en langue française.

source: trunk/workshop-routing-foss4g/web/ext/pkgs/direct-debug.js @ 76

Revision 76, 40.0 KB checked in by djay, 12 years ago (diff)

Ajout du répertoire web

  • Property svn:executable set to *
Line 
1/*!
2 * Ext JS Library 3.4.0
3 * Copyright(c) 2006-2011 Sencha Inc.
4 * licensing@sencha.com
5 * http://www.sencha.com/license
6 */
7/**
8 * @class Ext.data.DirectProxy
9 * @extends Ext.data.DataProxy
10 */
11Ext.data.DirectProxy = function(config){
12    Ext.apply(this, config);
13    if(typeof this.paramOrder == 'string'){
14        this.paramOrder = this.paramOrder.split(/[\s,|]/);
15    }
16    Ext.data.DirectProxy.superclass.constructor.call(this, config);
17};
18
19Ext.extend(Ext.data.DirectProxy, Ext.data.DataProxy, {
20    /**
21     * @cfg {Array/String} paramOrder Defaults to <tt>undefined</tt>. A list of params to be executed
22     * server side.  Specify the params in the order in which they must be executed on the server-side
23     * as either (1) an Array of String values, or (2) a String of params delimited by either whitespace,
24     * comma, or pipe. For example,
25     * any of the following would be acceptable:<pre><code>
26paramOrder: ['param1','param2','param3']
27paramOrder: 'param1 param2 param3'
28paramOrder: 'param1,param2,param3'
29paramOrder: 'param1|param2|param'
30     </code></pre>
31     */
32    paramOrder: undefined,
33
34    /**
35     * @cfg {Boolean} paramsAsHash
36     * Send parameters as a collection of named arguments (defaults to <tt>true</tt>). Providing a
37     * <tt>{@link #paramOrder}</tt> nullifies this configuration.
38     */
39    paramsAsHash: true,
40
41    /**
42     * @cfg {Function} directFn
43     * Function to call when executing a request.  directFn is a simple alternative to defining the api configuration-parameter
44     * for Store's which will not implement a full CRUD api.
45     */
46    directFn : undefined,
47
48    /**
49     * DirectProxy implementation of {@link Ext.data.DataProxy#doRequest}
50     * @param {String} action The crud action type (create, read, update, destroy)
51     * @param {Ext.data.Record/Ext.data.Record[]} rs If action is load, rs will be null
52     * @param {Object} params An object containing properties which are to be used as HTTP parameters
53     * for the request to the remote server.
54     * @param {Ext.data.DataReader} reader The Reader object which converts the data
55     * object into a block of Ext.data.Records.
56     * @param {Function} callback
57     * <div class="sub-desc"><p>A function to be called after the request.
58     * The <tt>callback</tt> is passed the following arguments:<ul>
59     * <li><tt>r</tt> : Ext.data.Record[] The block of Ext.data.Records.</li>
60     * <li><tt>options</tt>: Options object from the action request</li>
61     * <li><tt>success</tt>: Boolean success indicator</li></ul></p></div>
62     * @param {Object} scope The scope (<code>this</code> reference) in which the callback function is executed. Defaults to the browser window.
63     * @param {Object} arg An optional argument which is passed to the callback as its second parameter.
64     * @protected
65     */
66    doRequest : function(action, rs, params, reader, callback, scope, options) {
67        var args = [],
68            directFn = this.api[action] || this.directFn;
69
70        switch (action) {
71            case Ext.data.Api.actions.create:
72                args.push(params.jsonData);             // <-- create(Hash)
73                break;
74            case Ext.data.Api.actions.read:
75                // If the method has no parameters, ignore the paramOrder/paramsAsHash.
76                if(directFn.directCfg.method.len > 0){
77                    if(this.paramOrder){
78                        for(var i = 0, len = this.paramOrder.length; i < len; i++){
79                            args.push(params[this.paramOrder[i]]);
80                        }
81                    }else if(this.paramsAsHash){
82                        args.push(params);
83                    }
84                }
85                break;
86            case Ext.data.Api.actions.update:
87                args.push(params.jsonData);        // <-- update(Hash/Hash[])
88                break;
89            case Ext.data.Api.actions.destroy:
90                args.push(params.jsonData);        // <-- destroy(Int/Int[])
91                break;
92        }
93
94        var trans = {
95            params : params || {},
96            request: {
97                callback : callback,
98                scope : scope,
99                arg : options
100            },
101            reader: reader
102        };
103
104        args.push(this.createCallback(action, rs, trans), this);
105        directFn.apply(window, args);
106    },
107
108    // private
109    createCallback : function(action, rs, trans) {
110        var me = this;
111        return function(result, res) {
112            if (!res.status) {
113                // @deprecated fire loadexception
114                if (action === Ext.data.Api.actions.read) {
115                    me.fireEvent("loadexception", me, trans, res, null);
116                }
117                me.fireEvent('exception', me, 'remote', action, trans, res, null);
118                trans.request.callback.call(trans.request.scope, null, trans.request.arg, false);
119                return;
120            }
121            if (action === Ext.data.Api.actions.read) {
122                me.onRead(action, trans, result, res);
123            } else {
124                me.onWrite(action, trans, result, res, rs);
125            }
126        };
127    },
128
129    /**
130     * Callback for read actions
131     * @param {String} action [Ext.data.Api.actions.create|read|update|destroy]
132     * @param {Object} trans The request transaction object
133     * @param {Object} result Data object picked out of the server-response.
134     * @param {Object} res The server response
135     * @protected
136     */
137    onRead : function(action, trans, result, res) {
138        var records;
139        try {
140            records = trans.reader.readRecords(result);
141        }
142        catch (ex) {
143            // @deprecated: Fire old loadexception for backwards-compat.
144            this.fireEvent("loadexception", this, trans, res, ex);
145
146            this.fireEvent('exception', this, 'response', action, trans, res, ex);
147            trans.request.callback.call(trans.request.scope, null, trans.request.arg, false);
148            return;
149        }
150        this.fireEvent("load", this, res, trans.request.arg);
151        trans.request.callback.call(trans.request.scope, records, trans.request.arg, true);
152    },
153    /**
154     * Callback for write actions
155     * @param {String} action [{@link Ext.data.Api#actions create|read|update|destroy}]
156     * @param {Object} trans The request transaction object
157     * @param {Object} result Data object picked out of the server-response.
158     * @param {Object} res The server response
159     * @param {Ext.data.Record/[Ext.data.Record]} rs The Store resultset associated with the action.
160     * @protected
161     */
162    onWrite : function(action, trans, result, res, rs) {
163        var data = trans.reader.extractData(trans.reader.getRoot(result), false);
164        var success = trans.reader.getSuccess(result);
165        success = (success !== false);
166        if (success){
167            this.fireEvent("write", this, action, data, res, rs, trans.request.arg);
168        }else{
169            this.fireEvent('exception', this, 'remote', action, trans, result, rs);
170        }
171        trans.request.callback.call(trans.request.scope, data, res, success);
172    }
173});
174/**
175 * @class Ext.data.DirectStore
176 * @extends Ext.data.Store
177 * <p>Small helper class to create an {@link Ext.data.Store} configured with an
178 * {@link Ext.data.DirectProxy} and {@link Ext.data.JsonReader} to make interacting
179 * with an {@link Ext.Direct} Server-side {@link Ext.direct.Provider Provider} easier.
180 * To create a different proxy/reader combination create a basic {@link Ext.data.Store}
181 * configured as needed.</p>
182 *
183 * <p><b>*Note:</b> Although they are not listed, this class inherits all of the config options of:</p>
184 * <div><ul class="mdetail-params">
185 * <li><b>{@link Ext.data.Store Store}</b></li>
186 * <div class="sub-desc"><ul class="mdetail-params">
187 *
188 * </ul></div>
189 * <li><b>{@link Ext.data.JsonReader JsonReader}</b></li>
190 * <div class="sub-desc"><ul class="mdetail-params">
191 * <li><tt><b>{@link Ext.data.JsonReader#root root}</b></tt></li>
192 * <li><tt><b>{@link Ext.data.JsonReader#idProperty idProperty}</b></tt></li>
193 * <li><tt><b>{@link Ext.data.JsonReader#totalProperty totalProperty}</b></tt></li>
194 * </ul></div>
195 *
196 * <li><b>{@link Ext.data.DirectProxy DirectProxy}</b></li>
197 * <div class="sub-desc"><ul class="mdetail-params">
198 * <li><tt><b>{@link Ext.data.DirectProxy#directFn directFn}</b></tt></li>
199 * <li><tt><b>{@link Ext.data.DirectProxy#paramOrder paramOrder}</b></tt></li>
200 * <li><tt><b>{@link Ext.data.DirectProxy#paramsAsHash paramsAsHash}</b></tt></li>
201 * </ul></div>
202 * </ul></div>
203 *
204 * @xtype directstore
205 *
206 * @constructor
207 * @param {Object} config
208 */
209Ext.data.DirectStore = Ext.extend(Ext.data.Store, {
210    constructor : function(config){
211        // each transaction upon a singe record will generate a distinct Direct transaction since Direct queues them into one Ajax request.
212        var c = Ext.apply({}, {
213            batchTransactions: false
214        }, config);
215        Ext.data.DirectStore.superclass.constructor.call(this, Ext.apply(c, {
216            proxy: Ext.isDefined(c.proxy) ? c.proxy : new Ext.data.DirectProxy(Ext.copyTo({}, c, 'paramOrder,paramsAsHash,directFn,api')),
217            reader: (!Ext.isDefined(c.reader) && c.fields) ? new Ext.data.JsonReader(Ext.copyTo({}, c, 'totalProperty,root,idProperty'), c.fields) : c.reader
218        }));
219    }
220});
221Ext.reg('directstore', Ext.data.DirectStore);
222/**
223 * @class Ext.Direct
224 * @extends Ext.util.Observable
225 * <p><b><u>Overview</u></b></p>
226 *
227 * <p>Ext.Direct aims to streamline communication between the client and server
228 * by providing a single interface that reduces the amount of common code
229 * typically required to validate data and handle returned data packets
230 * (reading data, error conditions, etc).</p>
231 *
232 * <p>The Ext.direct namespace includes several classes for a closer integration
233 * with the server-side. The Ext.data namespace also includes classes for working
234 * with Ext.data.Stores which are backed by data from an Ext.Direct method.</p>
235 *
236 * <p><b><u>Specification</u></b></p>
237 *
238 * <p>For additional information consult the
239 * <a href="http://extjs.com/products/extjs/direct.php">Ext.Direct Specification</a>.</p>
240 *
241 * <p><b><u>Providers</u></b></p>
242 *
243 * <p>Ext.Direct uses a provider architecture, where one or more providers are
244 * used to transport data to and from the server. There are several providers
245 * that exist in the core at the moment:</p><div class="mdetail-params"><ul>
246 *
247 * <li>{@link Ext.direct.JsonProvider JsonProvider} for simple JSON operations</li>
248 * <li>{@link Ext.direct.PollingProvider PollingProvider} for repeated requests</li>
249 * <li>{@link Ext.direct.RemotingProvider RemotingProvider} exposes server side
250 * on the client.</li>
251 * </ul></div>
252 *
253 * <p>A provider does not need to be invoked directly, providers are added via
254 * {@link Ext.Direct}.{@link Ext.Direct#add add}.</p>
255 *
256 * <p><b><u>Router</u></b></p>
257 *
258 * <p>Ext.Direct utilizes a "router" on the server to direct requests from the client
259 * to the appropriate server-side method. Because the Ext.Direct API is completely
260 * platform-agnostic, you could completely swap out a Java based server solution
261 * and replace it with one that uses C# without changing the client side JavaScript
262 * at all.</p>
263 *
264 * <p><b><u>Server side events</u></b></p>
265 *
266 * <p>Custom events from the server may be handled by the client by adding
267 * listeners, for example:</p>
268 * <pre><code>
269{"type":"event","name":"message","data":"Successfully polled at: 11:19:30 am"}
270
271// add a handler for a 'message' event sent by the server
272Ext.Direct.on('message', function(e){
273    out.append(String.format('&lt;p>&lt;i>{0}&lt;/i>&lt;/p>', e.data));
274            out.el.scrollTo('t', 100000, true);
275});
276 * </code></pre>
277 * @singleton
278 */
279Ext.Direct = Ext.extend(Ext.util.Observable, {
280    /**
281     * Each event type implements a getData() method. The default event types are:
282     * <div class="mdetail-params"><ul>
283     * <li><b><tt>event</tt></b> : Ext.Direct.Event</li>
284     * <li><b><tt>exception</tt></b> : Ext.Direct.ExceptionEvent</li>
285     * <li><b><tt>rpc</tt></b> : Ext.Direct.RemotingEvent</li>
286     * </ul></div>
287     * @property eventTypes
288     * @type Object
289     */
290
291    /**
292     * Four types of possible exceptions which can occur:
293     * <div class="mdetail-params"><ul>
294     * <li><b><tt>Ext.Direct.exceptions.TRANSPORT</tt></b> : 'xhr'</li>
295     * <li><b><tt>Ext.Direct.exceptions.PARSE</tt></b> : 'parse'</li>
296     * <li><b><tt>Ext.Direct.exceptions.LOGIN</tt></b> : 'login'</li>
297     * <li><b><tt>Ext.Direct.exceptions.SERVER</tt></b> : 'exception'</li>
298     * </ul></div>
299     * @property exceptions
300     * @type Object
301     */
302    exceptions: {
303        TRANSPORT: 'xhr',
304        PARSE: 'parse',
305        LOGIN: 'login',
306        SERVER: 'exception'
307    },
308
309    // private
310    constructor: function(){
311        this.addEvents(
312            /**
313             * @event event
314             * Fires after an event.
315             * @param {event} e The {@link Ext.Direct#eventTypes Ext.Direct.Event type} that occurred.
316             * @param {Ext.direct.Provider} provider The {@link Ext.direct.Provider Provider}.
317             */
318            'event',
319            /**
320             * @event exception
321             * Fires after an event exception.
322             * @param {event} e The {@link Ext.Direct#eventTypes Ext.Direct.Event type} that occurred.
323             */
324            'exception'
325        );
326        this.transactions = {};
327        this.providers = {};
328    },
329
330    /**
331     * Adds an Ext.Direct Provider and creates the proxy or stub methods to execute server-side methods.
332     * If the provider is not already connected, it will auto-connect.
333     * <pre><code>
334var pollProv = new Ext.direct.PollingProvider({
335    url: 'php/poll2.php'
336});
337
338Ext.Direct.addProvider(
339    {
340        "type":"remoting",       // create a {@link Ext.direct.RemotingProvider}
341        "url":"php\/router.php", // url to connect to the Ext.Direct server-side router.
342        "actions":{              // each property within the actions object represents a Class
343            "TestAction":[       // array of methods within each server side Class
344            {
345                "name":"doEcho", // name of method
346                "len":1
347            },{
348                "name":"multiply",
349                "len":1
350            },{
351                "name":"doForm",
352                "formHandler":true, // handle form on server with Ext.Direct.Transaction
353                "len":1
354            }]
355        },
356        "namespace":"myApplication",// namespace to create the Remoting Provider in
357    },{
358        type: 'polling', // create a {@link Ext.direct.PollingProvider}
359        url:  'php/poll.php'
360    },
361    pollProv // reference to previously created instance
362);
363     * </code></pre>
364     * @param {Object/Array} provider Accepts either an Array of Provider descriptions (an instance
365     * or config object for a Provider) or any number of Provider descriptions as arguments.  Each
366     * Provider description instructs Ext.Direct how to create client-side stub methods.
367     */
368    addProvider : function(provider){
369        var a = arguments;
370        if(a.length > 1){
371            for(var i = 0, len = a.length; i < len; i++){
372                this.addProvider(a[i]);
373            }
374            return;
375        }
376
377        // if provider has not already been instantiated
378        if(!provider.events){
379            provider = new Ext.Direct.PROVIDERS[provider.type](provider);
380        }
381        provider.id = provider.id || Ext.id();
382        this.providers[provider.id] = provider;
383
384        provider.on('data', this.onProviderData, this);
385        provider.on('exception', this.onProviderException, this);
386
387
388        if(!provider.isConnected()){
389            provider.connect();
390        }
391
392        return provider;
393    },
394
395    /**
396     * Retrieve a {@link Ext.direct.Provider provider} by the
397     * <b><tt>{@link Ext.direct.Provider#id id}</tt></b> specified when the provider is
398     * {@link #addProvider added}.
399     * @param {String} id Unique identifier assigned to the provider when calling {@link #addProvider}
400     */
401    getProvider : function(id){
402        return this.providers[id];
403    },
404
405    removeProvider : function(id){
406        var provider = id.id ? id : this.providers[id];
407        provider.un('data', this.onProviderData, this);
408        provider.un('exception', this.onProviderException, this);
409        delete this.providers[provider.id];
410        return provider;
411    },
412
413    addTransaction: function(t){
414        this.transactions[t.tid] = t;
415        return t;
416    },
417
418    removeTransaction: function(t){
419        delete this.transactions[t.tid || t];
420        return t;
421    },
422
423    getTransaction: function(tid){
424        return this.transactions[tid.tid || tid];
425    },
426
427    onProviderData : function(provider, e){
428        if(Ext.isArray(e)){
429            for(var i = 0, len = e.length; i < len; i++){
430                this.onProviderData(provider, e[i]);
431            }
432            return;
433        }
434        if(e.name && e.name != 'event' && e.name != 'exception'){
435            this.fireEvent(e.name, e);
436        }else if(e.type == 'exception'){
437            this.fireEvent('exception', e);
438        }
439        this.fireEvent('event', e, provider);
440    },
441
442    createEvent : function(response, extraProps){
443        return new Ext.Direct.eventTypes[response.type](Ext.apply(response, extraProps));
444    }
445});
446// overwrite impl. with static instance
447Ext.Direct = new Ext.Direct();
448
449Ext.Direct.TID = 1;
450Ext.Direct.PROVIDERS = {};/**
451 * @class Ext.Direct.Transaction
452 * @extends Object
453 * <p>Supporting Class for Ext.Direct (not intended to be used directly).</p>
454 * @constructor
455 * @param {Object} config
456 */
457Ext.Direct.Transaction = function(config){
458    Ext.apply(this, config);
459    this.tid = ++Ext.Direct.TID;
460    this.retryCount = 0;
461};
462Ext.Direct.Transaction.prototype = {
463    send: function(){
464        this.provider.queueTransaction(this);
465    },
466
467    retry: function(){
468        this.retryCount++;
469        this.send();
470    },
471
472    getProvider: function(){
473        return this.provider;
474    }
475};Ext.Direct.Event = function(config){
476    Ext.apply(this, config);
477};
478
479Ext.Direct.Event.prototype = {
480    status: true,
481    getData: function(){
482        return this.data;
483    }
484};
485
486Ext.Direct.RemotingEvent = Ext.extend(Ext.Direct.Event, {
487    type: 'rpc',
488    getTransaction: function(){
489        return this.transaction || Ext.Direct.getTransaction(this.tid);
490    }
491});
492
493Ext.Direct.ExceptionEvent = Ext.extend(Ext.Direct.RemotingEvent, {
494    status: false,
495    type: 'exception'
496});
497
498Ext.Direct.eventTypes = {
499    'rpc':  Ext.Direct.RemotingEvent,
500    'event':  Ext.Direct.Event,
501    'exception':  Ext.Direct.ExceptionEvent
502};
503/**
504 * @class Ext.direct.Provider
505 * @extends Ext.util.Observable
506 * <p>Ext.direct.Provider is an abstract class meant to be extended.</p>
507 *
508 * <p>For example ExtJs implements the following subclasses:</p>
509 * <pre><code>
510Provider
511|
512+---{@link Ext.direct.JsonProvider JsonProvider}
513    |
514    +---{@link Ext.direct.PollingProvider PollingProvider}   
515    |
516    +---{@link Ext.direct.RemotingProvider RemotingProvider}   
517 * </code></pre>
518 * @abstract
519 */
520Ext.direct.Provider = Ext.extend(Ext.util.Observable, {   
521    /**
522     * @cfg {String} id
523     * The unique id of the provider (defaults to an {@link Ext#id auto-assigned id}).
524     * You should assign an id if you need to be able to access the provider later and you do
525     * not have an object reference available, for example:
526     * <pre><code>
527Ext.Direct.addProvider(
528    {
529        type: 'polling',
530        url:  'php/poll.php',
531        id:   'poll-provider'
532    }
533);
534     
535var p = {@link Ext.Direct Ext.Direct}.{@link Ext.Direct#getProvider getProvider}('poll-provider');
536p.disconnect();
537     * </code></pre>
538     */
539       
540    /**
541     * @cfg {Number} priority
542     * Priority of the request. Lower is higher priority, <tt>0</tt> means "duplex" (always on).
543     * All Providers default to <tt>1</tt> except for PollingProvider which defaults to <tt>3</tt>.
544     */   
545    priority: 1,
546
547    /**
548     * @cfg {String} type
549     * <b>Required</b>, <tt>undefined</tt> by default.  The <tt>type</tt> of provider specified
550     * to {@link Ext.Direct Ext.Direct}.{@link Ext.Direct#addProvider addProvider} to create a
551     * new Provider. Acceptable values by default are:<div class="mdetail-params"><ul>
552     * <li><b><tt>polling</tt></b> : {@link Ext.direct.PollingProvider PollingProvider}</li>
553     * <li><b><tt>remoting</tt></b> : {@link Ext.direct.RemotingProvider RemotingProvider}</li>
554     * </ul></div>
555     */   
556 
557    // private
558    constructor : function(config){
559        Ext.apply(this, config);
560        this.addEvents(
561            /**
562             * @event connect
563             * Fires when the Provider connects to the server-side
564             * @param {Ext.direct.Provider} provider The {@link Ext.direct.Provider Provider}.
565             */           
566            'connect',
567            /**
568             * @event disconnect
569             * Fires when the Provider disconnects from the server-side
570             * @param {Ext.direct.Provider} provider The {@link Ext.direct.Provider Provider}.
571             */           
572            'disconnect',
573            /**
574             * @event data
575             * Fires when the Provider receives data from the server-side
576             * @param {Ext.direct.Provider} provider The {@link Ext.direct.Provider Provider}.
577             * @param {event} e The {@link Ext.Direct#eventTypes Ext.Direct.Event type} that occurred.
578             */           
579            'data',
580            /**
581             * @event exception
582             * Fires when the Provider receives an exception from the server-side
583             */                       
584            'exception'
585        );
586        Ext.direct.Provider.superclass.constructor.call(this, config);
587    },
588
589    /**
590     * Returns whether or not the server-side is currently connected.
591     * Abstract method for subclasses to implement.
592     */
593    isConnected: function(){
594        return false;
595    },
596
597    /**
598     * Abstract methods for subclasses to implement.
599     */
600    connect: Ext.emptyFn,
601   
602    /**
603     * Abstract methods for subclasses to implement.
604     */
605    disconnect: Ext.emptyFn
606});
607/**
608 * @class Ext.direct.JsonProvider
609 * @extends Ext.direct.Provider
610 */
611Ext.direct.JsonProvider = Ext.extend(Ext.direct.Provider, {
612    parseResponse: function(xhr){
613        if(!Ext.isEmpty(xhr.responseText)){
614            if(typeof xhr.responseText == 'object'){
615                return xhr.responseText;
616            }
617            return Ext.decode(xhr.responseText);
618        }
619        return null;
620    },
621
622    getEvents: function(xhr){
623        var data = null;
624        try{
625            data = this.parseResponse(xhr);
626        }catch(e){
627            var event = new Ext.Direct.ExceptionEvent({
628                data: e,
629                xhr: xhr,
630                code: Ext.Direct.exceptions.PARSE,
631                message: 'Error parsing json response: \n\n ' + data
632            });
633            return [event];
634        }
635        var events = [];
636        if(Ext.isArray(data)){
637            for(var i = 0, len = data.length; i < len; i++){
638                events.push(Ext.Direct.createEvent(data[i]));
639            }
640        }else{
641            events.push(Ext.Direct.createEvent(data));
642        }
643        return events;
644    }
645});/**
646 * @class Ext.direct.PollingProvider
647 * @extends Ext.direct.JsonProvider
648 *
649 * <p>Provides for repetitive polling of the server at distinct {@link #interval intervals}.
650 * The initial request for data originates from the client, and then is responded to by the
651 * server.</p>
652 *
653 * <p>All configurations for the PollingProvider should be generated by the server-side
654 * API portion of the Ext.Direct stack.</p>
655 *
656 * <p>An instance of PollingProvider may be created directly via the new keyword or by simply
657 * specifying <tt>type = 'polling'</tt>.  For example:</p>
658 * <pre><code>
659var pollA = new Ext.direct.PollingProvider({
660    type:'polling',
661    url: 'php/pollA.php',
662});
663Ext.Direct.addProvider(pollA);
664pollA.disconnect();
665
666Ext.Direct.addProvider(
667    {
668        type:'polling',
669        url: 'php/pollB.php',
670        id: 'pollB-provider'
671    }
672);
673var pollB = Ext.Direct.getProvider('pollB-provider');
674 * </code></pre>
675 */
676Ext.direct.PollingProvider = Ext.extend(Ext.direct.JsonProvider, {
677    /**
678     * @cfg {Number} priority
679     * Priority of the request (defaults to <tt>3</tt>). See {@link Ext.direct.Provider#priority}.
680     */
681    // override default priority
682    priority: 3,
683   
684    /**
685     * @cfg {Number} interval
686     * How often to poll the server-side in milliseconds (defaults to <tt>3000</tt> - every
687     * 3 seconds).
688     */
689    interval: 3000,
690
691    /**
692     * @cfg {Object} baseParams An object containing properties which are to be sent as parameters
693     * on every polling request
694     */
695   
696    /**
697     * @cfg {String/Function} url
698     * The url which the PollingProvider should contact with each request. This can also be
699     * an imported Ext.Direct method which will accept the baseParams as its only argument.
700     */
701
702    // private
703    constructor : function(config){
704        Ext.direct.PollingProvider.superclass.constructor.call(this, config);
705        this.addEvents(
706            /**
707             * @event beforepoll
708             * Fired immediately before a poll takes place, an event handler can return false
709             * in order to cancel the poll.
710             * @param {Ext.direct.PollingProvider}
711             */
712            'beforepoll',           
713            /**
714             * @event poll
715             * This event has not yet been implemented.
716             * @param {Ext.direct.PollingProvider}
717             */
718            'poll'
719        );
720    },
721
722    // inherited
723    isConnected: function(){
724        return !!this.pollTask;
725    },
726
727    /**
728     * Connect to the server-side and begin the polling process. To handle each
729     * response subscribe to the data event.
730     */
731    connect: function(){
732        if(this.url && !this.pollTask){
733            this.pollTask = Ext.TaskMgr.start({
734                run: function(){
735                    if(this.fireEvent('beforepoll', this) !== false){
736                        if(typeof this.url == 'function'){
737                            this.url(this.baseParams);
738                        }else{
739                            Ext.Ajax.request({
740                                url: this.url,
741                                callback: this.onData,
742                                scope: this,
743                                params: this.baseParams
744                            });
745                        }
746                    }
747                },
748                interval: this.interval,
749                scope: this
750            });
751            this.fireEvent('connect', this);
752        }else if(!this.url){
753            throw 'Error initializing PollingProvider, no url configured.';
754        }
755    },
756
757    /**
758     * Disconnect from the server-side and stop the polling process. The disconnect
759     * event will be fired on a successful disconnect.
760     */
761    disconnect: function(){
762        if(this.pollTask){
763            Ext.TaskMgr.stop(this.pollTask);
764            delete this.pollTask;
765            this.fireEvent('disconnect', this);
766        }
767    },
768
769    // private
770    onData: function(opt, success, xhr){
771        if(success){
772            var events = this.getEvents(xhr);
773            for(var i = 0, len = events.length; i < len; i++){
774                var e = events[i];
775                this.fireEvent('data', this, e);
776            }
777        }else{
778            var e = new Ext.Direct.ExceptionEvent({
779                data: e,
780                code: Ext.Direct.exceptions.TRANSPORT,
781                message: 'Unable to connect to the server.',
782                xhr: xhr
783            });
784            this.fireEvent('data', this, e);
785        }
786    }
787});
788
789Ext.Direct.PROVIDERS['polling'] = Ext.direct.PollingProvider;/**
790 * @class Ext.direct.RemotingProvider
791 * @extends Ext.direct.JsonProvider
792 *
793 * <p>The {@link Ext.direct.RemotingProvider RemotingProvider} exposes access to
794 * server side methods on the client (a remote procedure call (RPC) type of
795 * connection where the client can initiate a procedure on the server).</p>
796 *
797 * <p>This allows for code to be organized in a fashion that is maintainable,
798 * while providing a clear path between client and server, something that is
799 * not always apparent when using URLs.</p>
800 *
801 * <p>To accomplish this the server-side needs to describe what classes and methods
802 * are available on the client-side. This configuration will typically be
803 * outputted by the server-side Ext.Direct stack when the API description is built.</p>
804 */
805Ext.direct.RemotingProvider = Ext.extend(Ext.direct.JsonProvider, {       
806    /**
807     * @cfg {Object} actions
808     * Object literal defining the server side actions and methods. For example, if
809     * the Provider is configured with:
810     * <pre><code>
811"actions":{ // each property within the 'actions' object represents a server side Class
812    "TestAction":[ // array of methods within each server side Class to be   
813    {              // stubbed out on client
814        "name":"doEcho",
815        "len":1           
816    },{
817        "name":"multiply",// name of method
818        "len":2           // The number of parameters that will be used to create an
819                          // array of data to send to the server side function.
820                          // Ensure the server sends back a Number, not a String.
821    },{
822        "name":"doForm",
823        "formHandler":true, // direct the client to use specialized form handling method
824        "len":1
825    }]
826}
827     * </code></pre>
828     * <p>Note that a Store is not required, a server method can be called at any time.
829     * In the following example a <b>client side</b> handler is used to call the
830     * server side method "multiply" in the server-side "TestAction" Class:</p>
831     * <pre><code>
832TestAction.multiply(
833    2, 4, // pass two arguments to server, so specify len=2
834    // callback function after the server is called
835    // result: the result returned by the server
836    //      e: Ext.Direct.RemotingEvent object
837    function(result, e){
838        var t = e.getTransaction();
839        var action = t.action; // server side Class called
840        var method = t.method; // server side method called
841        if(e.status){
842            var answer = Ext.encode(result); // 8
843   
844        }else{
845            var msg = e.message; // failure message
846        }
847    }
848);
849     * </code></pre>
850     * In the example above, the server side "multiply" function will be passed two
851     * arguments (2 and 4).  The "multiply" method should return the value 8 which will be
852     * available as the <tt>result</tt> in the example above.
853     */
854   
855    /**
856     * @cfg {String/Object} namespace
857     * Namespace for the Remoting Provider (defaults to the browser global scope of <i>window</i>).
858     * Explicitly specify the namespace Object, or specify a String to have a
859     * {@link Ext#namespace namespace created} implicitly.
860     */
861   
862    /**
863     * @cfg {String} url
864     * <b>Required<b>. The url to connect to the {@link Ext.Direct} server-side router.
865     */
866   
867    /**
868     * @cfg {String} enableUrlEncode
869     * Specify which param will hold the arguments for the method.
870     * Defaults to <tt>'data'</tt>.
871     */
872   
873    /**
874     * @cfg {Number/Boolean} enableBuffer
875     * <p><tt>true</tt> or <tt>false</tt> to enable or disable combining of method
876     * calls. If a number is specified this is the amount of time in milliseconds
877     * to wait before sending a batched request (defaults to <tt>10</tt>).</p>
878     * <br><p>Calls which are received within the specified timeframe will be
879     * concatenated together and sent in a single request, optimizing the
880     * application by reducing the amount of round trips that have to be made
881     * to the server.</p>
882     */
883    enableBuffer: 10,
884   
885    /**
886     * @cfg {Number} maxRetries
887     * Number of times to re-attempt delivery on failure of a call. Defaults to <tt>1</tt>.
888     */
889    maxRetries: 1,
890   
891    /**
892     * @cfg {Number} timeout
893     * The timeout to use for each request. Defaults to <tt>undefined</tt>.
894     */
895    timeout: undefined,
896
897    constructor : function(config){
898        Ext.direct.RemotingProvider.superclass.constructor.call(this, config);
899        this.addEvents(
900            /**
901             * @event beforecall
902             * Fires immediately before the client-side sends off the RPC call.
903             * By returning false from an event handler you can prevent the call from
904             * executing.
905             * @param {Ext.direct.RemotingProvider} provider
906             * @param {Ext.Direct.Transaction} transaction
907             * @param {Object} meta The meta data
908             */           
909            'beforecall',           
910            /**
911             * @event call
912             * Fires immediately after the request to the server-side is sent. This does
913             * NOT fire after the response has come back from the call.
914             * @param {Ext.direct.RemotingProvider} provider
915             * @param {Ext.Direct.Transaction} transaction
916             * @param {Object} meta The meta data
917             */           
918            'call'
919        );
920        this.namespace = (Ext.isString(this.namespace)) ? Ext.ns(this.namespace) : this.namespace || window;
921        this.transactions = {};
922        this.callBuffer = [];
923    },
924
925    // private
926    initAPI : function(){
927        var o = this.actions;
928        for(var c in o){
929            var cls = this.namespace[c] || (this.namespace[c] = {}),
930                ms = o[c];
931            for(var i = 0, len = ms.length; i < len; i++){
932                var m = ms[i];
933                cls[m.name] = this.createMethod(c, m);
934            }
935        }
936    },
937
938    // inherited
939    isConnected: function(){
940        return !!this.connected;
941    },
942
943    connect: function(){
944        if(this.url){
945            this.initAPI();
946            this.connected = true;
947            this.fireEvent('connect', this);
948        }else if(!this.url){
949            throw 'Error initializing RemotingProvider, no url configured.';
950        }
951    },
952
953    disconnect: function(){
954        if(this.connected){
955            this.connected = false;
956            this.fireEvent('disconnect', this);
957        }
958    },
959
960    onData: function(opt, success, xhr){
961        if(success){
962            var events = this.getEvents(xhr);
963            for(var i = 0, len = events.length; i < len; i++){
964                var e = events[i],
965                    t = this.getTransaction(e);
966                this.fireEvent('data', this, e);
967                if(t){
968                    this.doCallback(t, e, true);
969                    Ext.Direct.removeTransaction(t);
970                }
971            }
972        }else{
973            var ts = [].concat(opt.ts);
974            for(var i = 0, len = ts.length; i < len; i++){
975                var t = this.getTransaction(ts[i]);
976                if(t && t.retryCount < this.maxRetries){
977                    t.retry();
978                }else{
979                    var e = new Ext.Direct.ExceptionEvent({
980                        data: e,
981                        transaction: t,
982                        code: Ext.Direct.exceptions.TRANSPORT,
983                        message: 'Unable to connect to the server.',
984                        xhr: xhr
985                    });
986                    this.fireEvent('data', this, e);
987                    if(t){
988                        this.doCallback(t, e, false);
989                        Ext.Direct.removeTransaction(t);
990                    }
991                }
992            }
993        }
994    },
995
996    getCallData: function(t){
997        return {
998            action: t.action,
999            method: t.method,
1000            data: t.data,
1001            type: 'rpc',
1002            tid: t.tid
1003        };
1004    },
1005
1006    doSend : function(data){
1007        var o = {
1008            url: this.url,
1009            callback: this.onData,
1010            scope: this,
1011            ts: data,
1012            timeout: this.timeout
1013        }, callData;
1014
1015        if(Ext.isArray(data)){
1016            callData = [];
1017            for(var i = 0, len = data.length; i < len; i++){
1018                callData.push(this.getCallData(data[i]));
1019            }
1020        }else{
1021            callData = this.getCallData(data);
1022        }
1023
1024        if(this.enableUrlEncode){
1025            var params = {};
1026            params[Ext.isString(this.enableUrlEncode) ? this.enableUrlEncode : 'data'] = Ext.encode(callData);
1027            o.params = params;
1028        }else{
1029            o.jsonData = callData;
1030        }
1031        Ext.Ajax.request(o);
1032    },
1033
1034    combineAndSend : function(){
1035        var len = this.callBuffer.length;
1036        if(len > 0){
1037            this.doSend(len == 1 ? this.callBuffer[0] : this.callBuffer);
1038            this.callBuffer = [];
1039        }
1040    },
1041
1042    queueTransaction: function(t){
1043        if(t.form){
1044            this.processForm(t);
1045            return;
1046        }
1047        this.callBuffer.push(t);
1048        if(this.enableBuffer){
1049            if(!this.callTask){
1050                this.callTask = new Ext.util.DelayedTask(this.combineAndSend, this);
1051            }
1052            this.callTask.delay(Ext.isNumber(this.enableBuffer) ? this.enableBuffer : 10);
1053        }else{
1054            this.combineAndSend();
1055        }
1056    },
1057
1058    doCall : function(c, m, args){
1059        var data = null, hs = args[m.len], scope = args[m.len+1];
1060
1061        if(m.len !== 0){
1062            data = args.slice(0, m.len);
1063        }
1064
1065        var t = new Ext.Direct.Transaction({
1066            provider: this,
1067            args: args,
1068            action: c,
1069            method: m.name,
1070            data: data,
1071            cb: scope && Ext.isFunction(hs) ? hs.createDelegate(scope) : hs
1072        });
1073
1074        if(this.fireEvent('beforecall', this, t, m) !== false){
1075            Ext.Direct.addTransaction(t);
1076            this.queueTransaction(t);
1077            this.fireEvent('call', this, t, m);
1078        }
1079    },
1080
1081    doForm : function(c, m, form, callback, scope){
1082        var t = new Ext.Direct.Transaction({
1083            provider: this,
1084            action: c,
1085            method: m.name,
1086            args:[form, callback, scope],
1087            cb: scope && Ext.isFunction(callback) ? callback.createDelegate(scope) : callback,
1088            isForm: true
1089        });
1090
1091        if(this.fireEvent('beforecall', this, t, m) !== false){
1092            Ext.Direct.addTransaction(t);
1093            var isUpload = String(form.getAttribute("enctype")).toLowerCase() == 'multipart/form-data',
1094                params = {
1095                    extTID: t.tid,
1096                    extAction: c,
1097                    extMethod: m.name,
1098                    extType: 'rpc',
1099                    extUpload: String(isUpload)
1100                };
1101           
1102            // change made from typeof callback check to callback.params
1103            // to support addl param passing in DirectSubmit EAC 6/2
1104            Ext.apply(t, {
1105                form: Ext.getDom(form),
1106                isUpload: isUpload,
1107                params: callback && Ext.isObject(callback.params) ? Ext.apply(params, callback.params) : params
1108            });
1109            this.fireEvent('call', this, t, m);
1110            this.processForm(t);
1111        }
1112    },
1113   
1114    processForm: function(t){
1115        Ext.Ajax.request({
1116            url: this.url,
1117            params: t.params,
1118            callback: this.onData,
1119            scope: this,
1120            form: t.form,
1121            isUpload: t.isUpload,
1122            ts: t
1123        });
1124    },
1125
1126    createMethod : function(c, m){
1127        var f;
1128        if(!m.formHandler){
1129            f = function(){
1130                this.doCall(c, m, Array.prototype.slice.call(arguments, 0));
1131            }.createDelegate(this);
1132        }else{
1133            f = function(form, callback, scope){
1134                this.doForm(c, m, form, callback, scope);
1135            }.createDelegate(this);
1136        }
1137        f.directCfg = {
1138            action: c,
1139            method: m
1140        };
1141        return f;
1142    },
1143
1144    getTransaction: function(opt){
1145        return opt && opt.tid ? Ext.Direct.getTransaction(opt.tid) : null;
1146    },
1147
1148    doCallback: function(t, e){
1149        var fn = e.status ? 'success' : 'failure';
1150        if(t && t.cb){
1151            var hs = t.cb,
1152                result = Ext.isDefined(e.result) ? e.result : e.data;
1153            if(Ext.isFunction(hs)){
1154                hs(result, e);
1155            } else{
1156                Ext.callback(hs[fn], hs.scope, [result, e]);
1157                Ext.callback(hs.callback, hs.scope, [result, e]);
1158            }
1159        }
1160    }
1161});
1162Ext.Direct.PROVIDERS['remoting'] = Ext.direct.RemotingProvider;
Note: See TracBrowser for help on using the repository browser.