for (var verb in this.actions)
- // For efficiency, some methods will first check this hash for a match. Those methods which do acces validActions will cache their result here.
- // We cannot pre-define this hash since the developer may over-ride the actions at runtime.
- var validActions = {};
-
- return {
- /**
- * Defined actions corresponding to remote actions:
- *
-actions: {
- create : 'create', // Text representing the remote-action to create records on server.
- read : 'read', // Text representing the remote-action to read/load data from server.
- update : 'update', // Text representing the remote-action to update records on server.
- destroy : 'destroy' // Text representing the remote-action to destroy records on server.
-}
- *
-restActions : {
- create : 'POST',
- read : 'GET',
- update : 'PUT',
- destroy : 'DELETE'
-},
- * {@link #actions} constants
- * @param {String} action
- * @param {String[]}(Optional) List of available CRUD actions. Pass in list when executing multiple times for efficiency.
- * @return {Boolean}
- */
- isAction : function(action) {
- return (Ext.data.Api.actions[action]) ? true : false;
- },
-
- /**
- * Returns the actual CRUD action KEY "create", "read", "update" or "destroy" from the supplied action-name. This method is used internally and shouldn't generally
- * need to be used directly. The key/value pair of Ext.data.Api.actions will often be identical but this is not necessarily true. A developer can override this naming
- * convention if desired. However, the framework internally calls methods based upon the KEY so a way of retreiving the the words "create", "read", "update" and "destroy" is
- * required. This method will cache discovered KEYS into the private validActions hash.
- * @param {String} name The runtime name of the action.
- * @return {String||null} returns the action-key, or verb of the user-action or null if invalid.
- * @nodoc
- */
- getVerb : function(name) {
- if (validActions[name]) {
- return validActions[name]; // <-- found in cache. return immediately.
- }
- for (var verb in this.actions) {
- if (this.actions[verb] === name) {
- validActions[name] = verb;
- break;
- }
- }
- return (validActions[name] !== undefined) ? validActions[name] : null;
- },
-
- /**
- * Returns true if the supplied API is valid; that is, check that all keys match defined actions
- * otherwise returns an array of mistakes.
- * @return {String[]||true}
- */
- isValid : function(api){
- var invalid = [];
- var crud = this.actions; // <-- cache a copy of the actions.
- for (var action in api) {
- if (!(action in crud)) {
- invalid.push(action);
- }
- }
- return (!invalid.length) ? true : invalid;
- },
-
- /**
- * Returns true if the supplied verb upon the supplied proxy points to a unique url in that none of the other api-actions
- * point to the same url. The question is important for deciding whether to insert the "xaction" HTTP parameter within an
- * Ajax request. This method is used internally and shouldn't generally need to be called directly.
- * @param {Ext.data.DataProxy} proxy
- * @param {String} verb
- * @return {Boolean}
- */
- hasUniqueUrl : function(proxy, verb) {
- var url = (proxy.api[verb]) ? proxy.api[verb].url : null;
- var unique = true;
- for (var action in proxy.api) {
- if ((unique = (action === verb) ? true : (proxy.api[action].url != url) ? true : false) === false) {
- break;
- }
- }
- return unique;
- },
-
- /**
- * This method is used internally by {@link Ext.data.DataProxy DataProxy} and should not generally need to be used directly.
- * Each action of a DataProxy api can be initially defined as either a String or an Object. When specified as an object,
- * one can explicitly define the HTTP method (GET|POST) to use for each CRUD action. This method will prepare the supplied API, setting
- * each action to the Object form. If your API-actions do not explicitly define the HTTP method, the "method" configuration-parameter will
- * be used. If the method configuration parameter is not specified, POST will be used.
-
-new Ext.data.HttpProxy({
- method: "POST", // <-- default HTTP method when not specified.
- api: {
- create: 'create.php',
- load: 'read.php',
- save: 'save.php',
- destroy: 'destroy.php'
- }
-});
-
-// Alternatively, one can use the object-form to specify the API
-new Ext.data.HttpProxy({
- api: {
- load: {url: 'read.php', method: 'GET'},
- create: 'create.php',
- destroy: 'destroy.php',
- save: 'update.php'
- }
-});
- Instances of this class encapsulate both Record definition information, and Record - * value information for use in {@link Ext.data.Store} objects, or any code which needs - * to access Records cached in an {@link Ext.data.Store} object.
- *Constructors for this class are generated by passing an Array of field definition objects to {@link #create}. - * Instances are usually only created by {@link Ext.data.Reader} implementations when processing unformatted data - * objects.
- *Note that an instance of a Record class may only belong to one {@link Ext.data.Store Store} at a time. - * In order to copy data from one Store to another, use the {@link #copy} method to create an exact - * copy of the Record, and insert the new instance into the other Store.
- *When serializing a Record for submission to the server, be aware that it contains many private
- * properties, and also a reference to its owning Store which in turn holds references to its Records.
- * This means that a whole Record may not be encoded using {@link Ext.util.JSON.encode}. Instead, use the
- * {@link #data} and {@link #id} properties.
Record objects generated by this constructor inherit all the methods of Ext.data.Record listed below.
- * @constructor - * This constructor should not be used to create Record objects. Instead, use {@link #create} to - * generate a subclass of Ext.data.Record configured with information about its constituent fields. - * @param {Object} data (Optional) An object, the properties of which provide values for the new Record's - * fields. If not specified the{@link Ext.data.Field#defaultValue defaultValue}
- * for each field will be assigned.
- * @param {Object} id (Optional) The id of the Record. This id should be unique, and is used by the
- * {@link Ext.data.Store} object which owns the Record to index its collection of Records. If
- * an id is not specified a {@link #phantom} Record will be created
- * with an {@link #Record.id automatically generated id}.
- */
-Ext.data.Record = function(data, id){
- // if no id, call the auto id method
- this.id = (id || id === 0) ? id : Ext.data.Record.id(this);
- this.data = data || {};
-};
-
-/**
- * Generate a constructor for a specific Record layout.
- * @param {Array} o An Array of {@link Ext.data.Field Field} definition objects.
- * The constructor generated by this method may be used to create new Record instances. The data
- * object must contain properties named after the {@link Ext.data.Field field}
- * {@link Ext.data.Field#name}s. Example usage:
-// create a Record constructor from a description of the fields
-var TopicRecord = Ext.data.Record.create([ // creates a subclass of Ext.data.Record
- {{@link Ext.data.Field#name name}: 'title', {@link Ext.data.Field#mapping mapping}: 'topic_title'},
- {name: 'author', mapping: 'username', allowBlank: false},
- {name: 'totalPosts', mapping: 'topic_replies', type: 'int'},
- {name: 'lastPost', mapping: 'post_time', type: 'date'},
- {name: 'lastPoster', mapping: 'user2'},
- {name: 'excerpt', mapping: 'post_text', allowBlank: false},
- // In the simplest case, if no properties other than name are required,
- // a field definition may consist of just a String for the field name.
- 'signature'
-]);
-
-// create Record instance
-var myNewRecord = new TopicRecord(
- {
- title: 'Do my job please',
- author: 'noobie',
- totalPosts: 1,
- lastPost: new Date(),
- lastPoster: 'Animal',
- excerpt: 'No way dude!',
- signature: ''
- },
- id // optionally specify the id of the record otherwise {@link #Record.id one is auto-assigned}
-);
-myStore.{@link Ext.data.Store#add add}(myNewRecord);
-Ext.data.Record.PREFIX - * (defaults to 'ext-record')
Ext.data.Record.AUTO_ID - * (defaults to 1 initially)
This property is stored in the Record definition's prototype
- * A MixedCollection containing the defined {@link Ext.data.Field Field}s for this Record. Read-only. - * @property fields - * @type Ext.util.MixedCollection - */ - /** - * An object hash representing the data for this Record. Every field name in the Record definition - * is represented by a property of that name in this object. Note that unless you specified a field - * with {@link Ext.data.Field#name name} "id" in the Record definition, this will not contain - * an id property. - * @property data - * @type {Object} - */ - /** - * The unique ID of the Record {@link #Record as specified at construction time}. - * @property id - * @type {Object} - */ - /** - * Readonly flag - true if this Record has been modified. - * @type Boolean - */ - dirty : false, - editing : false, - error: null, - /** - * This object contains a key and value storing the original values of all modified - * fields or is null if no fields have been modified. - * @property modified - * @type {Object} - */ - modified: null, - /** - * false when the record does not yet exist in a server-side database (see - * {@link #markDirty}). Any record which has a real database pk set as its id property - * is NOT a phantom -- it's real. - * @property phantom - * @type {Boolean} - */ - phantom : false, - - // private - join : function(store){ - /** - * The {@link Ext.data.Store} to which this Record belongs. - * @property store - * @type {Ext.data.Store} - */ - this.store = store; - }, - - /** - * Set the {@link Ext.data.Field#name named field} to the specified value. For example: - *
-// record has a field named 'firstname'
-var Employee = Ext.data.Record.{@link #create}([
- {name: 'firstname'},
- ...
-]);
-
-// update the 2nd record in the store:
-var rec = myStore.{@link Ext.data.Store#getAt getAt}(1);
-
-// set the value (shows dirty flag):
-rec.set('firstname', 'Betty');
-
-// commit the change (removes dirty flag):
-rec.{@link #commit}();
-
-// update the record in the store, bypass setting dirty flag,
-// and do not store the change in the {@link Ext.data.Store#getModifiedRecords modified records}
-rec.{@link #data}['firstname'] = 'Wilma'); // updates record, but not the view
-rec.{@link #commit}(); // updates the view
- * autoSave=true, each set()
- * will execute an XHR to the server.{@link #beginEdit} to prevent the store's update
- * event firing while using set().{@link #endEdit} to have the store's update
- * event fire.update event)
- * are relayed to the containing store.
- * See also: {@link #endEdit} and {@link #cancelEdit}.
- */
- beginEdit : function(){
- this.editing = true;
- this.modified = this.modified || {};
- },
-
- /**
- * Cancels all changes made in the current edit operation.
- */
- cancelEdit : function(){
- this.editing = false;
- delete this.modified;
- },
-
- /**
- * End an edit. If any data was modified, the containing store is notified
- * (ie, the store's update event will fire).
- */
- endEdit : function(){
- this.editing = false;
- if(this.dirty){
- this.afterEdit();
- }
- },
-
- /**
- * Usually called by the {@link Ext.data.Store} which owns the Record.
- * Rejects all changes made to the Record since either creation, or the last commit operation.
- * Modified fields are reverted to their original values.
- * Developers should subscribe to the {@link Ext.data.Store#update} event - * to have their code notified of reject operations.
- * @param {Boolean} silent (optional) True to skip notification of the owning - * store of the change (defaults to false) - */ - reject : function(silent){ - var m = this.modified; - for(var n in m){ - if(typeof m[n] != "function"){ - this.data[n] = m[n]; - } - } - this.dirty = false; - delete this.modified; - this.editing = false; - if(silent !== true){ - this.afterReject(); - } - }, - - /** - * Usually called by the {@link Ext.data.Store} which owns the Record. - * Commits all changes made to the Record since either creation, or the last commit operation. - *Developers should subscribe to the {@link Ext.data.Store#update} event - * to have their code notified of commit operations.
- * @param {Boolean} silent (optional) True to skip notification of the owning - * store of the change (defaults to false) - */ - commit : function(silent){ - this.dirty = false; - delete this.modified; - this.editing = false; - if(silent !== true){ - this.afterCommit(); - } - }, - - /** - * Gets a hash of only the fields that have been modified since this Record was created or commited. - * @return Object - */ - getChanges : function(){ - var m = this.modified, cs = {}; - for(var n in m){ - if(m.hasOwnProperty(n)){ - cs[n] = this.data[n]; - } - } - return cs; - }, - - // private - hasError : function(){ - return this.error !== null; - }, - - // private - clearError : function(){ - this.error = null; - }, - - /** - * Creates a copy of this Record. - * @param {String} id (optional) A new Record id, defaults to {@link #Record.id autogenerating an id}. - * Note: if anid is not specified the copy created will be a
- * {@link #phantom} Record.
- * @return {Record}
- */
- copy : function(newId) {
- return new this.constructor(Ext.apply({}, this.data), newId || this.id);
- },
-
- /**
- * Returns true if the passed field name has been {@link #modified}
- * since the load or last commit.
- * @param {String} fieldName {@link Ext.data.Field.{@link Ext.data.Field#name}
- * @return {Boolean}
- */
- isModified : function(fieldName){
- return !!(this.modified && this.modified.hasOwnProperty(fieldName));
- },
-
- /**
- * By default returns false if any {@link Ext.data.Field field} within the
- * record configured with {@link Ext.data.Field#allowBlank} = false returns
- * true from an {@link Ext}.{@link Ext#isEmpty isempty} test.
- * @return {Boolean}
- */
- isValid : function() {
- return this.fields.find(function(f) {
- return (f.allowBlank === false && Ext.isEmpty(this.data[f.name])) ? true : false;
- },this) ? false : true;
- },
-
- /**
- * Marks this Record as {@link #dirty}. This method
- * is used interally when adding {@link #phantom} records to a
- * {@link Ext.data.Store#writer writer enabled store}.
Marking a record {@link #dirty} causes the phantom to
- * be returned by {@link Ext.data.Store#getModifiedRecords} where it will
- * have a create action composed for it during {@link Ext.data.Store#save store save}
- * operations.
The Store class encapsulates a client side cache of {@link Ext.data.Record Record} - * objects which provide input data for Components such as the {@link Ext.grid.GridPanel GridPanel}, - * the {@link Ext.form.ComboBox ComboBox}, or the {@link Ext.DataView DataView}.
- *Retrieving Data
- *A Store object may access a data object using:
Reading Data
- *A Store object has no inherent knowledge of the format of the data object (it could be - * an Array, XML, or JSON). A Store object uses an appropriate {@link #reader configured implementation} - * of a {@link Ext.data.DataReader DataReader} to create {@link Ext.data.Record Record} instances from the data - * object.
- *Store Types
- *There are several implementations of Store available which are customized for use with - * a specific DataReader implementation. Here is an example using an ArrayStore which implicitly - * creates a reader commensurate to an Array data object.
- *
-var myStore = new Ext.data.ArrayStore({
- fields: ['fullname', 'first'],
- idIndex: 0 // id for each record will be the first element
-});
- * For custom implementations create a basic {@link Ext.data.Store} configured as needed:
- *
-// create a {@link Ext.data.Record Record} constructor:
-var rt = Ext.data.Record.create([
- {name: 'fullname'},
- {name: 'first'}
-]);
-var myStore = new Ext.data.Store({
- // explicitly create reader
- reader: new Ext.data.ArrayReader(
- {
- idIndex: 0 // id for each record will be the first element
- },
- rt // recordType
- )
-});
- * Load some data into store (note the data object is an array which corresponds to the reader):
- *
-var myData = [
- [1, 'Fred Flintstone', 'Fred'], // note that id for the record is the first element
- [2, 'Barney Rubble', 'Barney']
-];
-myStore.loadData(myData);
- * Records are cached and made available through accessor functions. An example of adding - * a record to the store:
- *
-var defaultData = {
- fullname: 'Full Name',
- first: 'First Name'
-};
-var recId = 100; // provide unique id for the record
-var r = new myStore.recordType(defaultData, ++recId); // create new record
-myStore.{@link #insert}(0, r); // insert a new record into the store (also see {@link #add})
- * {@link #baseParams corresponding configuration option}
- * for a description of this property.
- * To modify this property see {@link #setBaseParam}.
- * @property
- */
- this.baseParams = {};
-
- // temporary removed-records cache
- this.removed = [];
-
- if(config && config.data){
- this.inlineData = config.data;
- delete config.data;
- }
-
- Ext.apply(this, config);
-
- this.paramNames = Ext.applyIf(this.paramNames || {}, this.defaultParamNames);
-
- if(this.url && !this.proxy){
- this.proxy = new Ext.data.HttpProxy({url: this.url});
- }
- // If Store is RESTful, so too is the DataProxy
- if (this.restful === true && this.proxy) {
- // When operating RESTfully, a unique transaction is generated for each record.
- this.batch = false;
- Ext.data.Api.restify(this.proxy);
- }
-
- if(this.reader){ // reader passed
- if(!this.recordType){
- this.recordType = this.reader.recordType;
- }
- if(this.reader.onMetaChange){
- this.reader.onMetaChange = this.onMetaChange.createDelegate(this);
- }
- if (this.writer) { // writer passed
- this.writer.meta = this.reader.meta;
- this.pruneModifiedRecords = true;
- }
- }
-
- /**
- * The {@link Ext.data.Record Record} constructor as supplied to (or created by) the
- * {@link Ext.data.DataReader Reader}. Read-only.
- * If the Reader was constructed by passing in an Array of {@link Ext.data.Field} definition objects, - * instead of a Record constructor, it will implicitly create a Record constructor from that Array (see - * {@link Ext.data.Record}.{@link Ext.data.Record#create create} for additional details).
- *This property may be used to create new Records of the type held in this Store, for example:
-// create the data store
-var store = new Ext.data.ArrayStore({
- autoDestroy: true,
- fields: [
- {name: 'company'},
- {name: 'price', type: 'float'},
- {name: 'change', type: 'float'},
- {name: 'pctChange', type: 'float'},
- {name: 'lastChange', type: 'date', dateFormat: 'n/j h:ia'}
- ]
-});
-store.loadData(myData);
-
-// create the Grid
-var grid = new Ext.grid.EditorGridPanel({
- store: store,
- colModel: new Ext.grid.ColumnModel({
- columns: [
- {id:'company', header: 'Company', width: 160, dataIndex: 'company'},
- {header: 'Price', renderer: 'usMoney', dataIndex: 'price'},
- {header: 'Change', renderer: change, dataIndex: 'change'},
- {header: '% Change', renderer: pctChange, dataIndex: 'pctChange'},
- {header: 'Last Updated', width: 85,
- renderer: Ext.util.Format.dateRenderer('m/d/Y'),
- dataIndex: 'lastChange'}
- ],
- defaults: {
- sortable: true,
- width: 75
- }
- }),
- autoExpandColumn: 'company', // match the id specified in the column model
- height:350,
- width:600,
- title:'Array Grid',
- tbar: [{
- text: 'Add Record',
- handler : function(){
- var defaultData = {
- change: 0,
- company: 'New Company',
- lastChange: (new Date()).clearTime(),
- pctChange: 0,
- price: 10
- };
- var recId = 3; // provide unique id
- var p = new store.recordType(defaultData, recId); // create new record
- grid.stopEditing();
- store.{@link #insert}(0, p); // insert a new record into the store (also see {@link #add})
- grid.startEditing(0, 0);
- }
- }]
-});
- *
- Ext.data.Record.EDIT
- Ext.data.Record.REJECT
- Ext.data.Record.COMMIT
- * Fires if an exception occurs in the Proxy during a remote request. - * This event is relayed through the corresponding {@link Ext.data.DataProxy}. - * See {@link Ext.data.DataProxy}.{@link Ext.data.DataProxy#exception exception} - * for additional details. - * @param {misc} misc See {@link Ext.data.DataProxy}.{@link Ext.data.DataProxy#exception exception} - * for description. - */ - 'exception', - /** - * @event beforeload - * Fires before a request is made for a new data object. If the beforeload handler returns - * false the {@link #load} action will be canceled. - * @param {Store} this - * @param {Object} options The loading options that were specified (see {@link #load} for details) - */ - 'beforeload', - /** - * @event load - * Fires after a new set of Records has been loaded. - * @param {Store} this - * @param {Ext.data.Record[]} records The Records that were loaded - * @param {Object} options The loading options that were specified (see {@link #load} for details) - */ - 'load', - /** - * @event loadexception - *
This event is deprecated in favor of the catch-all {@link #exception}
- * event instead.
This event is relayed through the corresponding {@link Ext.data.DataProxy}.
- * See {@link Ext.data.DataProxy}.{@link Ext.data.DataProxy#loadexception loadexception}
- * for additional details.
- * @param {misc} misc See {@link Ext.data.DataProxy}.{@link Ext.data.DataProxy#loadexception loadexception}
- * for description.
- */
- 'loadexception',
- /**
- * @event beforewrite
- * @param {DataProxy} this
- * @param {String} action [Ext.data.Api.actions.create|update|destroy]
- * @param {Record/Array[Record]} rs
- * @param {Object} options The loading options that were specified. Edit options.params to add Http parameters to the request. (see {@link #save} for details)
- * @param {Object} arg The callback's arg object passed to the {@link #request} function
- */
- 'beforewrite',
- /**
- * @event write
- * Fires if the server returns 200 after an Ext.data.Api.actions CRUD action.
- * Success or failure of the action is available in the result['successProperty'] property.
- * The server-code might set the successProperty to false if a database validation
- * failed, for example.
- * @param {Ext.data.Store} store
- * @param {String} action [Ext.data.Api.actions.create|update|destroy]
- * @param {Object} result The 'data' picked-out out of the response for convenience.
- * @param {Ext.Direct.Transaction} res
- * @param {Record/Record[]} rs Store's records, the subject(s) of the write-action
- */
- 'write'
- );
-
- if(this.proxy){
- this.relayEvents(this.proxy, ['loadexception', 'exception']);
- }
- // With a writer set for the Store, we want to listen to add/remove events to remotely create/destroy records.
- if (this.writer) {
- this.on({
- scope: this,
- add: this.createRecords,
- remove: this.destroyRecord,
- update: this.updateRecord
- });
- }
-
- this.sortToggle = {};
- if(this.sortField){
- this.setDefaultSort(this.sortField, this.sortDir);
- }else if(this.sortInfo){
- this.setDefaultSort(this.sortInfo.field, this.sortInfo.direction);
- }
-
- Ext.data.Store.superclass.constructor.call(this);
-
- if(this.id){
- this.storeId = this.id;
- delete this.id;
- }
- if(this.storeId){
- Ext.StoreMgr.register(this);
- }
- if(this.inlineData){
- this.loadData(this.inlineData);
- delete this.inlineData;
- }else if(this.autoLoad){
- this.load.defer(10, this, [
- typeof this.autoLoad == 'object' ?
- this.autoLoad : undefined]);
- }
-};
-Ext.extend(Ext.data.Store, Ext.util.Observable, {
- /**
- * @cfg {String} storeId If passed, the id to use to register with the {@link Ext.StoreMgr StoreMgr}.
- *
Note: if a (deprecated) {@link #id} is specified it will supersede the storeId - * assignment.
- */ - /** - * @cfg {String} url If a {@link #proxy} is not specified the url will be used to - * implicitly configure a {@link Ext.data.HttpProxy HttpProxy} if an url is specified. - * Typically this option, or the{@link #data} option will be specified.
- */
- /**
- * @cfg {Boolean/Object} autoLoad If {@link #data} is not specified, and if autoLoad
- * is true or an Object, this store's {@link #load} method is automatically called
- * after creation. If the value of autoLoad is an Object, this Object will
- * be passed to the store's {@link #load} method.
- */
- /**
- * @cfg {Ext.data.DataProxy} proxy The {@link Ext.data.DataProxy DataProxy} object which provides
- * access to a data object. See {@link #url}.
- */
- /**
- * @cfg {Array} data An inline data object readable by the {@link #reader}.
- * Typically this option, or the {@link #url} option will be specified.
- */
- /**
- * @cfg {Ext.data.DataReader} reader The {@link Ext.data.DataReader Reader} object which processes the
- * data object and returns an Array of {@link Ext.data.Record} objects which are cached keyed by their
- * {@link Ext.data.Record#id id} property.
- */
- /**
- * @cfg {Ext.data.DataWriter} writer
- * The {@link Ext.data.DataWriter Writer} object which processes a record object for being written - * to the server-side database.
- *When a writer is installed into a Store the {@link #add}, {@link #remove}, and {@link #update} - * events on the store are monitored in order to remotely {@link #createRecords create records}, - * {@link #destroyRecord destroy records}, or {@link #updateRecord update records}.
- *The proxy for this store will relay any {@link #writexception} events to this store.
- *Sample implementation: - *
-var writer = new {@link Ext.data.JsonWriter}({
- encode: true,
- writeAllFields: true // write all fields, not just those that changed
-});
-
-// Typical Store collecting the Proxy, Reader and Writer together.
-var store = new Ext.data.Store({
- storeId: 'user',
- root: 'records',
- proxy: proxy,
- reader: reader,
- writer: writer, // <-- plug a DataWriter into the store just as you would a Reader
- paramsAsHash: true,
- autoSave: false // <-- false to delay executing create, update, destroy requests
- // until specifically told to do so.
-});
- * An object containing properties which are to be sent as parameters - * for every HTTP request.
- *Parameters are encoded as standard HTTP parameters using {@link Ext#urlEncode}.
- *Note: baseParams may be superseded by any params
- * specified in a {@link #load} request, see {@link #load}
- * for more details.
{@link #setBaseParam}
- * method.
- * @property
- */
- /**
- * @cfg {Object} sortInfo A config object to specify the sort order in the request of a Store's
- * {@link #load} operation. Note that for local sorting, the direction property is
- * case-sensitive. See also {@link #remoteSort} and {@link #paramNames}.
- * For example:
-sortInfo: {
- field: 'fieldName',
- direction: 'ASC' // or 'DESC' (case sensitive for local sorting)
-}
-If remoteSort is true, then clicking on a {@link Ext.grid.Column Grid Column}'s - * {@link Ext.grid.Column#header header} causes the current page to be requested from the server appending - * the following two parameters to the {@link #load params}:
The name (as specified in the Record's - * {@link Ext.data.Field Field definition}) of the field to sort on.
The direction of the sort, 'ASC' or 'DESC' (case-sensitive).
Note: this should be set to true when using stores that are bound to only 1 component.
- */ - autoDestroy : false, - - /** - * @cfg {Boolean} pruneModifiedRecords true to clear all modified record information each time - * the store is loaded or when a record is removed (defaults to false). See {@link #getModifiedRecords} - * for the accessor method to retrieve the modified records. - */ - pruneModifiedRecords : false, - - /** - * Contains the last options object used as the parameter to the {@link #load} method. See {@link #load} - * for the details of what this may contain. This may be useful for accessing any params which were used - * to load the current Record cache. - * @property - */ - lastOptions : null, - - /** - * @cfg {Boolean} autoSave - *Defaults to true causing the store to automatically {@link #save} records to - * the server when a record is modified (ie: becomes 'dirty'). Specify false to manually call {@link #save} - * to send all modifiedRecords to the server.
- *Note: each CRUD action will be sent as a separate request.
- */ - autoSave : true, - - /** - * @cfg {Boolean} batch - *Defaults to true (unless {@link #restful}:true). Multiple
- * requests for each CRUD action (CREATE, READ, UPDATE and DESTROY) will be combined
- * and sent as one transaction. Only applies when {@link #autoSave} is set
- * to false.
If Store is RESTful, the DataProxy is also RESTful, and a unique transaction is - * generated for each record.
- */ - batch : true, - - /** - * @cfg {Boolean} restful - * Defaults to false. Set to true to have the Store and the set - * Proxy operate in a RESTful manner. The store will automatically generate GET, POST, - * PUT and DELETE requests to the server. The HTTP method used for any given CRUD - * action is described in {@link Ext.data.Api#restActions}. For additional information - * see {@link Ext.data.DataProxy#restful}. - *Note: if {@link #restful}:true batch will
- * internally be set to false.
An object containing properties which specify the names of the paging and - * sorting parameters passed to remote servers when loading blocks of data. By default, this - * object takes the following form:
-{
- start : 'start', // The parameter name which specifies the start row
- limit : 'limit', // The parameter name which specifies number of rows to return
- sort : 'sort', // The parameter name which specifies the column to sort on
- dir : 'dir' // The parameter name which specifies the sort direction
-}
-The server must produce the requested data block upon receipt of these parameter names. - * If different parameter names are required, this property can be overriden using a configuration - * property.
- *A {@link Ext.PagingToolbar PagingToolbar} bound to this Store uses this property to determine
- * the parameter names to use in its {@link #load requests}.
- */
- paramNames : undefined,
-
- /**
- * @cfg {Object} defaultParamNames
- * Provides the default values for the {@link #paramNames} property. To globally modify the parameters
- * for all stores, this object should be changed on the store prototype.
- */
- defaultParamNames : {
- start : 'start',
- limit : 'limit',
- sort : 'sort',
- dir : 'dir'
- },
-
- /**
- * Destroys the store.
- */
- destroy : function(){
- if(this.storeId){
- Ext.StoreMgr.unregister(this);
- }
- this.data = null;
- Ext.destroy(this.proxy);
- this.reader = this.writer = null;
- this.purgeListeners();
- },
-
- /**
- * Add Records to the Store and fires the {@link #add} event. To add Records
- * to the store from a remote source use {@link #load}({add:true}).
- * See also {@link #recordType} and {@link #insert}.
- * @param {Ext.data.Record[]} records An Array of Ext.data.Record objects
- * to add to the cache. See {@link #recordType}.
- */
- add : function(records){
- records = [].concat(records);
- if(records.length < 1){
- return;
- }
- for(var i = 0, len = records.length; i < len; i++){
- records[i].join(this);
- }
- var index = this.data.length;
- this.data.addAll(records);
- if(this.snapshot){
- this.snapshot.addAll(records);
- }
- this.fireEvent('add', this, records, index);
- },
-
- /**
- * (Local sort only) Inserts the passed Record into the Store at the index where it
- * should go based on the current sort information.
- * @param {Ext.data.Record} record
- */
- addSorted : function(record){
- var index = this.findInsertIndex(record);
- this.insert(index, record);
- },
-
- /**
- * Remove a Record from the Store and fires the {@link #remove} event.
- * @param {Ext.data.Record} record The Ext.data.Record object to remove from the cache.
- */
- remove : function(record){
- var index = this.data.indexOf(record);
- if(index > -1){
- this.data.removeAt(index);
- if(this.pruneModifiedRecords){
- this.modified.remove(record);
- }
- if(this.snapshot){
- this.snapshot.remove(record);
- }
- this.fireEvent('remove', this, record, index);
- }
- },
-
- /**
- * Remove a Record from the Store at the specified index. Fires the {@link #remove} event.
- * @param {Number} index The index of the record to remove.
- */
- removeAt : function(index){
- this.remove(this.getAt(index));
- },
-
- /**
- * Remove all Records from the Store and fires the {@link #clear} event.
- */
- removeAll : function(){
- this.data.clear();
- if(this.snapshot){
- this.snapshot.clear();
- }
- if(this.pruneModifiedRecords){
- this.modified = [];
- }
- this.fireEvent('clear', this);
- },
-
- /**
- * Inserts Records into the Store at the given index and fires the {@link #add} event.
- * See also {@link #add} and {@link #addSorted}.
- * @param {Number} index The start index at which to insert the passed Records.
- * @param {Ext.data.Record[]} records An Array of Ext.data.Record objects to add to the cache.
- */
- insert : function(index, records){
- records = [].concat(records);
- for(var i = 0, len = records.length; i < len; i++){
- this.data.insert(index, records[i]);
- records[i].join(this);
- }
- this.fireEvent('add', this, records, index);
- },
-
- /**
- * Get the index within the cache of the passed Record.
- * @param {Ext.data.Record} record The Ext.data.Record object to find.
- * @return {Number} The index of the passed Record. Returns -1 if not found.
- */
- indexOf : function(record){
- return this.data.indexOf(record);
- },
-
- /**
- * Get the index within the cache of the Record with the passed id.
- * @param {String} id The id of the Record to find.
- * @return {Number} The index of the Record. Returns -1 if not found.
- */
- indexOfId : function(id){
- return this.data.indexOfKey(id);
- },
-
- /**
- * Get the Record with the specified id.
- * @param {String} id The id of the Record to find.
- * @return {Ext.data.Record} The Record with the passed id. Returns undefined if not found.
- */
- getById : function(id){
- return this.data.key(id);
- },
-
- /**
- * Get the Record at the specified index.
- * @param {Number} index The index of the Record to find.
- * @return {Ext.data.Record} The Record at the passed index. Returns undefined if not found.
- */
- getAt : function(index){
- return this.data.itemAt(index);
- },
-
- /**
- * Returns a range of Records between specified indices.
- * @param {Number} startIndex (optional) The starting index (defaults to 0)
- * @param {Number} endIndex (optional) The ending index (defaults to the last Record in the Store)
- * @return {Ext.data.Record[]} An array of Records
- */
- getRange : function(start, end){
- return this.data.getRange(start, end);
- },
-
- // private
- storeOptions : function(o){
- o = Ext.apply({}, o);
- delete o.callback;
- delete o.scope;
- this.lastOptions = o;
- },
-
- /**
- *
Loads the Record cache from the configured {@link #proxy} using the configured {@link #reader}.
- *Notes:
options.params property to establish the initial position within the
- * dataset, and the number of Records to cache on each read from the Proxy.{@link #sortInfo}
- * will be automatically included with the posted parameters according to the specified
- * {@link #paramNames}.An object containing properties to pass as HTTP
- * parameters to a remote data source. Note: params will override any
- * {@link #baseParams} of the same name.
Parameters are encoded as standard HTTP parameters using {@link Ext#urlEncode}.
A function to be called after the Records - * have been loaded. The callback is called after the load event and is passed the following arguments:
Scope with which to call the callback (defaults - * to the Store object)
Indicator to append loaded records rather than - * replace the current cache. Note: see note for {@link #loadData}
{@link #url} will be used.
- *
- * change url
- * --------------- --------------------
- * removed records Ext.data.Api.actions.destroy
- * phantom records Ext.data.Api.actions.create
- * {@link #getModifiedRecords modified records} Ext.data.Api.actions.update
- *
- * @TODO: Create extensions of Error class and send associated Record with thrown exceptions.
- * e.g.: Ext.data.DataReader.Error or Ext.data.Error or Ext.data.DataProxy.Error, etc.
- */
- save : function() {
- if (!this.writer) {
- throw new Ext.data.Store.Error('writer-undefined');
- }
-
- // DESTROY: First check for removed records. Records in this.removed are guaranteed non-phantoms. @see Store#remove
- if (this.removed.length) {
- this.doTransaction('destroy', this.removed);
- }
-
- // Check for modified records. Use a copy so Store#rejectChanges will work if server returns error.
- var rs = [].concat(this.getModifiedRecords());
- if (!rs.length) { // Bail-out if empty...
- return true;
- }
-
- // CREATE: Next check for phantoms within rs. splice-off and execute create.
- var phantoms = [];
- for (var i = rs.length-1; i >= 0; i--) {
- if (rs[i].phantom === true) {
- var rec = rs.splice(i, 1).shift();
- if (rec.isValid()) {
- phantoms.push(rec);
- }
- } else if (!rs[i].isValid()) { // <-- while we're here, splice-off any !isValid real records
- rs.splice(i,1);
- }
- }
- // If we have valid phantoms, create them...
- if (phantoms.length) {
- this.doTransaction('create', phantoms);
- }
-
- // UPDATE: And finally, if we're still here after splicing-off phantoms and !isValid real records, update the rest...
- if (rs.length) {
- this.doTransaction('update', rs);
- }
- return true;
- },
-
- // private. Simply wraps call to Store#execute in try/catch. Defers to Store#handleException on error. Loops if batch: false
- doTransaction : function(action, rs) {
- function transaction(records) {
- try {
- this.execute(action, records);
- } catch (e) {
- this.handleException(e);
- }
- }
- if (this.batch === false) {
- for (var i = 0, len = rs.length; i < len; i++) {
- transaction.call(this, rs[i]);
- }
- } else {
- transaction.call(this, rs);
- }
- },
-
- // @private callback-handler for remote CRUD actions
- // Do not override -- override loadRecords, onCreateRecords, onDestroyRecords and onUpdateRecords instead.
- createCallback : function(action, rs) {
- var actions = Ext.data.Api.actions;
- return (action == 'read') ? this.loadRecords : function(data, response, success) {
- // calls: onCreateRecords | onUpdateRecords | onDestroyRecords
- this['on' + Ext.util.Format.capitalize(action) + 'Records'](success, rs, data);
- // If success === false here, exception will have been called in DataProxy
- if (success === true) {
- this.fireEvent('write', this, action, data, response, rs);
- }
- };
- },
-
- // Clears records from modified array after an exception event.
- // NOTE: records are left marked dirty. Do we want to commit them even though they were not updated/realized?
- clearModified : function(rs) {
- if (Ext.isArray(rs)) {
- for (var n=rs.length-1;n>=0;n--) {
- this.modified.splice(this.modified.indexOf(rs[n]), 1);
- }
- } else {
- this.modified.splice(this.modified.indexOf(rs), 1);
- }
- },
-
- // remap record ids in MixedCollection after records have been realized. @see Store#onCreateRecords, @see DataReader#realize
- reMap : function(record) {
- if (Ext.isArray(record)) {
- for (var i = 0, len = record.length; i < len; i++) {
- this.reMap(record[i]);
- }
- } else {
- delete this.data.map[record._phid];
- this.data.map[record.id] = record;
- var index = this.data.keys.indexOf(record._phid);
- this.data.keys.splice(index, 1, record.id);
- delete record._phid;
- }
- },
-
- // @protected onCreateRecord proxy callback for create action
- onCreateRecords : function(success, rs, data) {
- if (success === true) {
- try {
- this.reader.realize(rs, data);
- this.reMap(rs);
- }
- catch (e) {
- this.handleException(e);
- if (Ext.isArray(rs)) {
- // Recurse to run back into the try {}. DataReader#realize splices-off the rs until empty.
- this.onCreateRecords(success, rs, data);
- }
- }
- }
- },
-
- // @protected, onUpdateRecords proxy callback for update action
- onUpdateRecords : function(success, rs, data) {
- if (success === true) {
- try {
- this.reader.update(rs, data);
- } catch (e) {
- this.handleException(e);
- if (Ext.isArray(rs)) {
- // Recurse to run back into the try {}. DataReader#update splices-off the rs until empty.
- this.onUpdateRecords(success, rs, data);
- }
- }
- }
- },
-
- // @protected onDestroyRecords proxy callback for destroy action
- onDestroyRecords : function(success, rs, data) {
- // splice each rec out of this.removed
- rs = (rs instanceof Ext.data.Record) ? [rs] : rs;
- for (var i=0,len=rs.length;iReloads the Record cache from the configured Proxy using the configured {@link Ext.data.Reader Reader} and - * the options from the last load operation performed.
- *Note: see the Important note in {@link #load}.
- * @param {Object} options (optional) An Object containing {@link #load loading options} which may - * override the options used in the last {@link #load} operation. See {@link #load} for details (defaults to - * null, in which case the {@link #lastOptions} are used). - */ - reload : function(options){ - this.load(Ext.applyIf(options||{}, this.lastOptions)); - }, - - // private - // Called as a callback by the Reader during a load operation. - loadRecords : function(o, options, success){ - if(!o || success === false){ - if(success !== false){ - this.fireEvent('load', this, [], options); - } - if(options.callback){ - options.callback.call(options.scope || this, [], options, false, o); - } - return; - } - var r = o.records, t = o.totalRecords || r.length; - if(!options || options.add !== true){ - if(this.pruneModifiedRecords){ - this.modified = []; - } - for(var i = 0, len = r.length; i < len; i++){ - r[i].join(this); - } - if(this.snapshot){ - this.data = this.snapshot; - delete this.snapshot; - } - this.data.clear(); - this.data.addAll(r); - this.totalLength = t; - this.applySort(); - this.fireEvent('datachanged', this); - }else{ - this.totalLength = Math.max(t, this.data.length+r.length); - this.add(r); - } - this.fireEvent('load', this, r, options); - if(options.callback){ - options.callback.call(options.scope || this, r, options, true); - } - }, - - /** - * Loads data from a passed data block and fires the {@link #load} event. A {@link Ext.data.Reader Reader} - * which understands the format of the data must have been configured in the constructor. - * @param {Object} data The data block from which to read the Records. The format of the data expected - * is dependent on the type of {@link Ext.data.Reader Reader} that is configured and should correspond to - * that {@link Ext.data.Reader Reader}'s {@link Ext.data.Reader#readRecords} parameter. - * @param {Boolean} append (Optional) true to append the new Records rather the default to replace - * the existing cache. - * Note: that Records in a Store are keyed by their {@link Ext.data.Record#id id}, so added Records - * with ids which are already present in the Store will replace existing Records. Only Records with - * new, unique ids will be added. - */ - loadData : function(o, append){ - var r = this.reader.readRecords(o); - this.loadRecords(r, {add: append}, true); - }, - - /** - * Gets the number of cached records. - *If using paging, this may not be the total size of the dataset. If the data object - * used by the Reader contains the dataset size, then the {@link #getTotalCount} function returns - * the dataset size. Note: see the Important note in {@link #load}.
- * @return {Number} The number of Records in the Store's cache. - */ - getCount : function(){ - return this.data.length || 0; - }, - - /** - * Gets the total number of records in the dataset as returned by the server. - *If using paging, for this to be accurate, the data object used by the {@link #reader Reader} - * must contain the dataset size. For remote data sources, the value for this property - * (totalProperty for {@link Ext.data.JsonReader JsonReader}, - * totalRecords for {@link Ext.data.XmlReader XmlReader}) shall be returned by a query on the server. - * Note: see the Important note in {@link #load}.
- * @return {Number} The number of Records as specified in the data object passed to the Reader - * by the Proxy. - *Note: this value is not updated when changing the contents of the Store locally.
- */ - getTotalCount : function(){ - return this.totalLength || 0; - }, - - /** - * Returns an object describing the current sort state of this Store. - * @return {Object} The sort state of the Store. An object with two properties:The name of the field by which the Records are sorted.
The sort order, 'ASC' or 'DESC' (case-sensitive).
The {@link Ext.data.Record record} - * to test for filtering. Access field values using {@link Ext.data.Record#get}.
The ID of the Record passed.
The {@link Ext.data.Record record} - * to test for filtering. Access field values using {@link Ext.data.Record#get}.
The ID of the Record passed.
The {@link Ext.data.Record record} - * to test for filtering. Access field values using {@link Ext.data.Record#get}.
The ID of the Record passed.
-myStore.setBaseParam('foo', {bar:3});
-This class encapsulates the field definition information specified in the field definition objects - * passed to {@link Ext.data.Record#create}.
- *Developers do not need to instantiate this class. Instances are created by {@link Ext.data.Record.create} - * and cached in the {@link Ext.data.Record#fields fields} property of the created Record constructor's prototype.
- */ -Ext.data.Field = function(config){ - if(typeof config == "string"){ - config = {name: config}; - } - Ext.apply(this, config); - - if(!this.type){ - this.type = "auto"; - } - - var st = Ext.data.SortTypes; - // named sortTypes are supported, here we look them up - if(typeof this.sortType == "string"){ - this.sortType = st[this.sortType]; - } - - // set default sortType for strings and dates - if(!this.sortType){ - switch(this.type){ - case "string": - this.sortType = st.asUCString; - break; - case "date": - this.sortType = st.asDate; - break; - default: - this.sortType = st.none; - } - } - - // define once - var stripRe = /[\$,%]/g; - - // prebuilt conversion function for this field, instead of - // switching every time we're reading a value - if(!this.convert){ - var cv, dateFormat = this.dateFormat; - switch(this.type){ - case "": - case "auto": - case undefined: - cv = function(v){ return v; }; - break; - case "string": - cv = function(v){ return (v === undefined || v === null) ? '' : String(v); }; - break; - case "int": - cv = function(v){ - return v !== undefined && v !== null && v !== '' ? - parseInt(String(v).replace(stripRe, ""), 10) : ''; - }; - break; - case "float": - cv = function(v){ - return v !== undefined && v !== null && v !== '' ? - parseFloat(String(v).replace(stripRe, ""), 10) : ''; - }; - break; - case "bool": - case "boolean": - cv = function(v){ return v === true || v === "true" || v == 1; }; - break; - case "date": - cv = function(v){ - if(!v){ - return ''; - } - if(Ext.isDate(v)){ - return v; - } - if(dateFormat){ - if(dateFormat == "timestamp"){ - return new Date(v*1000); - } - if(dateFormat == "time"){ - return new Date(parseInt(v, 10)); - } - return Date.parseDate(v, dateFormat); - } - var parsed = Date.parse(v); - return parsed ? new Date(parsed) : null; - }; - break; - - } - this.convert = cv; - } -}; - -Ext.data.Field.prototype = { - /** - * @cfg {String} name - * The name by which the field is referenced within the Record. This is referenced by, for example, - * the dataIndex property in column definition objects passed to {@link Ext.grid.ColumnModel}. - *Note: In the simplest case, if no properties other than name are required, a field - * definition may consist of just a String for the field name.
- */ - /** - * @cfg {String} type - * (Optional) The data type for conversion to displayable value if {@link Ext.data.Field#convert convert} - * has not been specified. Possible values are - *
-// example of convert function
-function fullName(v, record){
- return record.name.last + ', ' + record.name.first;
-}
-
-function location(v, record){
- return !record.city ? '' : (record.city + ', ' + record.state);
-}
-
-var Dude = Ext.data.Record.create([
- {name: 'fullname', convert: fullName},
- {name: 'firstname', mapping: 'name.first'},
- {name: 'lastname', mapping: 'name.last'},
- {name: 'city', defaultValue: 'homeless'},
- 'state',
- {name: 'location', convert: location}
-]);
-
-// create the data store
-var store = new Ext.data.Store({
- reader: new Ext.data.JsonReader(
- {
- idProperty: 'key',
- root: 'daRoot',
- totalProperty: 'total'
- },
- Dude // recordType
- )
-});
-
-var myData = [
- { key: 1,
- name: { first: 'Fat', last: 'Albert' }
- // notice no city, state provided in data object
- },
- { key: 2,
- name: { first: 'Barney', last: 'Rubble' },
- city: 'Bedrock', state: 'Stoneridge'
- },
- { key: 3,
- name: { first: 'Cliff', last: 'Claven' },
- city: 'Boston', state: 'MA'
- }
-];
- * (Optional) A path expression for use by the {@link Ext.data.DataReader} implementation - * that is creating the {@link Ext.data.Record Record} to extract the Field value from the data object. - * If the path expression is the same as the field name, the mapping may be omitted.
- *The form of the mapping expression depends on the Reader being used.
- *If a more complex value extraction strategy is required, then configure the Field with a {@link #convert} - * function. This is passed the whole row object, and may interrogate it in whatever way is necessary in order to - * return the desired data.
- */ - mapping: null, - /** - * @cfg {Function} sortType - * (Optional) A function which converts a Field's value to a comparable value in order to ensure - * correct sort ordering. Predefined functions are provided in {@link Ext.data.SortTypes}. A custom - * sort example:
-// current sort after sort we want
-// +-+------+ +-+------+
-// |1|First | |1|First |
-// |2|Last | |3|Second|
-// |3|Second| |2|Last |
-// +-+------+ +-+------+
-
-sortType: function(value) {
- switch (value.toLowerCase()) // native toLowerCase():
- {
- case 'first': return 1;
- case 'second': return 2;
- default: return 3;
- }
-}
- * Either an Array of {@link Ext.data.Field Field} definition objects (which - * will be passed to {@link Ext.data.Record#create}, or a {@link Ext.data.Record Record} - * constructor created using {@link Ext.data.Record#create}.
- */ -Ext.data.DataReader = function(meta, recordType){ - /** - * This DataReader's configured metadata as passed to the constructor. - * @type Mixed - * @property meta - */ - this.meta = meta; - /** - * @cfg {Array/Object} fields - *Either an Array of {@link Ext.data.Field Field} definition objects (which - * will be passed to {@link Ext.data.Record#create}, or a {@link Ext.data.Record Record} - * constructor created from {@link Ext.data.Record#create}.
- */ - this.recordType = Ext.isArray(recordType) ? - Ext.data.Record.create(recordType) : recordType; -}; - -Ext.data.DataReader.prototype = { - - /** - * Abstract method, overridden in {@link Ext.data.JsonReader} - */ - buildExtractors : Ext.emptyFn, - - /** - * Used for un-phantoming a record after a successful database insert. Sets the records pk along with new data from server. - * You must return at least the database pk using the idProperty defined in your DataReader configuration. The incoming - * data from server will be merged with the data in the local record. - * In addition, you must return record-data from the server in the same order received. - * Will perform a commit as well, un-marking dirty-fields. Store's "update" event will be suppressed. - * @param {Record/Record[]} record The phantom record to be realized. - * @param {Object/Object[]} data The new record data to apply. Must include the primary-key from database defined in idProperty field. - */ - realize: function(rs, data){ - if (Ext.isArray(rs)) { - for (var i = rs.length - 1; i >= 0; i--) { - // recurse - if (Ext.isArray(data)) { - this.realize(rs.splice(i,1).shift(), data.splice(i,1).shift()); - } - else { - // weird...rs is an array but data isn't?? recurse but just send in the whole invalid data object. - // the else clause below will detect !this.isData and throw exception. - this.realize(rs.splice(i,1).shift(), data); - } - } - } - else { - // If rs is NOT an array but data IS, see if data contains just 1 record. If so extract it and carry on. - if (Ext.isArray(data) && data.length == 1) { - data = data.shift(); - } - if (!this.isData(data)) { - // TODO: Let exception-handler choose to commit or not rather than blindly rs.commit() here. - //rs.commit(); - throw new Ext.data.DataReader.Error('realize', rs); - } - this.buildExtractors(); - var values = this.extractValues(data, rs.fields.items, rs.fields.items.length); - rs.phantom = false; // <-- That's what it's all about - rs._phid = rs.id; // <-- copy phantom-id -> _phid, so we can remap in Store#onCreateRecords - rs.id = data[this.meta.idProperty]; - rs.data = values; - rs.commit(); - } - }, - - /** - * Used for updating a non-phantom or "real" record's data with fresh data from server after remote-save. - * You must return a complete new record from the server. If you don't, your local record's missing fields - * will be populated with the default values specified in your Ext.data.Record.create specification. Without a defaultValue, - * local fields will be populated with empty string "". So return your entire record's data after both remote create and update. - * In addition, you must return record-data from the server in the same order received. - * Will perform a commit as well, un-marking dirty-fields. Store's "update" event will be suppressed as the record receives - * a fresh new data-hash. - * @param {Record/Record[]} rs - * @param {Object/Object[]} data - */ - update : function(rs, data) { - if (Ext.isArray(rs)) { - for (var i=rs.length-1; i >= 0; i--) { - if (Ext.isArray(data)) { - this.update(rs.splice(i,1).shift(), data.splice(i,1).shift()); - } - else { - // weird...rs is an array but data isn't?? recurse but just send in the whole data object. - // the else clause below will detect !this.isData and throw exception. - this.update(rs.splice(i,1).shift(), data); - } - } - } - else { - // If rs is NOT an array but data IS, see if data contains just 1 record. If so extract it and carry on. - if (Ext.isArray(data) && data.length == 1) { - data = data.shift(); - } - if (!this.isData(data)) { - // TODO: create custom Exception class to return record in thrown exception. Allow exception-handler the choice - // to commit or not rather than blindly rs.commit() here. - rs.commit(); - throw new Ext.data.DataReader.Error('update', rs); - } - this.buildExtractors(); - rs.data = this.extractValues(Ext.apply(rs.data, data), rs.fields.items, rs.fields.items.length); - rs.commit(); - } - }, - - /** - * Returns true if the supplied data-hash looks and quacks like data. Checks to see if it has a key - * corresponding to idProperty defined in your DataReader config containing non-empty pk. - * @param {Object} data - * @return {Boolean} - */ - isData : function(data) { - return (data && Ext.isObject(data) && !Ext.isEmpty(data[this.meta.idProperty])) ? true : false; - } -}; - -/** - * @class Ext.data.DataReader.Error - * @extends Ext.Error - * General error class for Ext.data.DataReader - */ -Ext.data.DataReader.Error = Ext.extend(Ext.Error, { - constructor : function(message, arg) { - this.arg = arg; - Ext.Error.call(this, message); - }, - name: 'Ext.data.DataReader' -}); -Ext.apply(Ext.data.DataReader.Error.prototype, { - lang : { - 'update': "#update received invalid data from server. Please see docs for DataReader#update and review your DataReader configuration.", - 'realize': "#realize was called with invalid remote-data. Please see the docs for DataReader#realize and review your DataReader configuration.", - 'invalid-response': "#readResponse received an invalid response from the server." - } -}); - - -/** - * @class Ext.data.DataWriter - *Ext.data.DataWriter facilitates create, update, and destroy actions between - * an Ext.data.Store and a server-side framework. A Writer enabled Store will - * automatically manage the Ajax requests to perform CRUD actions on a Store.
- *Ext.data.DataWriter is an abstract base class which is intended to be extended - * and should not be created directly. For existing implementations, see - * {@link Ext.data.JsonWriter}.
- *Creating a writer is simple:
- *
-var writer = new Ext.data.JsonWriter();
- * The proxy for a writer enabled store can be configured with a simple url:
-// Create a standard HttpProxy instance.
-var proxy = new Ext.data.HttpProxy({
- url: 'app.php/users'
-});
- * For finer grained control, the proxy may also be configured with an api:
-// Use the api specification
-var proxy = new Ext.data.HttpProxy({
- api: {
- read : 'app.php/users/read',
- create : 'app.php/users/create',
- update : 'app.php/users/update',
- destroy : 'app.php/users/destroy'
- }
-});
- * Creating a Writer enabled store:
- *
-var store = new Ext.data.Store({
- proxy: proxy,
- reader: reader,
- writer: writer
-});
- * Abstract base class for implementations which provide retrieval of unformatted data objects. - * This class is intended to be extended and should not be created directly. For existing implementations, - * see {@link Ext.data.DirectProxy}, {@link Ext.data.HttpProxy}, {@link Ext.data.ScriptTagProxy} and - * {@link Ext.data.MemoryProxy}.
- *DataProxy implementations are usually used in conjunction with an implementation of {@link Ext.data.DataReader} - * (of the appropriate type which knows how to parse the data object) to provide a block of - * {@link Ext.data.Records} to an {@link Ext.data.Store}.
- *The parameter to a DataProxy constructor may be an {@link Ext.data.Connection} or can also be the - * config object to an {@link Ext.data.Connection}.
- *Custom implementations must implement either the doRequest method (preferred) or the
- * load method (deprecated). See
- * {@link Ext.data.HttpProxy}.{@link Ext.data.HttpProxy#doRequest doRequest} or
- * {@link Ext.data.HttpProxy}.{@link Ext.data.HttpProxy#load load} for additional details.
Example 1
- *
-proxy: new Ext.data.ScriptTagProxy({
- {@link Ext.data.Connection#url url}: 'http://extjs.com/forum/topics-remote.php'
-}),
- * Example 2
- *
-proxy : new Ext.data.HttpProxy({
- {@link Ext.data.Connection#method method}: 'GET',
- {@link Ext.data.HttpProxy#prettyUrls prettyUrls}: false,
- {@link Ext.data.Connection#url url}: 'local/default.php', // see options parameter for {@link Ext.Ajax#request}
- {@link #api}: {
- // all actions except the following will use above url
- create : 'local/new.php',
- update : 'local/update.php'
- }
-}),
- *
-api: {
- read : undefined,
- create : undefined,
- update : undefined,
- destroy : undefined
-}
-If the specific URL for a given CRUD action is undefined, the CRUD action request - * will be directed to the configured {@link Ext.data.Connection#url url}.
- *Note: To modify the URL for an action dynamically the appropriate API - * property should be modified before the action is requested using the corresponding before - * action event. For example to modify the URL associated with the load action: - *
-// modify the url for the action
-myStore.on({
- beforeload: {
- fn: function (store, options) {
- // use {@link Ext.data.HttpProxy#setUrl setUrl} to change the URL for *just* this request.
- store.proxy.setUrl('changed1.php');
-
- // set optional second parameter to true to make this URL change
- // permanent, applying this URL for all subsequent requests.
- store.proxy.setUrl('changed1.php', true);
-
- // manually set the private connection URL.
- // Warning: Accessing the private URL property should be avoided.
- // Use the public method {@link Ext.data.HttpProxy#setUrl setUrl} instead, shown above.
- // It should be noted that changing the URL like this will affect
- // the URL for just this request. Subsequent requests will use the
- // API or URL defined in your initial proxy configuration.
- store.proxy.conn.url = 'changed1.php';
-
- // proxy URL will be superseded by API (only if proxy created to use ajax):
- // It should be noted that proxy API changes are permanent and will
- // be used for all subsequent requests.
- store.proxy.api.load = 'changed2.php';
-
- // However, altering the proxy API should be done using the public
- // method {@link Ext.data.DataProxy#setApi setApi} instead.
- store.proxy.setApi('load', 'changed2.php');
-
- // Or set the entire API with a config-object.
- // When using the config-object option, you must redefine the entire
- // API -- not just a specific action of it.
- store.proxy.setApi({
- read : 'changed_read.php',
- create : 'changed_create.php',
- update : 'changed_update.php',
- destroy : 'changed_destroy.php'
- });
- }
- }
-});
- * Fires if an exception occurs in the Proxy during a remote request. - * This event is relayed through a corresponding - * {@link Ext.data.Store}.{@link Ext.data.Store#exception exception}, - * so any Store instance may observe this event. - * This event can be fired for one of two reasons:
- *This event fires with two different contexts based upon the 2nd - * parameter type [remote|response]. The first four parameters - * are identical between the two contexts -- only the final two parameters - * differ.
- * @param {DataProxy} this The proxy that sent the request - * @param {String} type - *The value of this parameter will be either 'response' or 'remote'.
- *An invalid response from the server was returned: either 404, - * 500 or the response meta-data does not match that defined in the DataReader - * (e.g.: root, idProperty, successProperty).
- *A valid response was returned from the server having - * successProperty === false. This response might contain an error-message - * sent from the server. For example, the user may have failed - * authentication/authorization or a database validation error occurred.
- *The value of this parameter depends on the value of the type parameter:
The raw browser response object (e.g.: XMLHttpRequest)
- *The decoded response object sent from the server.
- *The type and value of this parameter depends on the value of the type parameter:
The JavaScript Error object caught if the configured Reader could not read the data. - * If the remote request returns success===false, this parameter will be null.
- *This parameter will only exist if the action was a write action - * (Ext.data.Api.actions.create|update|destroy).
- *This event is deprecated. The signature of the loadexception event - * varies depending on the proxy, use the catch-all {@link #exception} event instead. - * This event will fire in addition to the {@link #exception} event.
- * @param {misc} misc See {@link #exception}. - * @deprecated - */ - 'loadexception', - /** - * @event beforewrite - * Fires before a request is generated for one of the actions Ext.data.Api.actions.create|update|destroy - * @param {DataProxy} this The proxy for the request - * @param {String} action [Ext.data.Api.actions.create|update|destroy] - * @param {Record/Array[Record]} rs The Record(s) to create|update|destroy. - * @param {Object} params The requestparams object. Edit params to add parameters to the request.
- */
- 'beforewrite',
- /**
- * @event write
- * Fires before the request-callback is called
- * @param {DataProxy} this The proxy that sent the request
- * @param {String} action [Ext.data.Api.actions.create|upate|destroy]
- * @param {Object} data The data object extracted from the server-response
- * @param {Object} response The decoded response from server
- * @param {Record/Record{}} rs The records from Store
- * @param {Object} options The callback's options property as passed to the {@link #request} function
- */
- 'write'
- );
- Ext.data.DataProxy.superclass.constructor.call(this);
-};
-
-Ext.extend(Ext.data.DataProxy, Ext.util.Observable, {
- /**
- * @cfg {Boolean} restful
- * Defaults to false. Set to true to operate in a RESTful manner.
- * Note: this parameter will automatically be set to true if the
- * {@link Ext.data.Store} it is plugged into is set to restful: true. If the
- * Store is RESTful, there is no need to set this option on the proxy.
RESTful implementations enable the serverside framework to automatically route - * actions sent to one url based upon the HTTP method, for example: - *
-store: new Ext.data.Store({
- restful: true,
- proxy: new Ext.data.HttpProxy({url:'/users'}); // all requests sent to /users
- ...
-)}
- * {@link #api} specified in the configuration of the proxy,
- * all requests will be marshalled to a single RESTful url (/users) so the serverside
- * framework can inspect the HTTP Method and act accordingly:
- * -Method url action -POST /users create -GET /users read -PUT /users/23 update -DESTROY /users/23 delete - *- */ - restful: false, - - /** - *
Redefines the Proxy's API or a single action of an API. Can be called with two method signatures.
- *If called with an object as the only parameter, the object should redefine the entire API, e.g.:
-proxy.setApi({
- read : '/users/read',
- create : '/users/create',
- update : '/users/update',
- destroy : '/users/destroy'
-});
-If called with two parameters, the first parameter should be a string specifying the API action to - * redefine and the second parameter should be the URL (or function if using DirectProxy) to call for that action, e.g.:
-proxy.setApi(Ext.data.Api.actions.read, '/users/new_load_url');
-
- * Note that if you are retrieving data from a page that is in a domain that is NOT the same as the originating domain
- * of the running page, you must use this class, rather than HttpProxy.
- *
- * The content passed back from a server resource requested by a ScriptTagProxy must be executable JavaScript
- * source code because it is used as the source inside a <script> tag.
- *
- * In order for the browser to process the returned data, the server must wrap the data object - * with a call to a callback function, the name of which is passed as a parameter by the ScriptTagProxy. - * Below is a Java example for a servlet which returns data for either a ScriptTagProxy, or an HttpProxy - * depending on whether the callback name was passed: - *
- *
-boolean scriptTag = false;
-String cb = request.getParameter("callback");
-if (cb != null) {
- scriptTag = true;
- response.setContentType("text/javascript");
-} else {
- response.setContentType("application/x-json");
-}
-Writer out = response.getWriter();
-if (scriptTag) {
- out.write(cb + "(");
-}
-out.print(dataBlock.toJsonString());
-if (scriptTag) {
- out.write(");");
-}
-The server-side processing must read this parameter value, and generate - * javascript output which calls this named function passing the data object as its only parameter. - */ - callbackParam : "callback", - /** - * @cfg {Boolean} nocache (optional) Defaults to true. Disable caching by adding a unique parameter - * name to the request. - */ - nocache : true, - - /** - * HttpProxy implementation of DataProxy#doRequest - * @param {String} action - * @param {Ext.data.Record/Ext.data.Record[]} rs If action is read, rs will be null - * @param {Object} params An object containing properties which are to be used as HTTP parameters - * for the request to the remote server. - * @param {Ext.data.DataReader} reader The Reader object which converts the data - * object into a block of Ext.data.Records. - * @param {Function} callback The function into which to pass the block of Ext.data.Records. - * The function must be passed
An implementation of {@link Ext.data.DataProxy} that processes data requests within the same - * domain of the originating page.
- *Note: this class cannot be used to retrieve data from a domain other - * than the domain from which the running page was served. For cross-domain requests, use a - * {@link Ext.data.ScriptTagProxy ScriptTagProxy}.
- *Be aware that to enable the browser to parse an XML document, the server must set - * the Content-Type header in the HTTP response to "text/xml".
- * @constructor - * @param {Object} conn - * An {@link Ext.data.Connection} object, or options parameter to {@link Ext.Ajax#request}. - *Note that if this HttpProxy is being used by a (@link Ext.data.Store Store}, then the - * Store's call to {@link #load} will override any specified callback and params - * options. In this case, use the Store's {@link Ext.data.Store#events events} to modify parameters, - * or react to loading events. The Store's {@link Ext.data.Store#baseParams baseParams} may also be - * used to pass parameters known at instantiation time.
- *If an options parameter is passed, the singleton {@link Ext.Ajax} object will be used to make - * the request.
- */ -Ext.data.HttpProxy = function(conn){ - Ext.data.HttpProxy.superclass.constructor.call(this, conn); - - /** - * The Connection object (Or options parameter to {@link Ext.Ajax#request}) which this HttpProxy - * uses to make requests to the server. Properties of this object may be changed dynamically to - * change the way data is requested. - * @property - */ - this.conn = conn; - - // nullify the connection url. The url param has been copied to 'this' above. The connection - // url will be set during each execution of doRequest when buildUrl is called. This makes it easier for users to override the - // connection url during beforeaction events (ie: beforeload, beforesave, etc). The connection url will be nullified - // after each request as well. Url is always re-defined during doRequest. - this.conn.url = null; - - this.useAjax = !conn || !conn.events; - - //private. A hash containing active requests, keyed on action [Ext.data.Api.actions.create|read|update|destroy] - var actions = Ext.data.Api.actions; - this.activeRequest = {}; - for (var verb in actions) { - this.activeRequest[actions[verb]] = undefined; - } -}; - -Ext.extend(Ext.data.HttpProxy, Ext.data.DataProxy, { - /** - * @cfg {Boolean} restful - *If set to true, a {@link Ext.data.Record#phantom non-phantom} record's - * {@link Ext.data.Record#id id} will be appended to the url (defaults to false).
The url is built based upon the action being executed [load|create|save|destroy] - * using the commensurate {@link #api} property, or if undefined default to the - * configured {@link Ext.data.Store}.{@link Ext.data.Store#url url}.
Some MVC (e.g., Ruby on Rails, Merb and Django) support this style of segment based urls - * where the segments in the URL follow the Model-View-Controller approach.
- * someSite.com/controller/action/id
- * For example:
- *
-api: {
- load : '/controller/load',
- create : '/controller/new', // Server MUST return idProperty of new record
- save : '/controller/update',
- destroy : '/controller/destroy_action'
-}
-
-// Alternatively, one can use the object-form to specify each API-action
-api: {
- load: {url: 'read.php', method: 'GET'},
- create: 'create.php',
- destroy: 'destroy.php',
- save: 'update.php'
-}
- */
-
- /**
- * Return the {@link Ext.data.Connection} object being used by this Proxy.
- * @return {Connection} The Connection object. This object may be used to subscribe to events on
- * a finer-grained basis than the DataProxy events.
- */
- getConnection : function() {
- return this.useAjax ? Ext.Ajax : this.conn;
- },
-
- /**
- * Used for overriding the url used for a single request. Designed to be called during a beforeaction event. Calling setUrl
- * will override any urls set via the api configuration parameter. Set the optional parameter makePermanent to set the url for
- * all subsequent requests. If not set to makePermanent, the next request will use the same url or api configuration defined
- * in the initial proxy configuration.
- * @param {String} url
- * @param {Boolean} makePermanent (Optional) [false]
- *
- * (e.g.: beforeload, beforesave, etc).
- */
- setUrl : function(url, makePermanent) {
- this.conn.url = url;
- if (makePermanent === true) {
- this.url = url;
- Ext.data.Api.prepare(this);
- }
- },
-
- /**
- * HttpProxy implementation of DataProxy#doRequest
- * @param {String} action The crud action type (create, read, update, destroy)
- * @param {Ext.data.Record/Ext.data.Record[]} rs If action is load, rs will be null
- * @param {Object} params An object containing properties which are to be used as HTTP parameters
- * for the request to the remote server.
- * @param {Ext.data.DataReader} reader The Reader object which converts the data
- * object into a block of Ext.data.Records.
- * @param {Function} callback
- * A function to be called after the request.
- * The callback is passed the following arguments:
- * - r : Ext.data.Record[] The block of Ext.data.Records.
- * - options: Options object from the action request
- * - success: Boolean success indicator
- * @param {Object} scope The scope in which to call the callback
- * @param {Object} arg An optional argument which is passed to the callback as its second parameter.
- */
- doRequest : function(action, rs, params, reader, cb, scope, arg) {
- var o = {
- method: (this.api[action]) ? this.api[action]['method'] : undefined,
- request: {
- callback : cb,
- scope : scope,
- arg : arg
- },
- reader: reader,
- callback : this.createCallback(action, rs),
- scope: this
- };
- // Sample the request data: If it's an object, then it hasn't been json-encoded yet.
- // Transmit data using jsonData config of Ext.Ajax.request
- if (typeof(params[reader.meta.root]) === 'object') {
- o.jsonData = params;
- } else {
- o.params = params || {};
- }
- // Set the connection url. If this.conn.url is not null here,
- // the user may have overridden the url during a beforeaction event-handler.
- // this.conn.url is nullified after each request.
- if (this.conn.url === null) {
- this.conn.url = this.buildUrl(action, rs);
- }
- else if (this.restful === true && rs instanceof Ext.data.Record && !rs.phantom) {
- this.conn.url += '/' + rs.id;
- }
- if(this.useAjax){
-
- Ext.applyIf(o, this.conn);
-
- // If a currently running request is found for this action, abort it.
- if (this.activeRequest[action]) {
- // Disabled aborting activeRequest while implementing REST. activeRequest[action] will have to become an array
- //Ext.Ajax.abort(this.activeRequest[action]);
- }
- this.activeRequest[action] = Ext.Ajax.request(o);
- }else{
- this.conn.request(o);
- }
- // request is sent, nullify the connection url in preparation for the next request
- this.conn.url = null;
- },
-
- /**
- * Returns a callback function for a request. Note a special case is made for the
- * read action vs all the others.
- * @param {String} action [create|update|delete|load]
- * @param {Ext.data.Record[]} rs The Store-recordset being acted upon
- * @private
- */
- createCallback : function(action, rs) {
- return function(o, success, response) {
- this.activeRequest[action] = undefined;
- if (!success) {
- if (action === Ext.data.Api.actions.read) {
- // @deprecated: fire loadexception for backwards compat.
- this.fireEvent('loadexception', this, o, response);
- }
- this.fireEvent('exception', this, 'response', action, o, response);
- o.request.callback.call(o.request.scope, null, o.request.arg, false);
- return;
- }
- if (action === Ext.data.Api.actions.read) {
- this.onRead(action, o, response);
- } else {
- this.onWrite(action, o, response, rs);
- }
- }
- },
-
- /**
- * Callback for read action
- * @param {String} action Action name as per {@link Ext.data.Api.actions#read}.
- * @param {Object} o The request transaction object
- * @param {Object} res The server response
- * @private
- */
- onRead : function(action, o, response) {
- var result;
- try {
- result = o.reader.read(response);
- }catch(e){
- // @deprecated: fire old loadexception for backwards-compat.
- this.fireEvent('loadexception', this, o, response, e);
- this.fireEvent('exception', this, 'response', action, o, response, e);
- o.request.callback.call(o.request.scope, null, o.request.arg, false);
- return;
- }
- if (result.success === false) {
- // @deprecated: fire old loadexception for backwards-compat.
- this.fireEvent('loadexception', this, o, response);
-
- // Get DataReader read-back a response-object to pass along to exception event
- var res = o.reader.readResponse(action, response);
- this.fireEvent('exception', this, 'remote', action, o, res, null);
- }
- else {
- this.fireEvent('load', this, o, o.request.arg);
- }
- o.request.callback.call(o.request.scope, result, o.request.arg, result.success);
- },
- /**
- * Callback for write actions
- * @param {String} action [Ext.data.Api.actions.create|read|update|destroy]
- * @param {Object} trans The request transaction object
- * @param {Object} res The server response
- * @private
- */
- onWrite : function(action, o, response, rs) {
- var reader = o.reader;
- var res;
- try {
- res = reader.readResponse(action, response);
- } catch (e) {
- this.fireEvent('exception', this, 'response', action, o, response, e);
- o.request.callback.call(o.request.scope, null, o.request.arg, false);
- return;
- }
- if (res[reader.meta.successProperty] === false) {
- this.fireEvent('exception', this, 'remote', action, o, res, rs);
- } else {
- this.fireEvent('write', this, action, res[reader.meta.root], res, rs, o.request.arg);
- }
- o.request.callback.call(o.request.scope, res[reader.meta.root], res, res[reader.meta.successProperty]);
- },
-
- // inherit docs
- destroy: function(){
- if(!this.useAjax){
- this.conn.abort();
- }else if(this.activeRequest){
- var actions = Ext.data.Api.actions;
- for (var verb in actions) {
- if(this.activeRequest[actions[verb]]){
- Ext.Ajax.abort(this.activeRequest[actions[verb]]);
- }
- }
- }
- Ext.data.HttpProxy.superclass.destroy.call(this);
- }
-});/**
- * @class Ext.data.MemoryProxy
- * @extends Ext.data.DataProxy
- * An implementation of Ext.data.DataProxy that simply passes the data specified in its constructor
- * to the Reader when its load method is called.
- * @constructor
- * @param {Object} data The data object which the Reader uses to construct a block of Ext.data.Records.
- */
-Ext.data.MemoryProxy = function(data){
- // Must define a dummy api with "read" action to satisfy DataProxy#doRequest and Ext.data.Api#prepare *before* calling super
- var api = {};
- api[Ext.data.Api.actions.read] = true;
- Ext.data.MemoryProxy.superclass.constructor.call(this, {
- api: api
- });
- this.data = data;
-};
-
-Ext.extend(Ext.data.MemoryProxy, Ext.data.DataProxy, {
- /**
- * @event loadexception
- * Fires if an exception occurs in the Proxy during data loading. Note that this event is also relayed
- * through {@link Ext.data.Store}, so you can listen for it directly on any Store instance.
- * @param {Object} this
- * @param {Object} arg The callback's arg object passed to the {@link #load} function
- * @param {Object} null This parameter does not apply and will always be null for MemoryProxy
- * @param {Error} e The JavaScript Error object caught if the configured Reader could not read the data
- */
-
- /**
- * MemoryProxy implementation of DataProxy#doRequest
- * @param {String} action
- * @param {Ext.data.Record/Ext.data.Record[]} rs If action is load, rs will be null
- * @param {Object} params An object containing properties which are to be used as HTTP parameters
- * for the request to the remote server.
- * @param {Ext.data.DataReader} reader The Reader object which converts the data
- * object into a block of Ext.data.Records.
- * @param {Function} callback The function into which to pass the block of Ext.data.Records.
- * The function must be passed
- * - The Record block object
- * - The "arg" argument from the load function
- * - A boolean success indicator
- *
- * @param {Object} scope The scope in which to call the callback
- * @param {Object} arg An optional argument which is passed to the callback as its second parameter.
- */
- doRequest : function(action, rs, params, reader, callback, scope, arg) {
- // No implementation for CRUD in MemoryProxy. Assumes all actions are 'load'
- params = params || {};
- var result;
- try {
- result = reader.readRecords(this.data);
- }catch(e){
- // @deprecated loadexception
- this.fireEvent("loadexception", this, null, arg, e);
-
- this.fireEvent('exception', this, 'response', action, arg, null, e);
- callback.call(scope, null, arg, false);
- return;
- }
- callback.call(scope, result, arg, true);
- }
-});
\ No newline at end of file