/**
* @author Ed Spencer
* @class Ext.data.proxy.Server
* @extends Ext.data.proxy.Proxy
@@ -16,104 +33,105 @@ Ext.define('Ext.data.proxy.Server', {
alternateClassName: 'Ext.data.ServerProxy',
uses : ['Ext.data.Request'],
- /**
+ /**
* @cfg {String} url The URL from which to request the data object.
*/
- /**
+ /**
* @cfg {Object/String/Ext.data.reader.Reader} reader The Ext.data.reader.Reader to use to decode the server's response. This can
* either be a Reader instance, a config object or just a valid Reader type name (e.g. 'json', 'xml').
*/
- /**
+ /**
* @cfg {Object/String/Ext.data.writer.Writer} writer The Ext.data.writer.Writer to use to encode any request sent to the server.
* This can either be a Writer instance, a config object or just a valid Writer type name (e.g. 'json', 'xml').
*/
- /**
+ /**
* @cfg {String} pageParam The name of the 'page' parameter to send in a request. Defaults to 'page'. Set this to
* undefined if you don't want to send a page parameter
*/
pageParam: 'page',
- /**
+ /**
* @cfg {String} startParam The name of the 'start' parameter to send in a request. Defaults to 'start'. Set this
* to undefined if you don't want to send a start parameter
*/
startParam: 'start',
- /**
+ /**
* @cfg {String} limitParam The name of the 'limit' parameter to send in a request. Defaults to 'limit'. Set this
* to undefined if you don't want to send a limit parameter
*/
limitParam: 'limit',
- /**
+ /**
* @cfg {String} groupParam The name of the 'group' parameter to send in a request. Defaults to 'group'. Set this
* to undefined if you don't want to send a group parameter
*/
groupParam: 'group',
- /**
+ /**
* @cfg {String} sortParam The name of the 'sort' parameter to send in a request. Defaults to 'sort'. Set this
* to undefined if you don't want to send a sort parameter
*/
sortParam: 'sort',
- /**
+ /**
* @cfg {String} filterParam The name of the 'filter' parameter to send in a request. Defaults to 'filter'. Set
* this to undefined if you don't want to send a filter parameter
*/
filterParam: 'filter',
- /**
+ /**
* @cfg {String} directionParam The name of the direction parameter to send in a request. <strong>This is only used when simpleSortMode is set to true.</strong>
* Defaults to 'dir'.
*/
directionParam: 'dir',
- /**
+ /**
* @cfg {Boolean} simpleSortMode Enabling simpleSortMode in conjunction with remoteSort will only send one sort property and a direction when a remote sort is requested.
* The directionParam and sortParam will be sent with the property name and either 'ASC' or 'DESC'
*/
simpleSortMode: false,
- /**
+ /**
* @cfg {Boolean} noCache (optional) Defaults to true. Disable caching by adding a unique parameter
* name to the request.
*/
noCache : true,
- /**
+ /**
* @cfg {String} cacheString The name of the cache param added to the url when using noCache (defaults to "_dc")
*/
cacheString: "_dc",
- /**
- * @cfg {Number} timeout (optional) The number of milliseconds to wait for a response. Defaults to 30 seconds.
+ /**
+ * @cfg {Number} timeout (optional) The number of milliseconds to wait for a response.
+ * Defaults to 30000 milliseconds (30 seconds).
*/
timeout : 30000,
- /**
+ /**
* @cfg {Object} api
- * Specific urls to call on CRUD action methods "read", "create", "update" and "destroy".
+ * Specific urls to call on CRUD action methods "create", "read", "update" and "destroy".
* Defaults to:<pre><code>
api: {
- read : undefined,
create : undefined,
+ read : undefined,
update : undefined,
destroy : undefined
}
* </code></pre>
- * <p>The url is built based upon the action being executed <tt>[load|create|save|destroy]</tt>
+ * <p>The url is built based upon the action being executed <tt>[create|read|update|destroy]</tt>
* using the commensurate <tt>{@link #api}</tt> property, or if undefined default to the
* configured {@link Ext.data.Store}.{@link Ext.data.proxy.Server#url url}.</p><br>
* <p>For example:</p>
* <pre><code>
api: {
- load : '/controller/load',
- create : '/controller/new',
- save : '/controller/update',
+ create : '/controller/new',
+ read : '/controller/load',
+ update : '/controller/update',
destroy : '/controller/destroy_action'
}
* </code></pre>
@@ -121,7 +139,7 @@ api: {
* will be directed to the configured <tt>{@link Ext.data.proxy.Server#url url}</tt>.</p>
*/
- /**
+ /**
* @ignore
*/
constructor: function(config) {
@@ -129,7 +147,7 @@ api: {
config = config || {};
this.addEvents(
- /**
+ /**
* @event exception
* Fires when the server returns an exception
* @param {Ext.data.proxy.Proxy} this
@@ -140,7 +158,7 @@ api: {
);
me.callParent([config]);
- /**
+ /**
* @cfg {Object} extraParams Extra parameters that will be included on every request. Individual requests with params
* of the same name will override these params when they are in conflict.
*/
@@ -169,7 +187,7 @@ api: {
return this.doRequest.apply(this, arguments);
},
- /**
+ /**
* Creates and returns an Ext.data.Request object based on the options passed by the {@link Ext.data.Store Store}
* that this Proxy is attached to.
* @param {Ext.data.Operation} operation The {@link Ext.data.Operation Operation} object to execute
@@ -205,7 +223,7 @@ api: {
return request;
},
- /**
+ /**
*
*/
processResponse: function(success, operation, request, response, callback, scope){
@@ -262,7 +280,7 @@ api: {
me.afterRequest(request, success);
},
- /**
+ /**
* Sets up an exception on the operation
* @private
* @param {Ext.data.Operation} operation The operation
@@ -275,7 +293,7 @@ api: {
});
},
- /**
+ /**
* Template method to allow subclasses to specify how to get the response for the reader.
* @private
* @param {Object} response The server response
@@ -285,7 +303,7 @@ api: {
return response;
},
- /**
+ /**
* Encode any values being sent to the server. Can be overridden in subclasses.
* @private
* @param {Array} An array of sorters/filters.
@@ -295,7 +313,7 @@ api: {
return Ext.encode(value);
},
- /**
+ /**
* Encodes the array of {@link Ext.util.Sorter} objects into a string to be sent in the request url. By default,
* this simply JSON-encodes the sorter data
* @param {Array} sorters The array of {@link Ext.util.Sorter Sorter} objects
@@ -316,7 +334,7 @@ api: {
},
- /**
+ /**
* Encodes the array of {@link Ext.util.Filter} objects into a string to be sent in the request url. By default,
* this simply JSON-encodes the filter data
* @param {Array} sorters The array of {@link Ext.util.Filter Filter} objects
@@ -336,7 +354,7 @@ api: {
return this.applyEncoding(min);
},
- /**
+ /**
* @private
* Copy any sorters, filters etc into the params so they can be sent over the wire
*/
@@ -396,7 +414,7 @@ api: {
return params;
},
- /**
+ /**
* Generates a url based on a given Ext.data.Request object. By default, ServerProxy's buildUrl will
* add the cache-buster param to the end of the url. Subclasses may need to perform additional modifications
* to the url.
@@ -420,7 +438,7 @@ api: {
return url;
},
- /**
+ /**
* Get the url for the request taking into account the order of priority,
* - The request
* - The api
@@ -433,7 +451,7 @@ api: {
return request.url || this.api[request.action] || this.url;
},
- /**
+ /**
* In ServerProxy subclasses, the {@link #create}, {@link #read}, {@link #update} and {@link #destroy} methods all pass
* through to doRequest. Each ServerProxy subclass must implement the doRequest method - see {@link Ext.data.proxy.JsonP}
* and {@link Ext.data.proxy.Ajax} for examples. This method carries the same signature as each of the methods that delegate to it.
@@ -447,10 +465,11 @@ api: {
//</debug>
},
- /**
+ /**
* Optional callback function which can be used to clean up after a request has been completed.
* @param {Ext.data.Request} request The Request object
* @param {Boolean} success True if the request was successful
+ * @method
*/
afterRequest: Ext.emptyFn,
@@ -458,4 +477,6 @@ api: {
Ext.destroy(this.reader, this.writer);
}
});
-