/*! * Ext JS Library 3.2.0 * Copyright(c) 2006-2010 Ext JS, Inc. * licensing@extjs.com * http://www.extjs.com/license */ /** * @class Ext.data.XmlWriter * @extends Ext.data.DataWriter * DataWriter extension for writing an array or single {@link Ext.data.Record} object(s) in preparation for executing a remote CRUD action via XML. * XmlWriter uses an instance of {@link Ext.XTemplate} for maximum flexibility in defining your own custom XML schema if the default schema is not appropriate for your needs. * See the {@link #tpl} configuration-property. */ Ext.data.XmlWriter = function(params) { Ext.data.XmlWriter.superclass.constructor.apply(this, arguments); // compile the XTemplate for rendering XML documents. this.tpl = (typeof(this.tpl) === 'string') ? new Ext.XTemplate(this.tpl).compile() : this.tpl.compile(); }; Ext.extend(Ext.data.XmlWriter, Ext.data.DataWriter, { /** * @cfg {String} documentRoot [xrequest] (Optional) The name of the XML document root-node. Note: * this parameter is required only when sending extra {@link Ext.data.Store#baseParams baseParams} to the server * during a write-request -- if no baseParams are set, the {@link Ext.data.XmlReader#record} meta-property can * suffice as the XML document root-node for write-actions involving just a single record. For requests * involving multiple records and NO baseParams, the {@link Ext.data.XmlWriter#root} property can * act as the XML document root. */ documentRoot: 'xrequest', /** * @cfg {Boolean} forceDocumentRoot [false] Set to true to force XML documents having a root-node as defined * by {@link #documentRoot}, even with no baseParams defined. */ forceDocumentRoot: false, /** * @cfg {String} root [records] The name of the containing element which will contain the nodes of an write-action involving multiple records. Each * xml-record written to the server will be wrapped in an element named after {@link Ext.data.XmlReader#record} property. * eg:
<?xml version="1.0" encoding="UTF-8"?>
<user><first>Barney</first></user>
* However, when multiple records are written in a batch-operation, these records must be wrapped in a containing * Element. * eg:
<?xml version="1.0" encoding="UTF-8"?>
    <records>
        <first>Barney</first></user>
        <records><first>Barney</first></user>
    </records>
* Defaults to records. Do not confuse the nature of this property with that of {@link #documentRoot} */ root: 'records', /** * @cfg {String} xmlVersion [1.0] The version written to header of xml documents.
<?xml version="1.0" encoding="ISO-8859-15"?>
*/ xmlVersion : '1.0', /** * @cfg {String} xmlEncoding [ISO-8859-15] The encoding written to header of xml documents.
<?xml version="1.0" encoding="ISO-8859-15"?>
*/ xmlEncoding: 'ISO-8859-15', /** * @cfg {String/Ext.XTemplate} tpl The XML template used to render {@link Ext.data.Api#actions write-actions} to your server. *

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

* */ // Encoding the ? here in case it's being included by some kind of page that will parse it (eg. PHP) tpl: '<\u003fxml version="{version}" encoding="{encoding}"\u003f><{documentRoot}><{name}>{value}<{root}><{parent.record}><{name}>{value}', /** * XmlWriter implementation of the final stage of a write action. * @param {Object} params Transport-proxy's (eg: {@link Ext.Ajax#request}) params-object to write-to. * @param {Object} baseParams as defined by {@link Ext.data.Store#baseParams}. The baseParms must be encoded by the extending class, eg: {@link Ext.data.JsonWriter}, {@link Ext.data.XmlWriter}. * @param {Object/Object[]} data Data-object representing the compiled Store-recordset. */ render : function(params, baseParams, data) { baseParams = this.toArray(baseParams); params.xmlData = this.tpl.applyTemplate({ version: this.xmlVersion, encoding: this.xmlEncoding, documentRoot: (baseParams.length > 0 || this.forceDocumentRoot === true) ? this.documentRoot : false, record: this.meta.record, root: this.root, baseParams: baseParams, records: (Ext.isArray(data[0])) ? data : [data] }); }, /** * createRecord * @protected * @param {Ext.data.Record} rec * @return {Array} Array of name:value pairs for attributes of the {@link Ext.data.Record}. See {@link Ext.data.DataWriter#toHash}. */ createRecord : function(rec) { return this.toArray(this.toHash(rec)); }, /** * updateRecord * @protected * @param {Ext.data.Record} rec * @return {Array} Array of {name:value} pairs for attributes of the {@link Ext.data.Record}. See {@link Ext.data.DataWriter#toHash}. */ updateRecord : function(rec) { return this.toArray(this.toHash(rec)); }, /** * destroyRecord * @protected * @param {Ext.data.Record} rec * @return {Array} Array containing a attribute-object (name/value pair) representing the {@link Ext.data.DataReader#idProperty idProperty}. */ destroyRecord : function(rec) { var data = {}; data[this.meta.idProperty] = rec.id; return this.toArray(data); } }); /** * @class Ext.data.XmlReader * @extends Ext.data.DataReader *

Data reader class to create an Array of {@link Ext.data.Record} objects from an XML document * based on mappings in a provided {@link Ext.data.Record} constructor.

*

Note: that 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".

*

Example code:

*

var Employee = Ext.data.Record.create([
   {name: 'name', mapping: 'name'},     // "mapping" property not needed if it is the same as "name"
   {name: 'occupation'}                 // This field will use "occupation" as the mapping.
]);
var myReader = new Ext.data.XmlReader({
   totalProperty: "results", // The element which contains the total dataset size (optional)
   record: "row",           // The repeated element which contains row information
   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);
*

* This would consume an XML file like this: *


<?xml version="1.0" encoding="UTF-8"?>
<dataset>
 <results>2</results>
 <row>
   <id>1</id>
   <name>Bill</name>
   <occupation>Gardener</occupation>
 </row>
 <row>
   <id>2</id>
   <name>Ben</name>
   <occupation>Horticulturalist</occupation>
 </row>
</dataset>
* @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} 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 * Create a new XmlReader. * @param {Object} meta Metadata configuration options * @param {Object} recordType Either an Array of field definition objects as passed to * {@link Ext.data.Record#create}, or a Record constructor object created using {@link Ext.data.Record#create}. */ 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, { /** * This method is only used by a DataProxy which has retrieved data from a remote server. * @param {Object} response The XHR object which contains the parsed XML document. The response is expected * to contain a property called responseXML which refers to an XML document object. * @return {Object} records A data block which is used by an {@link Ext.data.Store} as * a cache of Ext.data.Records. */ read : function(response){ var doc = response.responseXML; if(!doc) { throw {message: "XmlReader.read: XML Document not available"}; } return this.readRecords(doc); }, /** * Create a data block containing Ext.data.Records from an XML document. * @param {Object} doc A parsed XML document. * @return {Object} records A data block which is used by an {@link Ext.data.Store} as * a cache of Ext.data.Records. */ readRecords : function(doc){ /** * After any data loads/reads, the raw XML Document is available for further custom processing. * @type XMLDocument */ this.xmlData = doc; var root = doc.documentElement || doc, q = Ext.DomQuery, totalRecords = 0, success = true; if(this.meta.totalProperty){ totalRecords = this.getTotal(root, 0); } 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, totalRecords : totalRecords || records.length }; }, /** * 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; // create general Response instance. var res = new Ext.data.Response({ action: action, success : this.getSuccess(doc), message: this.getMessage(doc), data: this.extractData(q.select(this.meta.record, doc) || q.select(this.meta.root, doc), 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) { 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>
 * 
* An object literal of this form could also be used as the {@link #data} config option.

*

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);