X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..refs/heads/master:/docs/source/Json.html diff --git a/docs/source/Json.html b/docs/source/Json.html index e7323f6d..8407bab5 100644 --- a/docs/source/Json.html +++ b/docs/source/Json.html @@ -1,18 +1,35 @@ -Sencha Documentation Project
/**
+
+
+
+  
+  The source code
+  
+  
+  
+  
+
+
+  
/**
  * @author Ed Spencer
  * @class Ext.data.reader.Json
  * @extends Ext.data.reader.Reader
- * 
+ *
  * <p>The JSON Reader is used by a Proxy to read a server response that is sent back in JSON format. This usually
  * happens as a result of loading a Store - for example we might create something like this:</p>
- * 
+ *
 <pre><code>
 Ext.define('User', {
     extend: 'Ext.data.Model',
     fields: ['id', 'name', 'email']
 });
 
-var store = new Ext.data.Store({
+var store = Ext.create('Ext.data.Store', {
     model: 'User',
     proxy: {
         type: 'ajax',
@@ -23,23 +40,23 @@ var store = new Ext.data.Store({
     }
 });
 </code></pre>
- * 
+ *
  * <p>The example above creates a 'User' model. Models are explained in the {@link Ext.data.Model Model} docs if you're
  * not already familiar with them.</p>
- * 
- * <p>We created the simplest type of JSON Reader possible by simply telling our {@link Ext.data.Store Store}'s 
+ *
+ * <p>We created the simplest type of JSON Reader possible by simply telling our {@link Ext.data.Store Store}'s
  * {@link Ext.data.proxy.Proxy Proxy} that we want a JSON Reader. The Store automatically passes the configured model to the
  * Store, so it is as if we passed this instead:
- * 
+ *
 <pre><code>
 reader: {
     type : 'json',
     model: 'User'
 }
 </code></pre>
- * 
+ *
  * <p>The reader we set up is ready to read data from our server - at the moment it will accept a response like this:</p>
- * 
+ *
 <pre><code>
 [
     {
@@ -54,13 +71,13 @@ reader: {
     }
 ]
 </code></pre>
- * 
+ *
  * <p><u>Reading other JSON formats</u></p>
- * 
+ *
  * <p>If you already have your JSON format defined and it doesn't look quite like what we have above, you can usually
- * pass JsonReader a couple of configuration options to make it parse your format. For example, we can use the 
+ * pass JsonReader a couple of configuration options to make it parse your format. For example, we can use the
  * {@link #root} configuration to parse data that comes back like this:</p>
- * 
+ *
 <pre><code>
 {
     "users": [
@@ -77,19 +94,19 @@ reader: {
     ]
 }
 </code></pre>
- * 
+ *
  * <p>To parse this we just pass in a {@link #root} configuration that matches the 'users' above:</p>
- * 
+ *
 <pre><code>
 reader: {
     type: 'json',
     root: 'users'
 }
 </code></pre>
- * 
+ *
  * <p>Sometimes the JSON structure is even more complicated. Document databases like CouchDB often provide metadata
  * around each record inside a nested structure like this:</p>
- * 
+ *
 <pre><code>
 {
     "total": 122,
@@ -107,11 +124,11 @@ reader: {
     ]
 }
 </code></pre>
- * 
+ *
  * <p>In the case above the record data is nested an additional level inside the "users" array as each "user" item has
- * additional metadata surrounding it ('id' and 'value' in this case). To parse data out of each "user" item in the 
+ * additional metadata surrounding it ('id' and 'value' in this case). To parse data out of each "user" item in the
  * JSON above we need to specify the {@link #record} configuration like this:</p>
- * 
+ *
 <pre><code>
 reader: {
     type  : 'json',
@@ -119,13 +136,13 @@ reader: {
     record: 'user'
 }
 </code></pre>
- * 
+ *
  * <p><u>Response metadata</u></p>
- * 
- * <p>The server can return additional data in its response, such as the {@link #totalProperty total number of records} 
+ *
+ * <p>The server can return additional data in its response, such as the {@link #totalProperty total number of records}
  * and the {@link #successProperty success status of the response}. These are typically included in the JSON response
  * like this:</p>
- * 
+ *
 <pre><code>
 {
     "total": 100,
@@ -139,11 +156,11 @@ reader: {
     ]
 }
 </code></pre>
- * 
+ *
  * <p>If these properties are present in the JSON response they can be parsed out by the JsonReader and used by the
- * Store that loaded it. We can set up the names of these properties by specifying a final pair of configuration 
+ * Store that loaded it. We can set up the names of these properties by specifying a final pair of configuration
  * options:</p>
- * 
+ *
 <pre><code>
 reader: {
     type : 'json',
@@ -152,7 +169,7 @@ reader: {
     successProperty: 'success'
 }
 </code></pre>
- * 
+ *
  * <p>These final options are not necessary to make the Reader work, but can be useful when the server needs to report
  * an error or if it needs to indicate that there is a lot of data available of which only a subset is currently being
  * returned.</p>
@@ -161,24 +178,24 @@ Ext.define('Ext.data.reader.Json', {
     extend: 'Ext.data.reader.Reader',
     alternateClassName: 'Ext.data.JsonReader',
     alias : 'reader.json',
-    
+
     root: '',
-    
-    /**
+
+    /**
      * @cfg {String} record The optional location within the JSON response that the record data itself can be found at.
-     * See the JsonReader intro docs for more details. This is not often needed and defaults to undefined.
+     * See the JsonReader intro docs for more details. This is not often needed.
      */
