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:
- * + *
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',
@@ -37,23 +37,23 @@ var store = new Ext.data.Store({
}
});
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.
- * - *We created the simplest type of JSON Reader possible by simply telling our {@link Ext.data.Store Store}'s + * + *
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: - * + *
reader: {
type : 'json',
model: 'User'
}
The reader we set up is ready to read data from our server - at the moment it will accept a response like this:
- * + *
[
{
@@ -68,13 +68,13 @@ reader: {
}
]
Reading other JSON formats
- * + * *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:
- * + *
{
"users": [
@@ -91,19 +91,19 @@ reader: {
]
}
To parse this we just pass in a {@link #root} configuration that matches the 'users' above:
- * + *
reader: {
type: 'json',
root: 'users'
}
Sometimes the JSON structure is even more complicated. Document databases like CouchDB often provide metadata * around each record inside a nested structure like this:
- * + *
{
"total": 122,
@@ -121,11 +121,11 @@ reader: {
]
}
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:
- * + *
reader: {
type : 'json',
@@ -133,13 +133,13 @@ reader: {
record: 'user'
}
Response metadata
- * - *The server can return additional data in its response, such as the {@link #totalProperty total number of records} + * + *
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:
- * + *
{
"total": 100,
@@ -153,11 +153,11 @@ reader: {
]
}
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:
- * + *
reader: {
type : 'json',
@@ -166,7 +166,7 @@ reader: {
successProperty: 'success'
}
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.
@@ -175,23 +175,23 @@ 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 false. * 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. @@ -205,9 +205,8 @@ Ext.define('Ext.data.reader.Json', { } /** - * 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]); @@ -215,8 +214,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({ @@ -238,7 +238,7 @@ Ext.define('Ext.data.reader.Json', { //inherit docs buildExtractors : function() { var me = this; - + me.callParent(arguments); if (me.root) { @@ -249,22 +249,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]; } @@ -284,7 +289,7 @@ Ext.define('Ext.data.reader.Json', { */ createAccessor: function() { var re = /[\[\.]/; - + return function(expr) { if (Ext.isEmpty(expr)) { return Ext.emptyFn;