Note that if this HttpProxy is being used by a (@link Ext.data.Store Store}, then the + *
Note that if this HttpProxy is being used by a {@link Ext.data.Store Store}, then the * Store's call to {@link #load} will override any specified callback and params * options. In this case, use the Store's {@link Ext.data.Store#events events} to modify parameters, * or react to loading events. The Store's {@link Ext.data.Store#baseParams baseParams} may also be @@ -39,13 +40,13 @@ Ext.data.HttpProxy = function(conn){ // nullify the connection url. The url param has been copied to 'this' above. The connection // url will be set during each execution of doRequest when buildUrl is called. This makes it easier for users to override the - // connection url during beforeaction events (ie: beforeload, beforesave, etc). The connection url will be nullified - // after each request as well. Url is always re-defined during doRequest. + // connection url during beforeaction events (ie: beforeload, beforewrite, etc). + // Url is always re-defined during doRequest. this.conn.url = null; this.useAjax = !conn || !conn.events; - //private. A hash containing active requests, keyed on action [Ext.data.Api.actions.create|read|update|destroy] + // A hash containing active requests, keyed on action [Ext.data.Api.actions.create|read|update|destroy] var actions = Ext.data.Api.actions; this.activeRequest = {}; for (var verb in actions) { @@ -54,40 +55,6 @@ Ext.data.HttpProxy = function(conn){ }; Ext.extend(Ext.data.HttpProxy, Ext.data.DataProxy, { -
/** - * @cfg {Boolean} restful - *If set to true, a {@link Ext.data.Record#phantom non-phantom} record's - * {@link Ext.data.Record#id id} will be appended to the url (defaults to false).
The url is built based upon the action being executed [load|create|save|destroy] - * using the commensurate {@link #api} property, or if undefined default to the - * configured {@link Ext.data.Store}.{@link Ext.data.Store#url url}.
Some MVC (e.g., Ruby on Rails, Merb and Django) support this style of segment based urls - * where the segments in the URL follow the Model-View-Controller approach.
- * someSite.com/controller/action/id
- * For example:
- *
-api: {
- load : '/controller/load',
- create : '/controller/new', // Server MUST return idProperty of new record
- save : '/controller/update',
- destroy : '/controller/destroy_action'
-}
-
-// Alternatively, one can use the object-form to specify each API-action
-api: {
- load: {url: 'read.php', method: 'GET'},
- create: 'create.php',
- destroy: 'destroy.php',
- save: 'update.php'
-}
- */
-
/**
* Return the {@link Ext.data.Connection} object being used by this Proxy.
* @return {Connection} The Connection object. This object may be used to subscribe to events on
@@ -111,6 +78,7 @@ api: {
this.conn.url = url;
if (makePermanent === true) {
this.url = url;
+ this.api = null;
Ext.data.Api.prepare(this);
}
},
@@ -129,8 +97,9 @@ api: {
* r : Ext.data.Record[] The block of Ext.data.Records.
* options: Options object from the action request
* success: Boolean success indicator
- * @param {Object} scope The scope in which to call the callback
+ * @param {Object} scope The scope (this reference) in which the callback function is executed. Defaults to the browser window.
* @param {Object} arg An optional argument which is passed to the callback as its second parameter.
+ * @protected
*/
doRequest : function(action, rs, params, reader, cb, scope, arg) {
var o = {
@@ -144,29 +113,31 @@ api: {
callback : this.createCallback(action, rs),
scope: this
};
- // Sample the request data: If it's an object, then it hasn't been json-encoded yet.
- // Transmit data using jsonData config of Ext.Ajax.request
- if (typeof(params[reader.meta.root]) === 'object') {
- o.jsonData = params;
+
+ // If possible, transmit data using jsonData || xmlData on Ext.Ajax.request (An installed DataWriter would have written it there.).
+ // Use std HTTP params otherwise.
+ if (params.jsonData) {
+ o.jsonData = params.jsonData;
+ } else if (params.xmlData) {
+ o.xmlData = params.xmlData;
} else {
o.params = params || {};
}
// Set the connection url. If this.conn.url is not null here,
- // the user may have overridden the url during a beforeaction event-handler.
+ // the user must have overridden the url during a beforewrite/beforeload event-handler.
// this.conn.url is nullified after each request.
- if (this.conn.url === null) {
- this.conn.url = this.buildUrl(action, rs);
- }
- else if (this.restful === true && rs instanceof Ext.data.Record && !rs.phantom) {
- this.conn.url += '/' + rs.id;
- }
+ this.conn.url = this.buildUrl(action, rs);
+
if(this.useAjax){
Ext.applyIf(o, this.conn);
// If a currently running request is found for this action, abort it.
if (this.activeRequest[action]) {
+ ////
// Disabled aborting activeRequest while implementing REST. activeRequest[action] will have to become an array
+ // TODO ideas anyone?
+ //
//Ext.Ajax.abort(this.activeRequest[action]);
}
this.activeRequest[action] = Ext.Ajax.request(o);
@@ -190,6 +161,7 @@ api: {
if (!success) {
if (action === Ext.data.Api.actions.read) {
// @deprecated: fire loadexception for backwards compat.
+ // TODO remove in 3.1
this.fireEvent('loadexception', this, o, response);
}
this.fireEvent('exception', this, 'response', action, o, response);
@@ -201,15 +173,18 @@ api: {
} else {
this.onWrite(action, o, response, rs);
}
- }
+ };
},
- /**
+ /**
* Callback for read action
* @param {String} action Action name as per {@link Ext.data.Api.actions#read}.
* @param {Object} o The request transaction object
* @param {Object} res The server response
- * @private
+ * @fires loadexception (deprecated)
+ * @fires exception
+ * @fires load
+ * @protected
*/
onRead : function(action, o, response) {
var result;
@@ -217,13 +192,16 @@ api: {
result = o.reader.read(response);
}catch(e){
// @deprecated: fire old loadexception for backwards-compat.
+ // TODO remove in 3.1
this.fireEvent('loadexception', this, o, response, e);
+
this.fireEvent('exception', this, 'response', action, o, response, e);
o.request.callback.call(o.request.scope, null, o.request.arg, false);
return;
}
if (result.success === false) {
// @deprecated: fire old loadexception for backwards-compat.
+ // TODO remove in 3.1
this.fireEvent('loadexception', this, o, response);
// Get DataReader read-back a response-object to pass along to exception event
@@ -233,14 +211,19 @@ api: {
else {
this.fireEvent('load', this, o, o.request.arg);
}
+ // TODO refactor onRead, onWrite to be more generalized now that we're dealing with Ext.data.Response instance
+ // the calls to request.callback(...) in each will have to be made identical.
+ // NOTE reader.readResponse does not currently return Ext.data.Response
o.request.callback.call(o.request.scope, result, o.request.arg, result.success);
},
- /**
+ /**
* Callback for write actions
* @param {String} action [Ext.data.Api.actions.create|read|update|destroy]
* @param {Object} trans The request transaction object
* @param {Object} res The server response
- * @private
+ * @fires exception
+ * @fires write
+ * @protected
*/
onWrite : function(action, o, response, rs) {
var reader = o.reader;
@@ -252,12 +235,15 @@ api: {
o.request.callback.call(o.request.scope, null, o.request.arg, false);
return;
}
- if (res[reader.meta.successProperty] === false) {
- this.fireEvent('exception', this, 'remote', action, o, res, rs);
+ if (res.success === true) {
+ this.fireEvent('write', this, action, res.data, res, rs, o.request.arg);
} else {
- this.fireEvent('write', this, action, res[reader.meta.root], res, rs, o.request.arg);
+ this.fireEvent('exception', this, 'remote', action, o, res, rs);
}
- o.request.callback.call(o.request.scope, res[reader.meta.root], res, res[reader.meta.successProperty]);
+ // TODO refactor onRead, onWrite to be more generalized now that we're dealing with Ext.data.Response instance
+ // the calls to request.callback(...) in each will have to be made similar.
+ // NOTE reader.readResponse does not currently return Ext.data.Response
+ o.request.callback.call(o.request.scope, res.data, res, res.success);
},
// inherit docs