/**
+ * @author Ed Spencer
* @class Ext.data.proxy.Proxy
*
* <p>Proxies are used by {@link Ext.data.Store Stores} to handle the loading and saving of {@link Ext.data.Model Model} data.
@@ -34,9 +51,6 @@
*
* <p>Proxies also support batching of Operations via a {@link Ext.data.Batch batch} object, invoked by the {@link #batch} method.</p>
*
- * @constructor
- * Creates the Proxy
- * @param {Object} config Optional config object
*/
Ext.define('Ext.data.proxy.Proxy', {
alias: 'proxy.proxy',
@@ -54,38 +68,42 @@ Ext.define('Ext.data.proxy.Proxy', {
observable: 'Ext.util.Observable'
},
- /**
+ /**
* @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'
*/
batchOrder: 'create,update,destroy',
- /**
+ /**
* @cfg {Boolean} batchActions True to batch actions of a particular type when synchronizing the store.
* Defaults to <tt>true</tt>.
*/
batchActions: true,
- /**
+ /**
* @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'
* @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.
*/
isProxy: true,
+ /**
+ * Creates the Proxy
+ * @param {Object} config (optional) Config object.
+ */
constructor: function(config) {
config = config || {};
@@ -100,7 +118,7 @@ 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,
* or a reference to the model's constructor
@@ -120,7 +138,7 @@ Ext.define('Ext.data.proxy.Proxy', {
}
},
- /**
+ /**
* Returns the model attached to this Proxy
* @return {Ext.data.Model} The model
*/
@@ -128,7 +146,7 @@ Ext.define('Ext.data.proxy.Proxy', {
return this.model;
},
- /**
+ /**
* 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
@@ -159,7 +177,7 @@ Ext.define('Ext.data.proxy.Proxy', {
return me.reader;
},
- /**
+ /**
* Returns the reader currently attached to this proxy instance
* @return {Ext.data.reader.Reader} The Reader instance
*/
@@ -167,7 +185,7 @@ Ext.define('Ext.data.proxy.Proxy', {
return this.reader;
},
- /**
+ /**
* 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
@@ -194,7 +212,7 @@ Ext.define('Ext.data.proxy.Proxy', {
return this.writer;
},
- /**
+ /**
* Returns the writer currently attached to this proxy instance
* @return {Ext.data.writer.Writer} The Writer instance
*/
@@ -202,39 +220,43 @@ Ext.define('Ext.data.proxy.Proxy', {
return this.writer;
},
- /**
+ /**
* Performs the given create operation.
* @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,
- /**
+ /**
* Performs the given read operation.
* @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,
- /**
+ /**
* Performs the given update operation.
* @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,
- /**
+ /**
* Performs the given destroy operation.
* @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:
* <pre><code>
@@ -290,4 +312,6 @@ Ext.define('Ext.data.proxy.Proxy', {
// Ext.data.DataProxy = this;
// }, this);
});
-