src/data/MemoryProxy.js

   1 /*!
   2  * Ext JS Library 3.3.1
   3  * Copyright(c) 2006-2010 Sencha Inc.
   4  * licensing@sencha.com
   5  * http://www.sencha.com/license
   6  */
   7 /**
   8  * @class Ext.data.MemoryProxy
   9  * @extends Ext.data.DataProxy
  10  * An implementation of Ext.data.DataProxy that simply passes the data specified in its constructor
  11  * to the Reader when its load method is called.
  12  * @constructor
  13  * @param {Object} data The data object which the Reader uses to construct a block of Ext.data.Records.
  14  */
  15 Ext.data.MemoryProxy = function(data){
  16     // Must define a dummy api with "read" action to satisfy DataProxy#doRequest and Ext.data.Api#prepare *before* calling super
  17     var api = {};
  18     api[Ext.data.Api.actions.read] = true;
  19     Ext.data.MemoryProxy.superclass.constructor.call(this, {
  20         api: api
  21     });
  22     this.data = data;
  23 };
  24
  25 Ext.extend(Ext.data.MemoryProxy, Ext.data.DataProxy, {
  26     /**
  27      * @event loadexception
  28      * Fires if an exception occurs in the Proxy during data loading. Note that this event is also relayed
  29      * through {@link Ext.data.Store}, so you can listen for it directly on any Store instance.
  30      * @param {Object} this
  31      * @param {Object} arg The callback's arg object passed to the {@link #load} function
  32      * @param {Object} null This parameter does not apply and will always be null for MemoryProxy
  33      * @param {Error} e The JavaScript Error object caught if the configured Reader could not read the data
  34      */
  35
  36        /**
  37      * MemoryProxy implementation of DataProxy#doRequest
  38      * @param {String} action
  39      * @param {Ext.data.Record/Ext.data.Record[]} rs If action is load, rs will be null
  40      * @param {Object} params An object containing properties which are to be used as HTTP parameters
  41      * for the request to the remote server.
  42      * @param {Ext.data.DataReader} reader The Reader object which converts the data
  43      * object into a block of Ext.data.Records.
  44      * @param {Function} callback The function into which to pass the block of Ext.data.Records.
  45      * The function must be passed <ul>
  46      * <li>The Record block object</li>
  47      * <li>The "arg" argument from the load function</li>
  48      * <li>A boolean success indicator</li>
  49      * </ul>
  50      * @param {Object} scope The scope (<code>this</code> reference) in which the callback function is executed. Defaults to the browser window.
  51      * @param {Object} arg An optional argument which is passed to the callback as its second parameter.
  52      */
  53     doRequest : function(action, rs, params, reader, callback, scope, arg) {
  54         // No implementation for CRUD in MemoryProxy.  Assumes all actions are 'load'
  55         params = params || {};
  56         var result;
  57         try {
  58             result = reader.readRecords(this.data);
  59         }catch(e){
  60             // @deprecated loadexception
  61             this.fireEvent("loadexception", this, null, arg, e);
  62
  63             this.fireEvent('exception', this, 'response', action, arg, null, e);
  64             callback.call(scope, null, arg, false);
  65             return;
  66         }
  67         callback.call(scope, result, arg, true);
  68     }
  69 });