src/data/JsonStore.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.JsonStore
   9  * @extends Ext.data.Store
  10  * <p>Small helper class to make creating {@link Ext.data.Store}s from JSON data easier.
  11  * A JsonStore will be automatically configured with a {@link Ext.data.JsonReader}.</p>
  12  * <p>A store configuration would be something like:<pre><code>
  13 var store = new Ext.data.JsonStore({
  14     // store configs
  15     autoDestroy: true,
  16     url: 'get-images.php',
  17     storeId: 'myStore',
  18     // reader configs
  19     root: 'images',
  20     idProperty: 'name',
  21     fields: ['name', 'url', {name:'size', type: 'float'}, {name:'lastmod', type:'date'}]
  22 });
  23  * </code></pre></p>
  24  * <p>This store is configured to consume a returned object of the form:<pre><code>
  25 {
  26     images: [
  27         {name: 'Image one', url:'/GetImage.php?id=1', size:46.5, lastmod: new Date(2007, 10, 29)},
  28         {name: 'Image Two', url:'/GetImage.php?id=2', size:43.2, lastmod: new Date(2007, 10, 30)}
  29     ]
  30 }
  31  * </code></pre>
  32  * An object literal of this form could also be used as the {@link #data} config option.</p>
  33  * <p><b>*Note:</b> Although not listed here, this class accepts all of the configuration options of
  34  * <b>{@link Ext.data.JsonReader JsonReader}</b>.</p>
  35  * @constructor
  36  * @param {Object} config
  37  * @xtype jsonstore
  38  */
  39 Ext.data.JsonStore = Ext.extend(Ext.data.Store, {
  40     /**
  41      * @cfg {Ext.data.DataReader} reader @hide
  42      */
  43     constructor: function(config){
  44         Ext.data.JsonStore.superclass.constructor.call(this, Ext.apply(config, {
  45             reader: new Ext.data.JsonReader(config)
  46         }));
  47     }
  48 });
  49 Ext.reg('jsonstore', Ext.data.JsonStore);