The XML Reader is used by a Proxy to read a server response that is sent back in XML 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',
@@ -38,14 +38,14 @@ 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 XML Reader possible by simply telling our {@link Ext.data.Store Store}'s + * + *
We created the simplest type of XML Reader possible by simply telling our {@link Ext.data.Store Store}'s * {@link Ext.data.proxy.Proxy Proxy} that we want a XML Reader. The Store automatically passes the configured model to the * Store, so it is as if we passed this instead: - * + *
reader: {
type : 'xml',
@@ -53,7 +53,7 @@ reader: {
record: 'user'
}
The reader we set up is ready to read data from our server - at the moment it will accept a response like this:
*
@@ -69,16 +69,16 @@ reader: {
<email>abe@sencha.com</email>
</user>
The XML Reader uses the configured {@link #record} option to pull out the data for each record - in this case we * set record to 'user', so each <user> above will be converted into a User model.
- * + * *Reading other XML formats
- * + * *If you already have your XML format defined and it doesn't look quite like what we have above, you can usually - * pass XmlReader a couple of configuration options to make it parse your format. For example, we can use the + * pass XmlReader 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:
- * + *
<?xml version="1.0" encoding="UTF-8"?>
<users>
@@ -94,9 +94,9 @@ reader: {
</user>
</users>
To parse this we just pass in a {@link #root} configuration that matches the 'users' above:
- * + *
reader: {
type : 'xml',
@@ -104,10 +104,10 @@ reader: {
record: 'user'
}
Note that XmlReader doesn't care whether your {@link #root} and {@link #record} elements are nested deep inside * a larger structure, so a response like this will still work: - * + *
<?xml version="1.0" encoding="UTF-8"?>
<deeply>
@@ -129,13 +129,13 @@ reader: {
</nested>
</deeply>
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 XML response * like this:
- * + *
<?xml version="1.0" encoding="UTF-8"?>
<total>100</total>
@@ -153,11 +153,11 @@ reader: {
</user>
</users>
If these properties are present in the XML response they can be parsed out by the XmlReader 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: 'xml',
@@ -166,14 +166,14 @@ 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.
- * + * *Response format
- * - *Note: in order for the browser to parse a returned XML document, the Content-Type header in the HTTP + * + *
Note: in order for the browser to parse a returned XML document, the Content-Type header in the HTTP * response must be set to "text/xml" or "application/xml". This is very important - the XmlReader will not * work correctly otherwise.
*/ @@ -181,9 +181,10 @@ Ext.define('Ext.data.reader.Xml', { extend: 'Ext.data.reader.Reader', alternateClassName: 'Ext.data.XmlReader', alias : 'reader.xml', - + /** - * @cfg {String} record The DomQuery path to the repeated element which contains record information. + * @cfg {String} record (required) + * The DomQuery path to the repeated element which contains record information. */ /** @@ -195,20 +196,20 @@ Ext.define('Ext.data.reader.Xml', { */ createAccessor: function(expr) { var me = this; - + if (Ext.isEmpty(expr)) { return Ext.emptyFn; } - + if (Ext.isFunction(expr)) { return expr; } - + return function(root) { return me.getNodeValue(Ext.DomQuery.selectNode(expr, root)); }; }, - + getNodeValue: function(node) { if (node && node.firstChild) { return node.firstChild.nodeValue; @@ -245,12 +246,12 @@ Ext.define('Ext.data.reader.Xml', { * @private * Given an XML object, returns the Element that represents the root as configured by the Reader's meta data * @param {Object} data The XML data object - * @return {Element} The root node element + * @return {XMLElement} The root node element */ getRoot: function(data) { var nodeName = data.nodeName, root = this.root; - + if (!root || (nodeName && nodeName == root)) { return data; } else if (Ext.DomQuery.isXml(data)) { @@ -264,18 +265,18 @@ Ext.define('Ext.data.reader.Xml', { /** * @private * We're just preparing the data for the superclass by pulling out the record nodes we want - * @param {Element} root The XML root node - * @return {Array} The records + * @param {XMLElement} root The XML root node + * @return {Ext.data.Model[]} The records */ extractData: function(root) { var recordName = this.record; - + //