Proxies are used by {@link Ext.data.Store Stores} to handle the loading and saving of {@link Ext.data.Model Model} data. - * Usually developers will not need to create or interact with proxies directly.
- *Types of Proxy
- * - *There are two main types of Proxy - {@link Ext.data.proxy.Client Client} and {@link Ext.data.proxy.Server Server}. The Client proxies - * save their data locally and include the following subclasses:
- * - *The Server proxies save their data by sending requests to some remote server. These proxies include:
- * - *Proxies operate on the principle that all operations performed are either Create, Read, Update or Delete. These four operations - * are mapped to the methods {@link #create}, {@link #read}, {@link #update} and {@link #destroy} respectively. Each Proxy subclass - * implements these functions.
- * - *The CRUD methods each expect an {@link Ext.data.Operation Operation} object as the sole argument. The Operation encapsulates - * information about the action the Store wishes to perform, the {@link Ext.data.Model model} instances that are to be modified, etc. - * See the {@link Ext.data.Operation Operation} documentation for more details. Each CRUD method also accepts a callback function to be - * called asynchronously on completion.
- * - *Proxies also support batching of Operations via a {@link Ext.data.Batch batch} object, invoked by the {@link #batch} method.
- * - * @constructor - * Creates the Proxy - * @param {Object} config Optional config object + * + * Proxies are used by {@link Ext.data.Store Stores} to handle the loading and saving of {@link Ext.data.Model Model} + * data. Usually developers will not need to create or interact with proxies directly. + * + * # Types of Proxy + * + * There are two main types of Proxy - {@link Ext.data.proxy.Client Client} and {@link Ext.data.proxy.Server Server}. + * The Client proxies save their data locally and include the following subclasses: + * + * - {@link Ext.data.proxy.LocalStorage LocalStorageProxy} - saves its data to localStorage if the browser supports it + * - {@link Ext.data.proxy.SessionStorage SessionStorageProxy} - saves its data to sessionStorage if the browsers supports it + * - {@link Ext.data.proxy.Memory MemoryProxy} - holds data in memory only, any data is lost when the page is refreshed + * + * The Server proxies save their data by sending requests to some remote server. These proxies include: + * + * - {@link Ext.data.proxy.Ajax Ajax} - sends requests to a server on the same domain + * - {@link Ext.data.proxy.JsonP JsonP} - uses JSON-P to send requests to a server on a different domain + * - {@link Ext.data.proxy.Direct Direct} - uses {@link Ext.direct.Manager} to send requests + * + * Proxies operate on the principle that all operations performed are either Create, Read, Update or Delete. These four + * operations are mapped to the methods {@link #create}, {@link #read}, {@link #update} and {@link #destroy} + * respectively. Each Proxy subclass implements these functions. + * + * The CRUD methods each expect an {@link Ext.data.Operation Operation} object as the sole argument. The Operation + * encapsulates information about the action the Store wishes to perform, the {@link Ext.data.Model model} instances + * that are to be modified, etc. See the {@link Ext.data.Operation Operation} documentation for more details. Each CRUD + * method also accepts a callback function to be called asynchronously on completion. + * + * Proxies also support batching of Operations via a {@link Ext.data.Batch batch} object, invoked by the {@link #batch} + * method. */ Ext.define('Ext.data.proxy.Proxy', { alias: 'proxy.proxy', @@ -56,36 +63,55 @@ Ext.define('Ext.data.proxy.Proxy', { /** * @cfg {String} batchOrder - * Comma-separated ordering 'create', 'update' and 'destroy' actions when batching. Override this - * to set a different order for the batched CRUD actions to be executed in. Defaults to 'create,update,destroy' + * Comma-separated ordering 'create', 'update' and 'destroy' actions when batching. Override this to set a different + * order for the batched CRUD actions to be executed in. Defaults to 'create,update,destroy'. */ batchOrder: 'create,update,destroy', /** - * @cfg {Boolean} batchActions True to batch actions of a particular type when synchronizing the store. - * Defaults to true. + * @cfg {Boolean} batchActions + * True to batch actions of a particular type when synchronizing the store. Defaults to true. */ batchActions: true, /** - * @cfg {String} defaultReaderType The default registered reader type. Defaults to 'json' + * @cfg {String} defaultReaderType + * The default registered reader type. Defaults to 'json'. * @private */ defaultReaderType: 'json', /** - * @cfg {String} defaultWriterType The default registered writer type. Defaults to 'json' + * @cfg {String} defaultWriterType + * The default registered writer type. Defaults to 'json'. * @private */ defaultWriterType: 'json', /** - * @cfg {String/Ext.data.Model} model The name of the Model to tie to this Proxy. Can be either the string name of - * the Model, or a reference to the Model constructor. Required. + * @cfg {String/Ext.data.Model} model + * The name of the Model to tie to this Proxy. Can be either the string name of the Model, or a reference to the + * Model constructor. Required. + */ + + /** + * @cfg {Object/String/Ext.data.reader.Reader} reader + * The Ext.data.reader.Reader to use to decode the server's response or data read from client. 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 or saved to client. This can either be + * a Writer instance, a config object or just a valid Writer type name (e.g. 'json', 'xml'). */ isProxy: true, + /** + * Creates the Proxy + * @param {Object} config (optional) Config object. + */ constructor: function(config) { config = config || {}; @@ -102,7 +128,8 @@ Ext.define('Ext.data.proxy.Proxy', { /** * Sets the model associated with this proxy. This will only usually be called by a Store - * @param {String|Ext.data.Model} model The new model. Can be either the model name string, + * + * @param {String/Ext.data.Model} model The new model. Can be either the model name string, * or a reference to the model's constructor * @param {Boolean} setOnStore Sets the new model on the associated Store, if one is present */ @@ -130,8 +157,9 @@ Ext.define('Ext.data.proxy.Proxy', { /** * Sets the Proxy's Reader by string, config object or Reader instance - * @param {String|Object|Ext.data.reader.Reader} reader The new Reader, which can be either a type string, a configuration object - * or an Ext.data.reader.Reader instance + * + * @param {String/Object/Ext.data.reader.Reader} reader The new Reader, which can be either a type string, + * a configuration object or an Ext.data.reader.Reader instance * @return {Ext.data.reader.Reader} The attached Reader object */ setReader: function(reader) { @@ -169,8 +197,9 @@ Ext.define('Ext.data.proxy.Proxy', { /** * Sets the Proxy's Writer by string, config object or Writer instance - * @param {String|Object|Ext.data.writer.Writer} writer The new Writer, which can be either a type string, a configuration object - * or an Ext.data.writer.Writer instance + * + * @param {String/Object/Ext.data.writer.Writer} writer The new Writer, which can be either a type string, + * a configuration object or an Ext.data.writer.Writer instance * @return {Ext.data.writer.Writer} The attached Writer object */ setWriter: function(writer) { @@ -207,6 +236,7 @@ Ext.define('Ext.data.proxy.Proxy', { * @param {Ext.data.Operation} operation The Operation to perform * @param {Function} callback Callback function to be called when the Operation has completed (whether successful or not) * @param {Object} scope Scope to execute the callback function in + * @method */ create: Ext.emptyFn, @@ -215,6 +245,7 @@ Ext.define('Ext.data.proxy.Proxy', { * @param {Ext.data.Operation} operation The Operation to perform * @param {Function} callback Callback function to be called when the Operation has completed (whether successful or not) * @param {Object} scope Scope to execute the callback function in + * @method */ read: Ext.emptyFn, @@ -223,6 +254,7 @@ Ext.define('Ext.data.proxy.Proxy', { * @param {Ext.data.Operation} operation The Operation to perform * @param {Function} callback Callback function to be called when the Operation has completed (whether successful or not) * @param {Object} scope Scope to execute the callback function in + * @method */ update: Ext.emptyFn, @@ -231,23 +263,27 @@ Ext.define('Ext.data.proxy.Proxy', { * @param {Ext.data.Operation} operation The Operation to perform * @param {Function} callback Callback function to be called when the Operation has completed (whether successful or not) * @param {Object} scope Scope to execute the callback function in + * @method */ destroy: Ext.emptyFn, /** - * Performs a batch of {@link Ext.data.Operation Operations}, in the order specified by {@link #batchOrder}. Used internally by - * {@link Ext.data.Store}'s {@link Ext.data.Store#sync sync} method. Example usage: - *
- * myProxy.batch({
- * create : [myModel1, myModel2],
- * update : [myModel3],
- * destroy: [myModel4, myModel5]
- * });
- *