+<?xml version="1.0" encoding="UTF-8"?>
+<user><first>Barney</first></user>
+
+<?xml version="1.0" encoding="UTF-8"?>
+ <records>
+ <first>Barney</first></user>
+ <records><first>Barney</first></user>
+ </records>
+
<?xml version="1.0" encoding="ISO-8859-15"?>
<?xml version="1.0" encoding="ISO-8859-15"?>
One can easily provide his/her own custom {@link Ext.XTemplate#constructor template-definition} if the default does not suffice.
+ *Defaults to:
+
+<?xml version="{version}" encoding="{encoding}"?>
+ <tpl if="documentRoot"><{documentRoot}>
+ <tpl for="baseParams">
+ <tpl for=".">
+ <{name}>{value}</{name}>
+ </tpl>
+ </tpl>
+ <tpl if="records.length > 1"><{root}>',
+ <tpl for="records">
+ <{parent.record}>
+ <tpl for=".">
+ <{name}>{value}</{name}>
+ </tpl>
+ </{parent.record}>
+ </tpl>
+ <tpl if="records.length > 1"></{root}></tpl>
+ <tpl if="documentRoot"></{documentRoot}></tpl>
+Templates will be called with the following API
+ *Data reader class to create an Array of {@link Ext.data.Record} objects from an XML document @@ -56,9 +170,10 @@ var Employee = Ext.data.Record.create([ {name: 'occupation'} // This field will use "occupation" as the mapping. ]); var myReader = new Ext.data.XmlReader({ - totalRecords: "results", // The element which contains the total dataset size (optional) + totalProperty: "results", // The element which contains the total dataset size (optional) record: "row", // The repeated element which contains row information - id: "id" // The element within the row that provides an ID for the record (optional) + idProperty: "id" // The element within the row that provides an ID for the record (optional) + messageProperty: "msg" // The element within the response that provides a user-feedback message (optional) }, Employee); *
@@ -79,11 +194,12 @@ var myReader = new Ext.data.XmlReader({ </row> </dataset> - * @cfg {String} totalRecords The DomQuery path from which to retrieve the total number of records + * @cfg {String} totalProperty The DomQuery path from which to retrieve the total number of records * in the dataset. This is only needed if the whole dataset is not passed in one go, but is being * paged from the remote server. * @cfg {String} record The DomQuery path to the repeated element which contains record information. - * @cfg {String} success The DomQuery path to the success attribute used by forms. + * @cfg {String} record The DomQuery path to the repeated element which contains record information. + * @cfg {String} successProperty The DomQuery path to the success attribute used by forms. * @cfg {String} idPath The DomQuery path relative from the record element to the element that contains * a record identifier value. * @constructor @@ -94,6 +210,13 @@ var myReader = new Ext.data.XmlReader({ */ Ext.data.XmlReader = function(meta, recordType){ meta = meta || {}; + + // backwards compat, convert idPath or id / success + Ext.applyIf(meta, { + idProperty: meta.idProperty || meta.idPath || meta.id, + successProperty: meta.successProperty || meta.success + }); + Ext.data.XmlReader.superclass.constructor.call(this, meta, recordType || meta.fields); }; Ext.extend(Ext.data.XmlReader, Ext.data.DataReader, { @@ -124,36 +247,22 @@ Ext.extend(Ext.data.XmlReader, Ext.data.DataReader, { * @type XMLDocument */ this.xmlData = doc; - var root = doc.documentElement || doc; - var q = Ext.DomQuery; - var recordType = this.recordType, fields = recordType.prototype.fields; - var sid = this.meta.idPath || this.meta.id; - var totalRecords = 0, success = true; - if(this.meta.totalRecords){ - totalRecords = q.selectNumber(this.meta.totalRecords, root, 0); - } - if(this.meta.success){ - var sv = q.selectValue(this.meta.success, root, true); - success = sv !== false && sv !== 'false'; + var root = doc.documentElement || doc, + q = Ext.DomQuery, + totalRecords = 0, + success = true; + + if(this.meta.totalProperty){ + totalRecords = this.getTotal(root, 0); } - var records = []; - var ns = q.select(this.meta.record, root); - for(var i = 0, len = ns.length; i < len; i++) { - var n = ns[i]; - var values = {}; - var id = sid ? q.selectValue(sid, n) : undefined; - for(var j = 0, jlen = fields.length; j < jlen; j++){ - var f = fields.items[j]; - var v = q.selectValue(Ext.value(f.mapping, f.name, true), n, f.defaultValue); - v = f.convert(v, n); - values[f.name] = v; - } - var record = new recordType(values, id); - record.node = n; - records[records.length] = record; + if(this.meta.successProperty){ + success = this.getSuccess(root); } + var records = this.extractData(q.select(this.meta.record, root), true); // <-- true to return Ext.data.Record[] + + // TODO return Ext.data.Response instance. @see #readResponse return { success : success, records : records, @@ -161,74 +270,210 @@ Ext.extend(Ext.data.XmlReader, Ext.data.DataReader, { }; }, - // TODO: implement readResponse for XmlReader - readResponse : Ext.emptyFn -});/** - * @class Ext.data.XmlStore - * @extends Ext.data.Store - *
Small helper class to make creating {@link Ext.data.Store}s from XML data easier. - * A XmlStore will be automatically configured with a {@link Ext.data.XmlReader}.
- *A store configuration would be something like:
-var store = new Ext.data.XmlStore({
- // store configs
- autoDestroy: true,
- storeId: 'myStore',
- url: 'sheldon.xml', // automatically configures a HttpProxy
- // reader configs
- record: 'Item', // records will have an "Item" tag
- idPath: 'ASIN',
- totalRecords: '@TotalResults'
- fields: [
- // set up the fields mapping into the xml doc
- // The first needs mapping, the others are very basic
- {name: 'Author', mapping: 'ItemAttributes > Author'},
- 'Title', 'Manufacturer', 'ProductGroup'
- ]
-});
- * This store is configured to consume a returned object of the form:
-<?xml version="1.0" encoding="UTF-8"?>
-<ItemSearchResponse xmlns="http://webservices.amazon.com/AWSECommerceService/2009-05-15">
- <Items>
- <Request>
- <IsValid>True</IsValid>
- <ItemSearchRequest>
- <Author>Sidney Sheldon</Author>
- <SearchIndex>Books</SearchIndex>
- </ItemSearchRequest>
- </Request>
- <TotalResults>203</TotalResults>
- <TotalPages>21</TotalPages>
- <Item>
- <ASIN>0446355453</ASIN>
- <DetailPageURL>
- http://www.amazon.com/
- </DetailPageURL>
- <ItemAttributes>
- <Author>Sidney Sheldon</Author>
- <Manufacturer>Warner Books</Manufacturer>
- <ProductGroup>Book</ProductGroup>
- <Title>Master of the Game</Title>
- </ItemAttributes>
- </Item>
- </Items>
-</ItemSearchResponse>
- * Note: Although not listed here, this class accepts all of the configuration options of - * {@link Ext.data.XmlReader XmlReader}.
- * @constructor - * @param {Object} config - * @xtype xmlstore - */ -Ext.data.XmlStore = Ext.extend(Ext.data.Store, { - /** - * @cfg {Ext.data.DataReader} reader @hide - */ - constructor: function(config){ - Ext.data.XmlStore.superclass.constructor.call(this, Ext.apply(config, { - reader: new Ext.data.XmlReader(config) - })); - } -}); + /** + * Decode an XML response from server. + * @param {String} action [{@link Ext.data.Api#actions} create|read|update|destroy] + * @param {Object} response HTTP Response object from browser. + * @return {Ext.data.Response} An instance of {@link Ext.data.Response} + */ + readResponse : function(action, response) { + var q = Ext.DomQuery, + doc = response.responseXML, + root = doc.documentElement || doc; + + // create general Response instance. + var res = new Ext.data.Response({ + action: action, + success : this.getSuccess(root), + message: this.getMessage(root), + data: this.extractData(q.select(this.meta.record, root) || q.select(this.meta.root, root), false), + raw: doc + }); + + if (Ext.isEmpty(res.success)) { + throw new Ext.data.DataReader.Error('successProperty-response', this.meta.successProperty); + } + + // Create actions from a response having status 200 must return pk + if (action === Ext.data.Api.actions.create) { + var def = Ext.isDefined(res.data); + if (def && Ext.isEmpty(res.data)) { + throw new Ext.data.JsonReader.Error('root-empty', this.meta.root); + } + else if (!def) { + throw new Ext.data.JsonReader.Error('root-undefined-response', this.meta.root); + } + } + return res; + }, + + getSuccess : function() { + return true; + }, + + /** + * build response-data extractor functions. + * @private + * @ignore + */ + buildExtractors : function() { + if(this.ef){ + return; + } + var s = this.meta, + Record = this.recordType, + f = Record.prototype.fields, + fi = f.items, + fl = f.length; + + if(s.totalProperty) { + this.getTotal = this.createAccessor(s.totalProperty); + } + if(s.successProperty) { + this.getSuccess = this.createAccessor(s.successProperty); + } + if (s.messageProperty) { + this.getMessage = this.createAccessor(s.messageProperty); + } + this.getRoot = function(res) { + return (!Ext.isEmpty(res[this.meta.record])) ? res[this.meta.record] : res[this.meta.root]; + }; + if (s.idPath || s.idProperty) { + var g = this.createAccessor(s.idPath || s.idProperty); + this.getId = function(rec) { + var id = g(rec) || rec.id; + return (id === undefined || id === '') ? null : id; + }; + } else { + this.getId = function(){return null;}; + } + var ef = []; + for(var i = 0; i < fl; i++){ + f = fi[i]; + var map = (f.mapping !== undefined && f.mapping !== null) ? f.mapping : f.name; + ef.push(this.createAccessor(map)); + } + this.ef = ef; + }, + + /** + * Creates a function to return some particular key of data from a response. + * @param {String} key + * @return {Function} + * @private + * @ignore + */ + createAccessor : function(){ + var q = Ext.DomQuery; + return function(key) { + if (Ext.isFunction(key)) { + return key; + } + switch(key) { + case this.meta.totalProperty: + return function(root, def){ + return q.selectNumber(key, root, def); + }; + break; + case this.meta.successProperty: + return function(root, def) { + var sv = q.selectValue(key, root, true); + var success = sv !== false && sv !== 'false'; + return success; + }; + break; + default: + return function(root, def) { + return q.selectValue(key, root, def); + }; + break; + } + }; + }(), + + /** + * extracts values and type-casts a row of data from server, extracted by #extractData + * @param {Hash} data + * @param {Ext.data.Field[]} items + * @param {Number} len + * @private + * @ignore + */ + extractValues : function(data, items, len) { + var f, values = {}; + for(var j = 0; j < len; j++){ + f = items[j]; + var v = this.ef[j](data); + values[f.name] = f.convert((v !== undefined) ? v : f.defaultValue, data); + } + return values; + } +});/** + * @class Ext.data.XmlStore + * @extends Ext.data.Store + *Small helper class to make creating {@link Ext.data.Store}s from XML data easier. + * A XmlStore will be automatically configured with a {@link Ext.data.XmlReader}.
+ *A store configuration would be something like:
+var store = new Ext.data.XmlStore({
+ // store configs
+ autoDestroy: true,
+ storeId: 'myStore',
+ url: 'sheldon.xml', // automatically configures a HttpProxy
+ // reader configs
+ record: 'Item', // records will have an "Item" tag
+ idPath: 'ASIN',
+ totalRecords: '@TotalResults'
+ fields: [
+ // set up the fields mapping into the xml doc
+ // The first needs mapping, the others are very basic
+ {name: 'Author', mapping: 'ItemAttributes > Author'},
+ 'Title', 'Manufacturer', 'ProductGroup'
+ ]
+});
+ * This store is configured to consume a returned object of the form:
+<?xml version="1.0" encoding="UTF-8"?>
+<ItemSearchResponse xmlns="http://webservices.amazon.com/AWSECommerceService/2009-05-15">
+ <Items>
+ <Request>
+ <IsValid>True</IsValid>
+ <ItemSearchRequest>
+ <Author>Sidney Sheldon</Author>
+ <SearchIndex>Books</SearchIndex>
+ </ItemSearchRequest>
+ </Request>
+ <TotalResults>203</TotalResults>
+ <TotalPages>21</TotalPages>
+ <Item>
+ <ASIN>0446355453</ASIN>
+ <DetailPageURL>
+ http://www.amazon.com/
+ </DetailPageURL>
+ <ItemAttributes>
+ <Author>Sidney Sheldon</Author>
+ <Manufacturer>Warner Books</Manufacturer>
+ <ProductGroup>Book</ProductGroup>
+ <Title>Master of the Game</Title>
+ </ItemAttributes>
+ </Item>
+ </Items>
+</ItemSearchResponse>
+ * Note: Although not listed here, this class accepts all of the configuration options of + * {@link Ext.data.XmlReader XmlReader}.
+ * @constructor + * @param {Object} config + * @xtype xmlstore + */ +Ext.data.XmlStore = Ext.extend(Ext.data.Store, { + /** + * @cfg {Ext.data.DataReader} reader @hide + */ + constructor: function(config){ + Ext.data.XmlStore.superclass.constructor.call(this, Ext.apply(config, { + reader: new Ext.data.XmlReader(config) + })); + } +}); Ext.reg('xmlstore', Ext.data.XmlStore); \ No newline at end of file