-    
-    /**
+
+    /**
      * @cfg {Boolean} useSimpleAccessors True to ensure that field names/mappings are treated as literals when
      * reading values. Defalts to <tt>false</tt>.
      * For example, by default, using the mapping "foo.bar.baz" will try and read a property foo from the root, then a property bar
-     * from foo, then a property baz from bar. Setting the simple accessors to true will read the property with the name 
+     * from foo, then a property baz from bar. Setting the simple accessors to true will read the property with the name
      * "foo.bar.baz" direct from the root object.
      */
     useSimpleAccessors: false,
-    
-    /**
+
+    /**
      * Reads a JSON object and returns a ResultSet. Uses the internal getTotal and getSuccess extractors to
      * retrieve meta data from the response, and extractData to turn the JSON data into model instances.
      * @param {Object} data The raw JSON data
@@ -190,10 +207,9 @@ Ext.define('Ext.data.reader.Json', {
             this.onMetaChange(data.metaData);
         }
 
-        /**
-         * DEPRECATED - will be removed in Ext JS 5.0. This is just a copy of this.rawData - use that instead
-         * @property jsonData
-         * @type Mixed
+        /**
+         * @deprecated will be removed in Ext JS 5.0. This is just a copy of this.rawData - use that instead
+         * @property {Object} jsonData
          */
         this.jsonData = data;
         return this.callParent([data]);
@@ -201,8 +217,9 @@ Ext.define('Ext.data.reader.Json', {
 
     //inherit docs
     getResponseData: function(response) {
+        var data;
         try {
-            var data = Ext.decode(response.responseText);
+            data = Ext.decode(response.responseText);
         }
         catch (ex) {
             Ext.Error.raise({
@@ -224,7 +241,7 @@ Ext.define('Ext.data.reader.Json', {
     //inherit docs
     buildExtractors : function() {
         var me = this;
-        
+
         me.callParent(arguments);
 
         if (me.root) {
@@ -235,22 +252,27 @@ Ext.define('Ext.data.reader.Json', {
             };
         }
     },
-    
-    /**
+
+    /**
      * @private
      * We're just preparing the data for the superclass by pulling out the record objects we want. If a {@link #record}
      * was specified we have to pull those out of the larger JSON object, which is most of what this function is doing
      * @param {Object} root The JSON root node
-     * @return {Array} The records
+     * @return {Ext.data.Model[]} The records
      */
     extractData: function(root) {
         var recordName = this.record,
             data = [],
             length, i;
-        
+
         if (recordName) {
             length = root.length;
             
+            if (!length && Ext.isObject(root)) {
+                length = 1;
+                root = [root];
+            }
+
             for (i = 0; i < length; i++) {
                 data[i] = root[i][recordName];
             }
@@ -260,7 +282,7 @@ Ext.define('Ext.data.reader.Json', {
         return this.callParent([data]);
     },
 
-    /**
+    /**
      * @private
      * Returns an accessor function for the given property string. Gives support for properties such as the following:
      * 'someProperty'
@@ -270,7 +292,7 @@ Ext.define('Ext.data.reader.Json', {
      */
     createAccessor: function() {
         var re = /[\[\.]/;
-        
+
         return function(expr) {
             if (Ext.isEmpty(expr)) {
                 return Ext.emptyFn;
@@ -289,4 +311,6 @@ Ext.define('Ext.data.reader.Json', {
             };
         };
     }()
-});
\ No newline at end of file +});
+ +