X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/src/data/proxy/Memory.js diff --git a/src/data/proxy/Memory.js b/src/data/proxy/Memory.js index c799d9e6..52ff0140 100644 --- a/src/data/proxy/Memory.js +++ b/src/data/proxy/Memory.js @@ -14,58 +14,54 @@ If you are unsure which license is appropriate for your use, please contact the */ /** * @author Ed Spencer - * @class Ext.data.proxy.Memory - * @extends Ext.data.proxy.Client * - *
In-memory proxy. This proxy simply uses a local variable for data storage/retrieval, so its contents are lost on - * every page refresh.
+ * In-memory proxy. This proxy simply uses a local variable for data storage/retrieval, so its contents are lost on + * every page refresh. * - *Usually this Proxy isn't used directly, serving instead as a helper to a {@link Ext.data.Store Store} where a - * reader is required to load data. For example, say we have a Store for a User model and have some inline data we want - * to load, but this data isn't in quite the right format: we can use a MemoryProxy with a JsonReader to read it into - * our Store:
+ * Usually this Proxy isn't used directly, serving instead as a helper to a {@link Ext.data.Store Store} where a reader + * is required to load data. For example, say we have a Store for a User model and have some inline data we want to + * load, but this data isn't in quite the right format: we can use a MemoryProxy with a JsonReader to read it into our + * Store: * -
-//this is the model we will be using in the store
-Ext.define('User', {
- extend: 'Ext.data.Model',
- fields: [
- {name: 'id', type: 'int'},
- {name: 'name', type: 'string'},
- {name: 'phone', type: 'string', mapping: 'phoneNumber'}
- ]
-});
-
-//this data does not line up to our model fields - the phone field is called phoneNumber
-var data = {
- users: [
- {
- id: 1,
- name: 'Ed Spencer',
- phoneNumber: '555 1234'
- },
- {
- id: 2,
- name: 'Abe Elias',
- phoneNumber: '666 1234'
- }
- ]
-};
-
-//note how we set the 'root' in the reader to match the data structure above
-var store = new Ext.data.Store({
- autoLoad: true,
- model: 'User',
- data : data,
- proxy: {
- type: 'memory',
- reader: {
- type: 'json',
- root: 'users'
- }
- }
-});
-
+ * //this is the model we will be using in the store
+ * Ext.define('User', {
+ * extend: 'Ext.data.Model',
+ * fields: [
+ * {name: 'id', type: 'int'},
+ * {name: 'name', type: 'string'},
+ * {name: 'phone', type: 'string', mapping: 'phoneNumber'}
+ * ]
+ * });
+ *
+ * //this data does not line up to our model fields - the phone field is called phoneNumber
+ * var data = {
+ * users: [
+ * {
+ * id: 1,
+ * name: 'Ed Spencer',
+ * phoneNumber: '555 1234'
+ * },
+ * {
+ * id: 2,
+ * name: 'Abe Elias',
+ * phoneNumber: '666 1234'
+ * }
+ * ]
+ * };
+ *
+ * //note how we set the 'root' in the reader to match the data structure above
+ * var store = Ext.create('Ext.data.Store', {
+ * autoLoad: true,
+ * model: 'User',
+ * data : data,
+ * proxy: {
+ * type: 'memory',
+ * reader: {
+ * type: 'json',
+ * root: 'users'
+ * }
+ * }
+ * });
*/
Ext.define('Ext.data.proxy.Memory', {
extend: 'Ext.data.proxy.Client',
@@ -73,7 +69,8 @@ Ext.define('Ext.data.proxy.Memory', {
alternateClassName: 'Ext.data.MemoryProxy',
/**
- * @cfg {Array} data Optional array of Records to load into the Proxy
+ * @cfg {Ext.data.Model[]} data
+ * Optional array of Records to load into the Proxy
*/
constructor: function(config) {
@@ -84,7 +81,7 @@ Ext.define('Ext.data.proxy.Memory', {
},
/**
- * Reads data from the configured {@link #data} object. Uses the Proxy's {@link #reader}, if present
+ * Reads data from the configured {@link #data} object. Uses the Proxy's {@link #reader}, if present.
* @param {Ext.data.Operation} operation The read Operation
* @param {Function} callback The callback to call when reading has completed
* @param {Object} scope The scope to call the callback function in