3 * Copyright(c) 2006-2010 Sencha Inc.
5 * http://www.sencha.com/license
8 * @class Ext.data.Store
9 * @extends Ext.util.Observable
10 * <p>The Store class encapsulates a client side cache of {@link Ext.data.Record Record}
11 * objects which provide input data for Components such as the {@link Ext.grid.GridPanel GridPanel},
12 * the {@link Ext.form.ComboBox ComboBox}, or the {@link Ext.DataView DataView}.</p>
13 * <p><u>Retrieving Data</u></p>
14 * <p>A Store object may access a data object using:<div class="mdetail-params"><ul>
15 * <li>{@link #proxy configured implementation} of {@link Ext.data.DataProxy DataProxy}</li>
16 * <li>{@link #data} to automatically pass in data</li>
17 * <li>{@link #loadData} to manually pass in data</li>
19 * <p><u>Reading Data</u></p>
20 * <p>A Store object has no inherent knowledge of the format of the data object (it could be
21 * an Array, XML, or JSON). A Store object uses an appropriate {@link #reader configured implementation}
22 * of a {@link Ext.data.DataReader DataReader} to create {@link Ext.data.Record Record} instances from the data
24 * <p><u>Store Types</u></p>
25 * <p>There are several implementations of Store available which are customized for use with
26 * a specific DataReader implementation. Here is an example using an ArrayStore which implicitly
27 * creates a reader commensurate to an Array data object.</p>
29 var myStore = new Ext.data.ArrayStore({
30 fields: ['fullname', 'first'],
31 idIndex: 0 // id for each record will be the first element
34 * <p>For custom implementations create a basic {@link Ext.data.Store} configured as needed:</p>
36 // create a {@link Ext.data.Record Record} constructor:
37 var rt = Ext.data.Record.create([
41 var myStore = new Ext.data.Store({
42 // explicitly create reader
43 reader: new Ext.data.ArrayReader(
45 idIndex: 0 // id for each record will be the first element
51 * <p>Load some data into store (note the data object is an array which corresponds to the reader):</p>
54 [1, 'Fred Flintstone', 'Fred'], // note that id for the record is the first element
55 [2, 'Barney Rubble', 'Barney']
57 myStore.loadData(myData);
59 * <p>Records are cached and made available through accessor functions. An example of adding
60 * a record to the store:</p>
63 fullname: 'Full Name',
66 var recId = 100; // provide unique id for the record
67 var r = new myStore.recordType(defaultData, ++recId); // create new record
68 myStore.{@link #insert}(0, r); // insert a new record into the store (also see {@link #add})
70 * <p><u>Writing Data</u></p>
71 * <p>And <b>new in Ext version 3</b>, use the new {@link Ext.data.DataWriter DataWriter} to create an automated, <a href="http://extjs.com/deploy/dev/examples/writer/writer.html">Writable Store</a>
72 * along with <a href="http://extjs.com/deploy/dev/examples/restful/restful.html">RESTful features.</a>
74 * Creates a new Store.
75 * @param {Object} config A config object containing the objects needed for the Store to access data,
76 * and read the data into Records.
79 Ext.data.Store = Ext.extend(Ext.util.Observable, {
81 * @cfg {String} storeId If passed, the id to use to register with the <b>{@link Ext.StoreMgr StoreMgr}</b>.
82 * <p><b>Note</b>: if a (deprecated) <tt>{@link #id}</tt> is specified it will supersede the <tt>storeId</tt>
86 * @cfg {String} url If a <tt>{@link #proxy}</tt> is not specified the <tt>url</tt> will be used to
87 * implicitly configure a {@link Ext.data.HttpProxy HttpProxy} if an <tt>url</tt> is specified.
88 * Typically this option, or the <code>{@link #data}</code> option will be specified.
91 * @cfg {Boolean/Object} autoLoad If <tt>{@link #data}</tt> is not specified, and if <tt>autoLoad</tt>
92 * is <tt>true</tt> or an <tt>Object</tt>, this store's {@link #load} method is automatically called
93 * after creation. If the value of <tt>autoLoad</tt> is an <tt>Object</tt>, this <tt>Object</tt> will
94 * be passed to the store's {@link #load} method.
97 * @cfg {Ext.data.DataProxy} proxy The {@link Ext.data.DataProxy DataProxy} object which provides
98 * access to a data object. See <code>{@link #url}</code>.
101 * @cfg {Array} data An inline data object readable by the <code>{@link #reader}</code>.
102 * Typically this option, or the <code>{@link #url}</code> option will be specified.
105 * @cfg {Ext.data.DataReader} reader The {@link Ext.data.DataReader Reader} object which processes the
106 * data object and returns an Array of {@link Ext.data.Record} objects which are cached keyed by their
107 * <b><tt>{@link Ext.data.Record#id id}</tt></b> property.
110 * @cfg {Ext.data.DataWriter} writer
111 * <p>The {@link Ext.data.DataWriter Writer} object which processes a record object for being written
112 * to the server-side database.</p>
113 * <br><p>When a writer is installed into a Store the {@link #add}, {@link #remove}, and {@link #update}
114 * events on the store are monitored in order to remotely {@link #createRecords create records},
115 * {@link #destroyRecord destroy records}, or {@link #updateRecord update records}.</p>
116 * <br><p>The proxy for this store will relay any {@link #writexception} events to this store.</p>
117 * <br><p>Sample implementation:
119 var writer = new {@link Ext.data.JsonWriter}({
121 writeAllFields: true // write all fields, not just those that changed
124 // Typical Store collecting the Proxy, Reader and Writer together.
125 var store = new Ext.data.Store({
130 writer: writer, // <-- plug a DataWriter into the store just as you would a Reader
132 autoSave: false // <-- false to delay executing create, update, destroy requests
133 // until specifically told to do so.
139 * @cfg {Object} baseParams
140 * <p>An object containing properties which are to be sent as parameters
141 * for <i>every</i> HTTP request.</p>
142 * <p>Parameters are encoded as standard HTTP parameters using {@link Ext#urlEncode}.</p>
143 * <p><b>Note</b>: <code>baseParams</code> may be superseded by any <code>params</code>
144 * specified in a <code>{@link #load}</code> request, see <code>{@link #load}</code>
145 * for more details.</p>
146 * This property may be modified after creation using the <code>{@link #setBaseParam}</code>
151 * @cfg {Object} sortInfo A config object to specify the sort order in the request of a Store's
152 * {@link #load} operation. Note that for local sorting, the <tt>direction</tt> property is
153 * case-sensitive. See also {@link #remoteSort} and {@link #paramNames}.
154 * For example:<pre><code>
157 direction: 'ASC' // or 'DESC' (case sensitive for local sorting)
162 * @cfg {boolean} remoteSort <tt>true</tt> if sorting is to be handled by requesting the <tt>{@link #proxy Proxy}</tt>
163 * to provide a refreshed version of the data object in sorted order, as opposed to sorting the Record cache
164 * in place (defaults to <tt>false</tt>).
165 * <p>If <tt>remoteSort</tt> is <tt>true</tt>, then clicking on a {@link Ext.grid.Column Grid Column}'s
166 * {@link Ext.grid.Column#header header} causes the current page to be requested from the server appending
167 * the following two parameters to the <b><tt>{@link #load params}</tt></b>:<div class="mdetail-params"><ul>
168 * <li><b><tt>sort</tt></b> : String<p class="sub-desc">The <tt>name</tt> (as specified in the Record's
169 * {@link Ext.data.Field Field definition}) of the field to sort on.</p></li>
170 * <li><b><tt>dir</tt></b> : String<p class="sub-desc">The direction of the sort, 'ASC' or 'DESC' (case-sensitive).</p></li>
176 * @cfg {Boolean} autoDestroy <tt>true</tt> to destroy the store when the component the store is bound
177 * to is destroyed (defaults to <tt>false</tt>).
178 * <p><b>Note</b>: this should be set to true when using stores that are bound to only 1 component.</p>
183 * @cfg {Boolean} pruneModifiedRecords <tt>true</tt> to clear all modified record information each time
184 * the store is loaded or when a record is removed (defaults to <tt>false</tt>). See {@link #getModifiedRecords}
185 * for the accessor method to retrieve the modified records.
187 pruneModifiedRecords : false,
190 * Contains the last options object used as the parameter to the {@link #load} method. See {@link #load}
191 * for the details of what this may contain. This may be useful for accessing any params which were used
192 * to load the current Record cache.
198 * @cfg {Boolean} autoSave
199 * <p>Defaults to <tt>true</tt> causing the store to automatically {@link #save} records to
200 * the server when a record is modified (ie: becomes 'dirty'). Specify <tt>false</tt> to manually call {@link #save}
201 * to send all modifiedRecords to the server.</p>
202 * <br><p><b>Note</b>: each CRUD action will be sent as a separate request.</p>
207 * @cfg {Boolean} batch
208 * <p>Defaults to <tt>true</tt> (unless <code>{@link #restful}:true</code>). Multiple
209 * requests for each CRUD action (CREATE, READ, UPDATE and DESTROY) will be combined
210 * and sent as one transaction. Only applies when <code>{@link #autoSave}</code> is set
211 * to <tt>false</tt>.</p>
212 * <br><p>If Store is RESTful, the DataProxy is also RESTful, and a unique transaction is
213 * generated for each record.</p>
218 * @cfg {Boolean} restful
219 * Defaults to <tt>false</tt>. Set to <tt>true</tt> to have the Store and the set
220 * Proxy operate in a RESTful manner. The store will automatically generate GET, POST,
221 * PUT and DELETE requests to the server. The HTTP method used for any given CRUD
222 * action is described in {@link Ext.data.Api#restActions}. For additional information
223 * see {@link Ext.data.DataProxy#restful}.
224 * <p><b>Note</b>: if <code>{@link #restful}:true</code> <code>batch</code> will
225 * internally be set to <tt>false</tt>.</p>
230 * @cfg {Object} paramNames
231 * <p>An object containing properties which specify the names of the paging and
232 * sorting parameters passed to remote servers when loading blocks of data. By default, this
233 * object takes the following form:</p><pre><code>
235 start : 'start', // The parameter name which specifies the start row
236 limit : 'limit', // The parameter name which specifies number of rows to return
237 sort : 'sort', // The parameter name which specifies the column to sort on
238 dir : 'dir' // The parameter name which specifies the sort direction
241 * <p>The server must produce the requested data block upon receipt of these parameter names.
242 * If different parameter names are required, this property can be overriden using a configuration
244 * <p>A {@link Ext.PagingToolbar PagingToolbar} bound to this Store uses this property to determine
245 * the parameter names to use in its {@link #load requests}.
247 paramNames : undefined,
250 * @cfg {Object} defaultParamNames
251 * Provides the default values for the {@link #paramNames} property. To globally modify the parameters
252 * for all stores, this object should be changed on the store prototype.
254 defaultParamNames : {
265 batchKey : '_ext_batch_',
267 constructor : function(config){
269 * @property multiSort
271 * True if this store is currently sorted by more than one field/direction combination.
275 * @property isDestroyed
277 * True if the store has been destroyed already. Read only
280 this.data = new Ext.util.MixedCollection(false);
281 this.data.getKey = function(o){
286 // temporary removed-records cache
289 if(config && config.data){
290 this.inlineData = config.data;
294 Ext.apply(this, config);
297 * See the <code>{@link #baseParams corresponding configuration option}</code>
298 * for a description of this property.
299 * To modify this property see <code>{@link #setBaseParam}</code>.
302 this.baseParams = Ext.isObject(this.baseParams) ? this.baseParams : {};
304 this.paramNames = Ext.applyIf(this.paramNames || {}, this.defaultParamNames);
306 if((this.url || this.api) && !this.proxy){
307 this.proxy = new Ext.data.HttpProxy({url: this.url, api: this.api});
309 // If Store is RESTful, so too is the DataProxy
310 if (this.restful === true && this.proxy) {
311 // When operating RESTfully, a unique transaction is generated for each record.
312 // TODO might want to allow implemention of faux REST where batch is possible using RESTful routes only.
314 Ext.data.Api.restify(this.proxy);
317 if(this.reader){ // reader passed
318 if(!this.recordType){
319 this.recordType = this.reader.recordType;
321 if(this.reader.onMetaChange){
322 this.reader.onMetaChange = this.reader.onMetaChange.createSequence(this.onMetaChange, this);
324 if (this.writer) { // writer passed
325 if (this.writer instanceof(Ext.data.DataWriter) === false) { // <-- config-object instead of instance.
326 this.writer = this.buildWriter(this.writer);
328 this.writer.meta = this.reader.meta;
329 this.pruneModifiedRecords = true;
334 * The {@link Ext.data.Record Record} constructor as supplied to (or created by) the
335 * {@link Ext.data.DataReader Reader}. Read-only.
336 * <p>If the Reader was constructed by passing in an Array of {@link Ext.data.Field} definition objects,
337 * instead of a Record constructor, it will implicitly create a Record constructor from that Array (see
338 * {@link Ext.data.Record}.{@link Ext.data.Record#create create} for additional details).</p>
339 * <p>This property may be used to create new Records of the type held in this Store, for example:</p><pre><code>
340 // create the data store
341 var store = new Ext.data.ArrayStore({
345 {name: 'price', type: 'float'},
346 {name: 'change', type: 'float'},
347 {name: 'pctChange', type: 'float'},
348 {name: 'lastChange', type: 'date', dateFormat: 'n/j h:ia'}
351 store.loadData(myData);
354 var grid = new Ext.grid.EditorGridPanel({
356 colModel: new Ext.grid.ColumnModel({
358 {id:'company', header: 'Company', width: 160, dataIndex: 'company'},
359 {header: 'Price', renderer: 'usMoney', dataIndex: 'price'},
360 {header: 'Change', renderer: change, dataIndex: 'change'},
361 {header: '% Change', renderer: pctChange, dataIndex: 'pctChange'},
362 {header: 'Last Updated', width: 85,
363 renderer: Ext.util.Format.dateRenderer('m/d/Y'),
364 dataIndex: 'lastChange'}
371 autoExpandColumn: 'company', // match the id specified in the column model
377 handler : function(){
380 company: 'New Company',
381 lastChange: (new Date()).clearTime(),
385 var recId = 3; // provide unique id
386 var p = new store.recordType(defaultData, recId); // create new record
388 store.{@link #insert}(0, p); // insert a new record into the store (also see {@link #add})
389 grid.startEditing(0, 0);
394 * @property recordType
400 * A {@link Ext.util.MixedCollection MixedCollection} containing the defined {@link Ext.data.Field Field}s
401 * for the {@link Ext.data.Record Records} stored in this Store. Read-only.
403 * @type Ext.util.MixedCollection
405 this.fields = this.recordType.prototype.fields;
412 * Fires when the data cache has changed in a bulk manner (e.g., it has been sorted, filtered, etc.) and a
413 * widget that is using this Store as a Record cache should refresh its view.
414 * @param {Store} this
419 * Fires when this store's reader provides new metadata (fields). This is currently only supported for JsonReaders.
420 * @param {Store} this
421 * @param {Object} meta The JSON metadata
426 * Fires when Records have been {@link #add}ed to the Store
427 * @param {Store} this
428 * @param {Ext.data.Record[]} records The array of Records added
429 * @param {Number} index The index at which the record(s) were added
434 * Fires when a Record has been {@link #remove}d from the Store
435 * @param {Store} this
436 * @param {Ext.data.Record} record The Record that was removed
437 * @param {Number} index The index at which the record was removed
442 * Fires when a Record has been updated
443 * @param {Store} this
444 * @param {Ext.data.Record} record The Record that was updated
445 * @param {String} operation The update operation being performed. Value may be one of:
448 Ext.data.Record.REJECT
449 Ext.data.Record.COMMIT
455 * Fires when the data cache has been cleared.
456 * @param {Store} this
457 * @param {Record[]} records The records that were cleared.
462 * <p>Fires if an exception occurs in the Proxy during a remote request.
463 * This event is relayed through the corresponding {@link Ext.data.DataProxy}.
464 * See {@link Ext.data.DataProxy}.{@link Ext.data.DataProxy#exception exception}
465 * for additional details.
466 * @param {misc} misc See {@link Ext.data.DataProxy}.{@link Ext.data.DataProxy#exception exception}
472 * Fires before a request is made for a new data object. If the beforeload handler returns
473 * <tt>false</tt> the {@link #load} action will be canceled.
474 * @param {Store} this
475 * @param {Object} options The loading options that were specified (see {@link #load} for details)
480 * Fires after a new set of Records has been loaded.
481 * @param {Store} this
482 * @param {Ext.data.Record[]} records The Records that were loaded
483 * @param {Object} options The loading options that were specified (see {@link #load} for details)
487 * @event loadexception
488 * <p>This event is <b>deprecated</b> in favor of the catch-all <b><code>{@link #exception}</code></b>
490 * <p>This event is relayed through the corresponding {@link Ext.data.DataProxy}.
491 * See {@link Ext.data.DataProxy}.{@link Ext.data.DataProxy#loadexception loadexception}
492 * for additional details.
493 * @param {misc} misc See {@link Ext.data.DataProxy}.{@link Ext.data.DataProxy#loadexception loadexception}
499 * @param {Ext.data.Store} store
500 * @param {String} action [Ext.data.Api.actions.create|update|destroy]
501 * @param {Record/Record[]} rs The Record(s) being written.
502 * @param {Object} options The loading options that were specified. Edit <code>options.params</code> to add Http parameters to the request. (see {@link #save} for details)
503 * @param {Object} arg The callback's arg object passed to the {@link #request} function
508 * Fires if the server returns 200 after an Ext.data.Api.actions CRUD action.
509 * Success of the action is determined in the <code>result['successProperty']</code>property (<b>NOTE</b> for RESTful stores,
510 * a simple 20x response is sufficient for the actions "destroy" and "update". The "create" action should should return 200 along with a database pk).
511 * @param {Ext.data.Store} store
512 * @param {String} action [Ext.data.Api.actions.create|update|destroy]
513 * @param {Object} result The 'data' picked-out out of the response for convenience.
514 * @param {Ext.Direct.Transaction} res
515 * @param {Record/Record[]} rs Store's records, the subject(s) of the write-action
520 * Fires before a save action is called. A save encompasses destroying records, updating records and creating records.
521 * @param {Ext.data.Store} store
522 * @param {Object} data An object containing the data that is to be saved. The object will contain a key for each appropriate action,
523 * with an array of records for each action.
528 * Fires after a save is completed. A save encompasses destroying records, updating records and creating records.
529 * @param {Ext.data.Store} store
530 * @param {Number} batch The identifier for the batch that was saved.
531 * @param {Object} data An object containing the data that is to be saved. The object will contain a key for each appropriate action,
532 * with an array of records for each action.
539 // TODO remove deprecated loadexception with ext-3.0.1
540 this.relayEvents(this.proxy, ['loadexception', 'exception']);
542 // With a writer set for the Store, we want to listen to add/remove events to remotely create/destroy records.
546 add: this.createRecords,
547 remove: this.destroyRecord,
548 update: this.updateRecord,
553 this.sortToggle = {};
555 this.setDefaultSort(this.sortField, this.sortDir);
556 }else if(this.sortInfo){
557 this.setDefaultSort(this.sortInfo.field, this.sortInfo.direction);
560 Ext.data.Store.superclass.constructor.call(this);
563 this.storeId = this.id;
567 Ext.StoreMgr.register(this);
570 this.loadData(this.inlineData);
571 delete this.inlineData;
572 }else if(this.autoLoad){
573 this.load.defer(10, this, [
574 typeof this.autoLoad == 'object' ?
575 this.autoLoad : undefined]);
577 // used internally to uniquely identify a batch
578 this.batchCounter = 0;
583 * builds a DataWriter instance when Store constructor is provided with a writer config-object instead of an instace.
584 * @param {Object} config Writer configuration
585 * @return {Ext.data.DataWriter}
588 buildWriter : function(config) {
589 var klass = undefined,
590 type = (config.format || 'json').toLowerCase();
593 klass = Ext.data.JsonWriter;
596 klass = Ext.data.XmlWriter;
599 klass = Ext.data.JsonWriter;
601 return new klass(config);
605 * Destroys the store.
607 destroy : function(){
608 if(!this.isDestroyed){
610 Ext.StoreMgr.unregister(this);
614 Ext.destroy(this.proxy);
615 this.reader = this.writer = null;
616 this.purgeListeners();
617 this.isDestroyed = true;
622 * Add Records to the Store and fires the {@link #add} event. To add Records
623 * to the store from a remote source use <code>{@link #load}({add:true})</code>.
624 * See also <code>{@link #recordType}</code> and <code>{@link #insert}</code>.
625 * @param {Ext.data.Record[]} records An Array of Ext.data.Record objects
626 * to add to the cache. See {@link #recordType}.
628 add : function(records) {
629 var i, len, record, index;
631 records = [].concat(records);
632 if (records.length < 1) {
636 for (i = 0, len = records.length; i < len; i++) {
641 if (record.dirty || record.phantom) {
642 this.modified.push(record);
646 index = this.data.length;
647 this.data.addAll(records);
650 this.snapshot.addAll(records);
653 this.fireEvent('add', this, records, index);
657 * (Local sort only) Inserts the passed Record into the Store at the index where it
658 * should go based on the current sort information.
659 * @param {Ext.data.Record} record
661 addSorted : function(record){
662 var index = this.findInsertIndex(record);
663 this.insert(index, record);
668 * Update a record within the store with a new reference
670 doUpdate : function(rec){
671 this.data.replace(rec.id, rec);
673 this.snapshot.replace(rec.id, rec);
675 this.fireEvent('update', this, rec, Ext.data.Record.COMMIT);
679 * Remove Records from the Store and fires the {@link #remove} event.
680 * @param {Ext.data.Record/Ext.data.Record[]} record The record object or array of records to remove from the cache.
682 remove : function(record){
683 if(Ext.isArray(record)){
684 Ext.each(record, function(r){
689 var index = this.data.indexOf(record);
692 this.data.removeAt(index);
694 if(this.pruneModifiedRecords){
695 this.modified.remove(record);
698 this.snapshot.remove(record);
701 this.fireEvent('remove', this, record, index);
706 * Remove a Record from the Store at the specified index. Fires the {@link #remove} event.
707 * @param {Number} index The index of the record to remove.
709 removeAt : function(index){
710 this.remove(this.getAt(index));
714 * Remove all Records from the Store and fires the {@link #clear} event.
715 * @param {Boolean} silent [false] Defaults to <tt>false</tt>. Set <tt>true</tt> to not fire clear event.
717 removeAll : function(silent){
719 this.each(function(rec){
724 this.snapshot.clear();
726 if(this.pruneModifiedRecords){
729 if (silent !== true) { // <-- prevents write-actions when we just want to clear a store.
730 this.fireEvent('clear', this, items);
735 onClear: function(store, records){
736 Ext.each(records, function(rec, index){
737 this.destroyRecord(this, rec, index);
742 * Inserts Records into the Store at the given index and fires the {@link #add} event.
743 * See also <code>{@link #add}</code> and <code>{@link #addSorted}</code>.
744 * @param {Number} index The start index at which to insert the passed Records.
745 * @param {Ext.data.Record[]} records An Array of Ext.data.Record objects to add to the cache.
747 insert : function(index, records) {
750 records = [].concat(records);
751 for (i = 0, len = records.length; i < len; i++) {
754 this.data.insert(index + i, record);
757 if (record.dirty || record.phantom) {
758 this.modified.push(record);
763 this.snapshot.addAll(records);
766 this.fireEvent('add', this, records, index);
770 * Get the index within the cache of the passed Record.
771 * @param {Ext.data.Record} record The Ext.data.Record object to find.
772 * @return {Number} The index of the passed Record. Returns -1 if not found.
774 indexOf : function(record){
775 return this.data.indexOf(record);
779 * Get the index within the cache of the Record with the passed id.
780 * @param {String} id The id of the Record to find.
781 * @return {Number} The index of the Record. Returns -1 if not found.
783 indexOfId : function(id){
784 return this.data.indexOfKey(id);
788 * Get the Record with the specified id.
789 * @param {String} id The id of the Record to find.
790 * @return {Ext.data.Record} The Record with the passed id. Returns undefined if not found.
792 getById : function(id){
793 return (this.snapshot || this.data).key(id);
797 * Get the Record at the specified index.
798 * @param {Number} index The index of the Record to find.
799 * @return {Ext.data.Record} The Record at the passed index. Returns undefined if not found.
801 getAt : function(index){
802 return this.data.itemAt(index);
806 * Returns a range of Records between specified indices.
807 * @param {Number} startIndex (optional) The starting index (defaults to 0)
808 * @param {Number} endIndex (optional) The ending index (defaults to the last Record in the Store)
809 * @return {Ext.data.Record[]} An array of Records
811 getRange : function(start, end){
812 return this.data.getRange(start, end);
816 storeOptions : function(o){
817 o = Ext.apply({}, o);
820 this.lastOptions = o;
824 clearData: function(){
825 this.data.each(function(rec) {
832 * <p>Loads the Record cache from the configured <tt>{@link #proxy}</tt> using the configured <tt>{@link #reader}</tt>.</p>
833 * <br><p>Notes:</p><div class="mdetail-params"><ul>
834 * <li><b><u>Important</u></b>: loading is asynchronous! This call will return before the new data has been
835 * loaded. To perform any post-processing where information from the load call is required, specify
836 * the <tt>callback</tt> function to be called, or use a {@link Ext.util.Observable#listeners a 'load' event handler}.</li>
837 * <li>If using {@link Ext.PagingToolbar remote paging}, the first load call must specify the <tt>start</tt> and <tt>limit</tt>
838 * properties in the <code>options.params</code> property to establish the initial position within the
839 * dataset, and the number of Records to cache on each read from the Proxy.</li>
840 * <li>If using {@link #remoteSort remote sorting}, the configured <code>{@link #sortInfo}</code>
841 * will be automatically included with the posted parameters according to the specified
842 * <code>{@link #paramNames}</code>.</li>
844 * @param {Object} options An object containing properties which control loading options:<ul>
845 * <li><b><tt>params</tt></b> :Object<div class="sub-desc"><p>An object containing properties to pass as HTTP
846 * parameters to a remote data source. <b>Note</b>: <code>params</code> will override any
847 * <code>{@link #baseParams}</code> of the same name.</p>
848 * <p>Parameters are encoded as standard HTTP parameters using {@link Ext#urlEncode}.</p></div></li>
849 * <li><b>callback</b> : Function<div class="sub-desc"><p>A function to be called after the Records
850 * have been loaded. The callback is called after the load event is fired, and is passed the following arguments:<ul>
851 * <li>r : Ext.data.Record[] An Array of Records loaded.</li>
852 * <li>options : Options object from the load call.</li>
853 * <li>success : Boolean success indicator.</li></ul></p></div></li>
854 * <li><b>scope</b> : Object<div class="sub-desc"><p>Scope with which to call the callback (defaults
855 * to the Store object)</p></div></li>
856 * <li><b>add</b> : Boolean<div class="sub-desc"><p>Indicator to append loaded records rather than
857 * replace the current cache. <b>Note</b>: see note for <tt>{@link #loadData}</tt></p></div></li>
859 * @return {Boolean} If the <i>developer</i> provided <tt>{@link #beforeload}</tt> event handler returns
860 * <tt>false</tt>, the load call will abort and will return <tt>false</tt>; otherwise will return <tt>true</tt>.
862 load : function(options) {
863 options = Ext.apply({}, options);
864 this.storeOptions(options);
865 if(this.sortInfo && this.remoteSort){
866 var pn = this.paramNames;
867 options.params = Ext.apply({}, options.params);
868 options.params[pn.sort] = this.sortInfo.field;
869 options.params[pn.dir] = this.sortInfo.direction;
872 return this.execute('read', null, options); // <-- null represents rs. No rs for load actions.
874 this.handleException(e);
880 * updateRecord Should not be used directly. This method will be called automatically if a Writer is set.
881 * Listens to 'update' event.
882 * @param {Object} store
883 * @param {Object} record
884 * @param {Object} action
887 updateRecord : function(store, record, action) {
888 if (action == Ext.data.Record.EDIT && this.autoSave === true && (!record.phantom || (record.phantom && record.isValid()))) {
895 * Should not be used directly. Store#add will call this automatically if a Writer is set
896 * @param {Object} store
897 * @param {Object} records
898 * @param {Object} index
900 createRecords : function(store, records, index) {
901 var modified = this.modified,
902 length = records.length,
905 for (i = 0; i < length; i++) {
908 if (record.phantom && record.isValid()) {
909 record.markDirty(); // <-- Mark new records dirty (Ed: why?)
911 if (modified.indexOf(record) == -1) {
912 modified.push(record);
916 if (this.autoSave === true) {
922 * Destroys a Record. Should not be used directly. It's called by Store#remove if a Writer is set.
923 * @param {Store} store this
924 * @param {Ext.data.Record} record
925 * @param {Number} index
928 destroyRecord : function(store, record, index) {
929 if (this.modified.indexOf(record) != -1) { // <-- handled already if @cfg pruneModifiedRecords == true
930 this.modified.remove(record);
932 if (!record.phantom) {
933 this.removed.push(record);
935 // since the record has already been removed from the store but the server request has not yet been executed,
936 // must keep track of the last known index this record existed. If a server error occurs, the record can be
937 // put back into the store. @see Store#createCallback where the record is returned when response status === false
938 record.lastIndex = index;
940 if (this.autoSave === true) {
947 * This method should generally not be used directly. This method is called internally
948 * by {@link #load}, or if a Writer is set will be called automatically when {@link #add},
949 * {@link #remove}, or {@link #update} events fire.
950 * @param {String} action Action name ('read', 'create', 'update', or 'destroy')
951 * @param {Record/Record[]} rs
952 * @param {Object} options
956 execute : function(action, rs, options, /* private */ batch) {
957 // blow up if action not Ext.data.CREATE, READ, UPDATE, DESTROY
958 if (!Ext.data.Api.isAction(action)) {
959 throw new Ext.data.Api.Error('execute', action);
961 // make sure options has a fresh, new params hash
962 options = Ext.applyIf(options||{}, {
965 if(batch !== undefined){
966 this.addToBatch(batch);
968 // have to separate before-events since load has a different signature than create,destroy and save events since load does not
969 // include the rs (record resultset) parameter. Capture return values from the beforeaction into doRequest flag.
970 var doRequest = true;
972 if (action === 'read') {
973 doRequest = this.fireEvent('beforeload', this, options);
974 Ext.applyIf(options.params, this.baseParams);
977 // if Writer is configured as listful, force single-record rs to be [{}] instead of {}
978 // TODO Move listful rendering into DataWriter where the @cfg is defined. Should be easy now.
979 if (this.writer.listful === true && this.restful !== true) {
980 rs = (Ext.isArray(rs)) ? rs : [rs];
982 // if rs has just a single record, shift it off so that Writer writes data as '{}' rather than '[{}]'
983 else if (Ext.isArray(rs) && rs.length == 1) {
986 // Write the action to options.params
987 if ((doRequest = this.fireEvent('beforewrite', this, action, rs, options)) !== false) {
988 this.writer.apply(options.params, this.baseParams, action, rs);
991 if (doRequest !== false) {
992 // Send request to proxy.
993 if (this.writer && this.proxy.url && !this.proxy.restful && !Ext.data.Api.hasUniqueUrl(this.proxy, action)) {
994 options.params.xaction = action; // <-- really old, probaby unecessary.
996 // Note: Up until this point we've been dealing with 'action' as a key from Ext.data.Api.actions.
997 // We'll flip it now and send the value into DataProxy#request, since it's the value which maps to
998 // the user's configured DataProxy#api
999 // TODO Refactor all Proxies to accept an instance of Ext.data.Request (not yet defined) instead of this looooooong list
1000 // of params. This method is an artifact from Ext2.
1001 this.proxy.request(Ext.data.Api.actions[action], rs, options.params, this.reader, this.createCallback(action, rs, batch), this, options);
1007 * Saves all pending changes to the store. If the commensurate Ext.data.Api.actions action is not configured, then
1008 * the configured <code>{@link #url}</code> will be used.
1011 * --------------- --------------------
1012 * removed records Ext.data.Api.actions.destroy
1013 * phantom records Ext.data.Api.actions.create
1014 * {@link #getModifiedRecords modified records} Ext.data.Api.actions.update
1016 * @TODO: Create extensions of Error class and send associated Record with thrown exceptions.
1017 * e.g.: Ext.data.DataReader.Error or Ext.data.Error or Ext.data.DataProxy.Error, etc.
1018 * @return {Number} batch Returns a number to uniquely identify the "batch" of saves occurring. -1 will be returned
1019 * if there are no items to save or the save was cancelled.
1023 throw new Ext.data.Store.Error('writer-undefined');
1032 // DESTROY: First check for removed records. Records in this.removed are guaranteed non-phantoms. @see Store#remove
1033 if(this.removed.length){
1034 queue.push(['destroy', this.removed]);
1037 // Check for modified records. Use a copy so Store#rejectChanges will work if server returns error.
1038 var rs = [].concat(this.getModifiedRecords());
1040 // CREATE: Next check for phantoms within rs. splice-off and execute create.
1042 for(i = rs.length-1; i >= 0; i--){
1043 if(rs[i].phantom === true){
1044 var rec = rs.splice(i, 1).shift();
1048 }else if(!rs[i].isValid()){ // <-- while we're here, splice-off any !isValid real records
1052 // If we have valid phantoms, create them...
1053 if(phantoms.length){
1054 queue.push(['create', phantoms]);
1057 // UPDATE: And finally, if we're still here after splicing-off phantoms and !isValid real records, update the rest...
1059 queue.push(['update', rs]);
1064 batch = ++this.batchCounter;
1065 for(i = 0; i < len; ++i){
1067 data[trans[0]] = trans[1];
1069 if(this.fireEvent('beforesave', this, data) !== false){
1070 for(i = 0; i < len; ++i){
1072 this.doTransaction(trans[0], trans[1], batch);
1080 // private. Simply wraps call to Store#execute in try/catch. Defers to Store#handleException on error. Loops if batch: false
1081 doTransaction : function(action, rs, batch) {
1082 function transaction(records) {
1084 this.execute(action, records, undefined, batch);
1086 this.handleException(e);
1089 if(this.batch === false){
1090 for(var i = 0, len = rs.length; i < len; i++){
1091 transaction.call(this, rs[i]);
1094 transaction.call(this, rs);
1099 addToBatch : function(batch){
1100 var b = this.batches,
1101 key = this.batchKey + batch,
1114 removeFromBatch : function(batch, action, data){
1115 var b = this.batches,
1116 key = this.batchKey + batch,
1122 arr = o.data[action] || [];
1123 o.data[action] = arr.concat(data);
1127 this.fireEvent('save', this, batch, data);
1134 // @private callback-handler for remote CRUD actions
1135 // Do not override -- override loadRecords, onCreateRecords, onDestroyRecords and onUpdateRecords instead.
1136 createCallback : function(action, rs, batch) {
1137 var actions = Ext.data.Api.actions;
1138 return (action == 'read') ? this.loadRecords : function(data, response, success) {
1139 // calls: onCreateRecords | onUpdateRecords | onDestroyRecords
1140 this['on' + Ext.util.Format.capitalize(action) + 'Records'](success, rs, [].concat(data));
1141 // If success === false here, exception will have been called in DataProxy
1142 if (success === true) {
1143 this.fireEvent('write', this, action, data, response, rs);
1145 this.removeFromBatch(batch, action, data);
1149 // Clears records from modified array after an exception event.
1150 // NOTE: records are left marked dirty. Do we want to commit them even though they were not updated/realized?
1151 // TODO remove this method?
1152 clearModified : function(rs) {
1153 if (Ext.isArray(rs)) {
1154 for (var n=rs.length-1;n>=0;n--) {
1155 this.modified.splice(this.modified.indexOf(rs[n]), 1);
1158 this.modified.splice(this.modified.indexOf(rs), 1);
1162 // remap record ids in MixedCollection after records have been realized. @see Store#onCreateRecords, @see DataReader#realize
1163 reMap : function(record) {
1164 if (Ext.isArray(record)) {
1165 for (var i = 0, len = record.length; i < len; i++) {
1166 this.reMap(record[i]);
1169 delete this.data.map[record._phid];
1170 this.data.map[record.id] = record;
1171 var index = this.data.keys.indexOf(record._phid);
1172 this.data.keys.splice(index, 1, record.id);
1173 delete record._phid;
1177 // @protected onCreateRecord proxy callback for create action
1178 onCreateRecords : function(success, rs, data) {
1179 if (success === true) {
1181 this.reader.realize(rs, data);
1185 this.handleException(e);
1186 if (Ext.isArray(rs)) {
1187 // Recurse to run back into the try {}. DataReader#realize splices-off the rs until empty.
1188 this.onCreateRecords(success, rs, data);
1194 // @protected, onUpdateRecords proxy callback for update action
1195 onUpdateRecords : function(success, rs, data) {
1196 if (success === true) {
1198 this.reader.update(rs, data);
1200 this.handleException(e);
1201 if (Ext.isArray(rs)) {
1202 // Recurse to run back into the try {}. DataReader#update splices-off the rs until empty.
1203 this.onUpdateRecords(success, rs, data);
1209 // @protected onDestroyRecords proxy callback for destroy action
1210 onDestroyRecords : function(success, rs, data) {
1211 // splice each rec out of this.removed
1212 rs = (rs instanceof Ext.data.Record) ? [rs] : [].concat(rs);
1213 for (var i=0,len=rs.length;i<len;i++) {
1214 this.removed.splice(this.removed.indexOf(rs[i]), 1);
1216 if (success === false) {
1217 // put records back into store if remote destroy fails.
1218 // @TODO: Might want to let developer decide.
1219 for (i=rs.length-1;i>=0;i--) {
1220 this.insert(rs[i].lastIndex, rs[i]); // <-- lastIndex set in Store#destroyRecord
1225 // protected handleException. Possibly temporary until Ext framework has an exception-handler.
1226 handleException : function(e) {
1227 // @see core/Error.js
1232 * <p>Reloads the Record cache from the configured Proxy using the configured
1233 * {@link Ext.data.Reader Reader} and the options from the last load operation
1235 * <p><b>Note</b>: see the Important note in {@link #load}.</p>
1236 * @param {Object} options <p>(optional) An <tt>Object</tt> containing
1237 * {@link #load loading options} which may override the {@link #lastOptions options}
1238 * used in the last {@link #load} operation. See {@link #load} for details
1239 * (defaults to <tt>null</tt>, in which case the {@link #lastOptions} are
1241 * <br><p>To add new params to the existing params:</p><pre><code>
1242 lastOptions = myStore.lastOptions;
1243 Ext.apply(lastOptions.params, {
1246 myStore.reload(lastOptions);
1249 reload : function(options){
1250 this.load(Ext.applyIf(options||{}, this.lastOptions));
1254 // Called as a callback by the Reader during a load operation.
1255 loadRecords : function(o, options, success){
1258 if (this.isDestroyed === true) {
1261 if(!o || success === false){
1262 if(success !== false){
1263 this.fireEvent('load', this, [], options);
1265 if(options.callback){
1266 options.callback.call(options.scope || this, [], options, false, o);
1270 var r = o.records, t = o.totalRecords || r.length;
1271 if(!options || options.add !== true){
1272 if(this.pruneModifiedRecords){
1275 for(i = 0, len = r.length; i < len; i++){
1279 this.data = this.snapshot;
1280 delete this.snapshot;
1283 this.data.addAll(r);
1284 this.totalLength = t;
1286 this.fireEvent('datachanged', this);
1291 for(i = 0, len = r.length; i < len; ++i){
1293 if(this.indexOfId(rec.id) > -1){
1300 this.totalLength = Math.max(t, this.data.length + cnt);
1303 this.fireEvent('load', this, r, options);
1304 if(options.callback){
1305 options.callback.call(options.scope || this, r, options, true);
1310 * Loads data from a passed data block and fires the {@link #load} event. A {@link Ext.data.Reader Reader}
1311 * which understands the format of the data must have been configured in the constructor.
1312 * @param {Object} data The data block from which to read the Records. The format of the data expected
1313 * is dependent on the type of {@link Ext.data.Reader Reader} that is configured and should correspond to
1314 * that {@link Ext.data.Reader Reader}'s <tt>{@link Ext.data.Reader#readRecords}</tt> parameter.
1315 * @param {Boolean} append (Optional) <tt>true</tt> to append the new Records rather the default to replace
1316 * the existing cache.
1317 * <b>Note</b>: that Records in a Store are keyed by their {@link Ext.data.Record#id id}, so added Records
1318 * with ids which are already present in the Store will <i>replace</i> existing Records. Only Records with
1319 * new, unique ids will be added.
1321 loadData : function(o, append){
1322 var r = this.reader.readRecords(o);
1323 this.loadRecords(r, {add: append}, true);
1327 * Gets the number of cached records.
1328 * <p>If using paging, this may not be the total size of the dataset. If the data object
1329 * used by the Reader contains the dataset size, then the {@link #getTotalCount} function returns
1330 * the dataset size. <b>Note</b>: see the Important note in {@link #load}.</p>
1331 * @return {Number} The number of Records in the Store's cache.
1333 getCount : function(){
1334 return this.data.length || 0;
1338 * Gets the total number of records in the dataset as returned by the server.
1339 * <p>If using paging, for this to be accurate, the data object used by the {@link #reader Reader}
1340 * must contain the dataset size. For remote data sources, the value for this property
1341 * (<tt>totalProperty</tt> for {@link Ext.data.JsonReader JsonReader},
1342 * <tt>totalRecords</tt> for {@link Ext.data.XmlReader XmlReader}) shall be returned by a query on the server.
1343 * <b>Note</b>: see the Important note in {@link #load}.</p>
1344 * @return {Number} The number of Records as specified in the data object passed to the Reader
1346 * <p><b>Note</b>: this value is not updated when changing the contents of the Store locally.</p>
1348 getTotalCount : function(){
1349 return this.totalLength || 0;
1353 * Returns an object describing the current sort state of this Store.
1354 * @return {Object} The sort state of the Store. An object with two properties:<ul>
1355 * <li><b>field : String<p class="sub-desc">The name of the field by which the Records are sorted.</p></li>
1356 * <li><b>direction : String<p class="sub-desc">The sort order, 'ASC' or 'DESC' (case-sensitive).</p></li>
1358 * See <tt>{@link #sortInfo}</tt> for additional details.
1360 getSortState : function(){
1361 return this.sortInfo;
1366 * Invokes sortData if we have sortInfo to sort on and are not sorting remotely
1368 applySort : function(){
1369 if ((this.sortInfo || this.multiSortInfo) && !this.remoteSort) {
1376 * Performs the actual sorting of data. This checks to see if we currently have a multi sort or not. It applies
1377 * each sorter field/direction pair in turn by building an OR'ed master sorting function and running it against
1380 sortData : function() {
1381 var sortInfo = this.hasMultiSort ? this.multiSortInfo : this.sortInfo,
1382 direction = sortInfo.direction || "ASC",
1383 sorters = sortInfo.sorters,
1386 //if we just have a single sorter, pretend it's the first in an array
1387 if (!this.hasMultiSort) {
1388 sorters = [{direction: direction, field: sortInfo.field}];
1391 //create a sorter function for each sorter field/direction combo
1392 for (var i=0, j = sorters.length; i < j; i++) {
1393 sortFns.push(this.createSortFunction(sorters[i].field, sorters[i].direction));
1396 if (sortFns.length == 0) {
1400 //the direction modifier is multiplied with the result of the sorting functions to provide overall sort direction
1401 //(as opposed to direction per field)
1402 var directionModifier = direction.toUpperCase() == "DESC" ? -1 : 1;
1404 //create a function which ORs each sorter together to enable multi-sort
1405 var fn = function(r1, r2) {
1406 var result = sortFns[0].call(this, r1, r2);
1408 //if we have more than one sorter, OR any additional sorter functions together
1409 if (sortFns.length > 1) {
1410 for (var i=1, j = sortFns.length; i < j; i++) {
1411 result = result || sortFns[i].call(this, r1, r2);
1415 return directionModifier * result;
1419 this.data.sort(direction, fn);
1420 if (this.snapshot && this.snapshot != this.data) {
1421 this.snapshot.sort(direction, fn);
1427 * Creates and returns a function which sorts an array by the given field and direction
1428 * @param {String} field The field to create the sorter for
1429 * @param {String} direction The direction to sort by (defaults to "ASC")
1430 * @return {Function} A function which sorts by the field/direction combination provided
1432 createSortFunction: function(field, direction) {
1433 direction = direction || "ASC";
1434 var directionModifier = direction.toUpperCase() == "DESC" ? -1 : 1;
1436 var sortType = this.fields.get(field).sortType;
1438 //create a comparison function. Takes 2 records, returns 1 if record 1 is greater,
1439 //-1 if record 2 is greater or 0 if they are equal
1440 return function(r1, r2) {
1441 var v1 = sortType(r1.data[field]),
1442 v2 = sortType(r2.data[field]);
1444 return directionModifier * (v1 > v2 ? 1 : (v1 < v2 ? -1 : 0));
1449 * Sets the default sort column and order to be used by the next {@link #load} operation.
1450 * @param {String} fieldName The name of the field to sort by.
1451 * @param {String} dir (optional) The sort order, 'ASC' or 'DESC' (case-sensitive, defaults to <tt>'ASC'</tt>)
1453 setDefaultSort : function(field, dir) {
1454 dir = dir ? dir.toUpperCase() : 'ASC';
1455 this.sortInfo = {field: field, direction: dir};
1456 this.sortToggle[field] = dir;
1461 * If remote sorting is used, the sort is performed on the server, and the cache is reloaded. If local
1462 * sorting is used, the cache is sorted internally. See also {@link #remoteSort} and {@link #paramNames}.
1463 * This function accepts two call signatures - pass in a field name as the first argument to sort on a single
1464 * field, or pass in an array of sort configuration objects to sort by multiple fields.
1465 * Single sort example:
1466 * store.sort('name', 'ASC');
1467 * Multi sort example:
1478 * In this second form, the sort configs are applied in order, with later sorters sorting within earlier sorters' results.
1479 * For example, if two records with the same name are present they will also be sorted by salary if given the sort configs
1480 * above. Any number of sort configs can be added.
1481 * @param {String/Array} fieldName The name of the field to sort by, or an array of ordered sort configs
1482 * @param {String} dir (optional) The sort order, 'ASC' or 'DESC' (case-sensitive, defaults to <tt>'ASC'</tt>)
1484 sort : function(fieldName, dir) {
1485 if (Ext.isArray(arguments[0])) {
1486 return this.multiSort.call(this, fieldName, dir);
1488 return this.singleSort(fieldName, dir);
1493 * Sorts the store contents by a single field and direction. This is called internally by {@link sort} and would
1494 * not usually be called manually
1495 * @param {String} fieldName The name of the field to sort by.
1496 * @param {String} dir (optional) The sort order, 'ASC' or 'DESC' (case-sensitive, defaults to <tt>'ASC'</tt>)
1498 singleSort: function(fieldName, dir) {
1499 var field = this.fields.get(fieldName);
1504 var name = field.name,
1505 sortInfo = this.sortInfo || null,
1506 sortToggle = this.sortToggle ? this.sortToggle[name] : null;
1509 if (sortInfo && sortInfo.field == name) { // toggle sort dir
1510 dir = (this.sortToggle[name] || 'ASC').toggle('ASC', 'DESC');
1512 dir = field.sortDir;
1516 this.sortToggle[name] = dir;
1517 this.sortInfo = {field: name, direction: dir};
1518 this.hasMultiSort = false;
1520 if (this.remoteSort) {
1521 if (!this.load(this.lastOptions)) {
1523 this.sortToggle[name] = sortToggle;
1526 this.sortInfo = sortInfo;
1531 this.fireEvent('datachanged', this);
1537 * Sorts the contents of this store by multiple field/direction sorters. This is called internally by {@link sort}
1538 * and would not usually be called manually.
1539 * Multi sorting only currently applies to local datasets - multiple sort data is not currently sent to a proxy
1540 * if remoteSort is used.
1541 * @param {Array} sorters Array of sorter objects (field and direction)
1542 * @param {String} direction Overall direction to sort the ordered results by (defaults to "ASC")
1544 multiSort: function(sorters, direction) {
1545 this.hasMultiSort = true;
1546 direction = direction || "ASC";
1548 //toggle sort direction
1549 if (this.multiSortInfo && direction == this.multiSortInfo.direction) {
1550 direction = direction.toggle("ASC", "DESC");
1554 * Object containing overall sort direction and an ordered array of sorter configs used when sorting on multiple fields
1555 * @property multiSortInfo
1558 this.multiSortInfo = {
1560 direction: direction
1563 if (this.remoteSort) {
1564 this.singleSort(sorters[0].field, sorters[0].direction);
1568 this.fireEvent('datachanged', this);
1573 * Calls the specified function for each of the {@link Ext.data.Record Records} in the cache.
1574 * @param {Function} fn The function to call. The {@link Ext.data.Record Record} is passed as the first parameter.
1575 * Returning <tt>false</tt> aborts and exits the iteration.
1576 * @param {Object} scope (optional) The scope (<code>this</code> reference) in which the function is executed.
1577 * Defaults to the current {@link Ext.data.Record Record} in the iteration.
1579 each : function(fn, scope){
1580 this.data.each(fn, scope);
1584 * Gets all {@link Ext.data.Record records} modified since the last commit. Modified records are
1585 * persisted across load operations (e.g., during paging). <b>Note</b>: deleted records are not
1586 * included. See also <tt>{@link #pruneModifiedRecords}</tt> and
1587 * {@link Ext.data.Record}<tt>{@link Ext.data.Record#markDirty markDirty}.</tt>.
1588 * @return {Ext.data.Record[]} An array of {@link Ext.data.Record Records} containing outstanding
1589 * modifications. To obtain modified fields within a modified record see
1590 *{@link Ext.data.Record}<tt>{@link Ext.data.Record#modified modified}.</tt>.
1592 getModifiedRecords : function(){
1593 return this.modified;
1597 * Sums the value of <tt>property</tt> for each {@link Ext.data.Record record} between <tt>start</tt>
1598 * and <tt>end</tt> and returns the result.
1599 * @param {String} property A field in each record
1600 * @param {Number} start (optional) The record index to start at (defaults to <tt>0</tt>)
1601 * @param {Number} end (optional) The last record index to include (defaults to length - 1)
1602 * @return {Number} The sum
1604 sum : function(property, start, end){
1605 var rs = this.data.items, v = 0;
1607 end = (end || end === 0) ? end : rs.length-1;
1609 for(var i = start; i <= end; i++){
1610 v += (rs[i].data[property] || 0);
1617 * Returns a filter function used to test a the given property's value. Defers most of the work to
1618 * Ext.util.MixedCollection's createValueMatcher function
1619 * @param {String} property The property to create the filter function for
1620 * @param {String/RegExp} value The string/regex to compare the property value to
1621 * @param {Boolean} anyMatch True if we don't care if the filter value is not the full value (defaults to false)
1622 * @param {Boolean} caseSensitive True to create a case-sensitive regex (defaults to false)
1623 * @param {Boolean} exactMatch True to force exact match (^ and $ characters added to the regex). Defaults to false. Ignored if anyMatch is true.
1625 createFilterFn : function(property, value, anyMatch, caseSensitive, exactMatch){
1626 if(Ext.isEmpty(value, false)){
1629 value = this.data.createValueMatcher(value, anyMatch, caseSensitive, exactMatch);
1630 return function(r) {
1631 return value.test(r.data[property]);
1637 * Given an array of filter functions (each with optional scope), constructs and returns a single function that returns
1638 * the result of all of the filters ANDed together
1639 * @param {Array} filters The array of filter objects (each object should contain an 'fn' and optional scope)
1640 * @return {Function} The multiple filter function
1642 createMultipleFilterFn: function(filters) {
1643 return function(record) {
1646 for (var i=0, j = filters.length; i < j; i++) {
1647 var filter = filters[i],
1649 scope = filter.scope;
1651 isMatch = isMatch && fn.call(scope, record);
1659 * Filter the {@link Ext.data.Record records} by a specified property. Alternatively, pass an array of filter
1660 * options to filter by more than one property.
1661 * Single filter example:
1662 * store.filter('name', 'Ed', true, true); //finds all records containing the substring 'Ed'
1663 * Multiple filter example:
1667 * property : 'name',
1669 * anyMatch : true, //optional, defaults to true
1670 * caseSensitive: true //optional, defaults to true
1673 * //filter functions can also be passed
1675 * fn : function(record) {
1676 * return record.get('age') == 24
1682 * @param {String|Array} field A field on your records, or an array containing multiple filter options
1683 * @param {String/RegExp} value Either a string that the field should begin with, or a RegExp to test
1684 * against the field.
1685 * @param {Boolean} anyMatch (optional) <tt>true</tt> to match any part not just the beginning
1686 * @param {Boolean} caseSensitive (optional) <tt>true</tt> for case sensitive comparison
1687 * @param {Boolean} exactMatch True to force exact match (^ and $ characters added to the regex). Defaults to false. Ignored if anyMatch is true.
1689 filter : function(property, value, anyMatch, caseSensitive, exactMatch){
1691 //we can accept an array of filter objects, or a single filter object - normalize them here
1692 if (Ext.isObject(property)) {
1693 property = [property];
1696 if (Ext.isArray(property)) {
1699 //normalize the filters passed into an array of filter functions
1700 for (var i=0, j = property.length; i < j; i++) {
1701 var filter = property[i],
1703 scope = filter.scope || this;
1705 //if we weren't given a filter function, construct one now
1706 if (!Ext.isFunction(func)) {
1707 func = this.createFilterFn(filter.property, filter.value, filter.anyMatch, filter.caseSensitive, filter.exactMatch);
1710 filters.push({fn: func, scope: scope});
1713 fn = this.createMultipleFilterFn(filters);
1715 //classic single property filter
1716 fn = this.createFilterFn(property, value, anyMatch, caseSensitive, exactMatch);
1719 return fn ? this.filterBy(fn) : this.clearFilter();
1723 * Filter by a function. The specified function will be called for each
1724 * Record in this Store. If the function returns <tt>true</tt> the Record is included,
1725 * otherwise it is filtered out.
1726 * @param {Function} fn The function to be called. It will be passed the following parameters:<ul>
1727 * <li><b>record</b> : Ext.data.Record<p class="sub-desc">The {@link Ext.data.Record record}
1728 * to test for filtering. Access field values using {@link Ext.data.Record#get}.</p></li>
1729 * <li><b>id</b> : Object<p class="sub-desc">The ID of the Record passed.</p></li>
1731 * @param {Object} scope (optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to this Store.
1733 filterBy : function(fn, scope){
1734 this.snapshot = this.snapshot || this.data;
1735 this.data = this.queryBy(fn, scope || this);
1736 this.fireEvent('datachanged', this);
1740 * Revert to a view of the Record cache with no filtering applied.
1741 * @param {Boolean} suppressEvent If <tt>true</tt> the filter is cleared silently without firing the
1742 * {@link #datachanged} event.
1744 clearFilter : function(suppressEvent){
1745 if(this.isFiltered()){
1746 this.data = this.snapshot;
1747 delete this.snapshot;
1748 if(suppressEvent !== true){
1749 this.fireEvent('datachanged', this);
1755 * Returns true if this store is currently filtered
1758 isFiltered : function(){
1759 return !!this.snapshot && this.snapshot != this.data;
1763 * Query the records by a specified property.
1764 * @param {String} field A field on your records
1765 * @param {String/RegExp} value Either a string that the field
1766 * should begin with, or a RegExp to test against the field.
1767 * @param {Boolean} anyMatch (optional) True to match any part not just the beginning
1768 * @param {Boolean} caseSensitive (optional) True for case sensitive comparison
1769 * @return {MixedCollection} Returns an Ext.util.MixedCollection of the matched records
1771 query : function(property, value, anyMatch, caseSensitive){
1772 var fn = this.createFilterFn(property, value, anyMatch, caseSensitive);
1773 return fn ? this.queryBy(fn) : this.data.clone();
1777 * Query the cached records in this Store using a filtering function. The specified function
1778 * will be called with each record in this Store. If the function returns <tt>true</tt> the record is
1779 * included in the results.
1780 * @param {Function} fn The function to be called. It will be passed the following parameters:<ul>
1781 * <li><b>record</b> : Ext.data.Record<p class="sub-desc">The {@link Ext.data.Record record}
1782 * to test for filtering. Access field values using {@link Ext.data.Record#get}.</p></li>
1783 * <li><b>id</b> : Object<p class="sub-desc">The ID of the Record passed.</p></li>
1785 * @param {Object} scope (optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to this Store.
1786 * @return {MixedCollection} Returns an Ext.util.MixedCollection of the matched records
1788 queryBy : function(fn, scope){
1789 var data = this.snapshot || this.data;
1790 return data.filterBy(fn, scope||this);
1794 * Finds the index of the first matching Record in this store by a specific field value.
1795 * @param {String} fieldName The name of the Record field to test.
1796 * @param {String/RegExp} value Either a string that the field value
1797 * should begin with, or a RegExp to test against the field.
1798 * @param {Number} startIndex (optional) The index to start searching at
1799 * @param {Boolean} anyMatch (optional) True to match any part of the string, not just the beginning
1800 * @param {Boolean} caseSensitive (optional) True for case sensitive comparison
1801 * @return {Number} The matched index or -1
1803 find : function(property, value, start, anyMatch, caseSensitive){
1804 var fn = this.createFilterFn(property, value, anyMatch, caseSensitive);
1805 return fn ? this.data.findIndexBy(fn, null, start) : -1;
1809 * Finds the index of the first matching Record in this store by a specific field value.
1810 * @param {String} fieldName The name of the Record field to test.
1811 * @param {Mixed} value The value to match the field against.
1812 * @param {Number} startIndex (optional) The index to start searching at
1813 * @return {Number} The matched index or -1
1815 findExact: function(property, value, start){
1816 return this.data.findIndexBy(function(rec){
1817 return rec.get(property) === value;
1822 * Find the index of the first matching Record in this Store by a function.
1823 * If the function returns <tt>true</tt> it is considered a match.
1824 * @param {Function} fn The function to be called. It will be passed the following parameters:<ul>
1825 * <li><b>record</b> : Ext.data.Record<p class="sub-desc">The {@link Ext.data.Record record}
1826 * to test for filtering. Access field values using {@link Ext.data.Record#get}.</p></li>
1827 * <li><b>id</b> : Object<p class="sub-desc">The ID of the Record passed.</p></li>
1829 * @param {Object} scope (optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to this Store.
1830 * @param {Number} startIndex (optional) The index to start searching at
1831 * @return {Number} The matched index or -1
1833 findBy : function(fn, scope, start){
1834 return this.data.findIndexBy(fn, scope, start);
1838 * Collects unique values for a particular dataIndex from this store.
1839 * @param {String} dataIndex The property to collect
1840 * @param {Boolean} allowNull (optional) Pass true to allow null, undefined or empty string values
1841 * @param {Boolean} bypassFilter (optional) Pass true to collect from all records, even ones which are filtered
1842 * @return {Array} An array of the unique values
1844 collect : function(dataIndex, allowNull, bypassFilter){
1845 var d = (bypassFilter === true && this.snapshot) ?
1846 this.snapshot.items : this.data.items;
1847 var v, sv, r = [], l = {};
1848 for(var i = 0, len = d.length; i < len; i++){
1849 v = d[i].data[dataIndex];
1851 if((allowNull || !Ext.isEmpty(v)) && !l[sv]){
1860 afterEdit : function(record){
1861 if(this.modified.indexOf(record) == -1){
1862 this.modified.push(record);
1864 this.fireEvent('update', this, record, Ext.data.Record.EDIT);
1868 afterReject : function(record){
1869 this.modified.remove(record);
1870 this.fireEvent('update', this, record, Ext.data.Record.REJECT);
1874 afterCommit : function(record){
1875 this.modified.remove(record);
1876 this.fireEvent('update', this, record, Ext.data.Record.COMMIT);
1880 * Commit all Records with {@link #getModifiedRecords outstanding changes}. To handle updates for changes,
1881 * subscribe to the Store's {@link #update update event}, and perform updating when the third parameter is
1882 * Ext.data.Record.COMMIT.
1884 commitChanges : function(){
1885 var modified = this.modified.slice(0),
1886 length = modified.length,
1889 for (i = 0; i < length; i++){
1890 modified[i].commit();
1898 * {@link Ext.data.Record#reject Reject} outstanding changes on all {@link #getModifiedRecords modified records}.
1900 rejectChanges : function() {
1901 var modified = this.modified.slice(0),
1902 removed = this.removed.slice(0).reverse(),
1903 mLength = modified.length,
1904 rLength = removed.length,
1907 for (i = 0; i < mLength; i++) {
1908 modified[i].reject();
1911 for (i = 0; i < rLength; i++) {
1912 this.insert(removed[i].lastIndex || 0, removed[i]);
1913 removed[i].reject();
1921 onMetaChange : function(meta){
1922 this.recordType = this.reader.recordType;
1923 this.fields = this.recordType.prototype.fields;
1924 delete this.snapshot;
1925 if(this.reader.meta.sortInfo){
1926 this.sortInfo = this.reader.meta.sortInfo;
1927 }else if(this.sortInfo && !this.fields.get(this.sortInfo.field)){
1928 delete this.sortInfo;
1931 this.writer.meta = this.reader.meta;
1934 this.fireEvent('metachange', this, this.reader.meta);
1938 findInsertIndex : function(record){
1939 this.suspendEvents();
1940 var data = this.data.clone();
1941 this.data.add(record);
1943 var index = this.data.indexOf(record);
1945 this.resumeEvents();
1950 * Set the value for a property name in this store's {@link #baseParams}. Usage:</p><pre><code>
1951 myStore.setBaseParam('foo', {bar:3});
1953 * @param {String} name Name of the property to assign
1954 * @param {Mixed} value Value to assign the <tt>name</tt>d property
1956 setBaseParam : function (name, value){
1957 this.baseParams = this.baseParams || {};
1958 this.baseParams[name] = value;
1962 Ext.reg('store', Ext.data.Store);
1965 * @class Ext.data.Store.Error
1966 * @extends Ext.Error
1967 * Store Error extension.
1968 * @param {String} name
1970 Ext.data.Store.Error = Ext.extend(Ext.Error, {
1971 name: 'Ext.data.Store'
1973 Ext.apply(Ext.data.Store.Error.prototype, {
1975 'writer-undefined' : 'Attempted to execute a write-action without a DataWriter installed.'