git.roojs.org Git - roojs1/blob - Roo/data/HttpProxy.js

   1 /*
   2  * Based on:
   3  * Ext JS Library 1.1.1
   4  * Copyright(c) 2006-2007, Ext JS, LLC.
   5  *
   6  * Originally Released Under LGPL - original licence link has changed is not relivant.
   7  *
   8  * Fork - LGPL
   9  * <script type="text/javascript">
  10  */
  11 /**
  12  * @class Roo.data.HttpProxy
  13  * @extends Roo.data.DataProxy
  14  * An implementation of {@link Roo.data.DataProxy} that reads a data object from an {@link Roo.data.Connection} object
  15  * configured to reference a certain URL.<br><br>
  16  * <p>
  17  * <em>Note that this class cannot be used to retrieve data from a domain other than the domain
  18  * from which the running page was served.<br><br>
  19  * <p>
  20  * For cross-domain access to remote data, use an {@link Roo.data.ScriptTagProxy}.</em><br><br>
  21  * <p>
  22  * Be aware that to enable the browser to parse an XML document, the server must set
  23  * the Content-Type header in the HTTP response to "text/xml".
  24  * @constructor
  25  * @param {Object} conn Connection config options to add to each request (e.g. {url: 'foo.php'} or
  26  * an {@link Roo.data.Connection} object.  If a Connection config is passed, the singleton {@link Roo.Ajax} object
  27  * will be used to make the request.
  28  */
  29 Roo.data.HttpProxy = function(conn){
  30     Roo.data.HttpProxy.superclass.constructor.call(this);
  31     // is conn a conn config or a real conn?
  32
  33     this.conn = conn;
  34     this.useAjax = !conn || !conn.events;
  35
  36 };
  37
  38 Roo.extend(Roo.data.HttpProxy, Roo.data.DataProxy, {
  39     // thse are take from connection...
  40
  41     /**
  42      * @cfg {String} url (Optional) The default URL to be used for requests to the server. (defaults to undefined)
  43      */
  44     /**
  45      * @cfg {Object} extraParams (Optional) An object containing properties which are used as
  46      * extra parameters to each request made by this object. (defaults to undefined)
  47      */
  48     /**
  49      * @cfg {Object} defaultHeaders (Optional) An object containing request headers which are added
  50      *  to each request made by this object. (defaults to undefined)
  51      */
  52     /**
  53      * @cfg {String} method (Optional) The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET)
  54      */
  55     /**
  56      * @cfg {Number} timeout (Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)
  57      */
  58      /**
  59      * @cfg {Boolean} autoAbort (Optional) Whether this request should abort any pending requests. (defaults to false)
  60      * @type Boolean
  61      */
  62
  63
  64     /**
  65      * @cfg {Boolean} disableCaching (Optional) True to add a unique cache-buster param to GET requests. (defaults to true)
  66      * @type Boolean
  67      */
  68     /**
  69      * Return the {@link Roo.data.Connection} object being used by this Proxy.
  70      * @return {Connection} The Connection object. This object may be used to subscribe to events on
  71      * a finer-grained basis than the DataProxy events.
  72      */
  73     getConnection : function(){
  74         return this.useAjax ? Roo.Ajax : this.conn;
  75     },
  76
  77     /**
  78      * Load data from the configured {@link Roo.data.Connection}, read the data object into
  79      * a block of Roo.data.Records using the passed {@link Roo.data.DataReader} implementation, and
  80      * process that block using the passed callback.
  81      * @param {Object} params An object containing properties which are to be used as HTTP parameters
  82      * for the request to the remote server.
  83      * @param {Roo.data.DataReader} reader The Reader object which converts the data
  84      * object into a block of Roo.data.Records.
  85      * @param {Function} callback The function into which to pass the block of Roo.data.Records.
  86      * The function must be passed <ul>
  87      * <li>The Record block object</li>
  88      * <li>The "arg" argument from the load function</li>
  89      * <li>A boolean success indicator</li>
  90      * </ul>
  91      * @param {Object} scope The scope in which to call the callback
  92      * @param {Object} arg An optional argument which is passed to the callback as its second parameter.
  93      */
  94     load : function(params, reader, callback, scope, arg){
  95         if(this.fireEvent("beforeload", this, params) !== false){
  96             var  o = {
  97                 params : params || {},
  98                 request: {
  99                     callback : callback,
 100                     scope : scope,
 101                     arg : arg
 102                 },
 103                 reader: reader,
 104                 callback : this.loadResponse,
 105                 scope: this
 106             };
 107             if (this.conn.timeout) {
 108                 Roo.log('setting timeout to ' + this.conn.timeout);
 109                 o.timeout = this.conn.timeout;
 110             }
 111             if(this.useAjax){
 112                 Roo.applyIf(o, this.conn);
 113                 if(this.activeRequest){
 114                     Roo.Ajax.abort(this.activeRequest);
 115                 }
 116                 this.activeRequest = Roo.Ajax.request(o);
 117             }else{
 118                 this.conn.request(o);
 119             }
 120         }else{
 121             callback.call(scope||this, null, arg, false);
 122         }
 123     },
 124
 125     // private
 126     loadResponse : function(o, success, response){
 127         delete this.activeRequest;
 128         if(!success){
 129             this.fireEvent("loadexception", this, o, response);
 130             o.request.callback.call(o.request.scope, null, o.request.arg, false);
 131             return;
 132         }
 133         var result;
 134         try {
 135             result = o.reader.read(response);
 136         }catch(e){
 137             this.fireEvent("loadexception", this, o, response, e);
 138             o.request.callback.call(o.request.scope, null, o.request.arg, false);
 139             return;
 140         }
 141
 142         this.fireEvent("load", this, o, o.request.arg);
 143         o.request.callback.call(o.request.scope, result, o.request.arg, true);
 144     },
 145
 146     // private
 147     update : function(dataSet){
 148
 149     },
 150
 151     // private
 152     updateResponse : function(dataSet){
 153
 154     }
 155 });