3 * Copyright(c) 2006-2010 Ext JS, LLC
5 * http://www.extjs.com/license
8 * @class Ext.data.XmlWriter
9 * @extends Ext.data.DataWriter
10 * DataWriter extension for writing an array or single {@link Ext.data.Record} object(s) in preparation for executing a remote CRUD action via XML.
11 * 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.
12 * See the {@link #tpl} configuration-property.
14 Ext.data.XmlWriter = function(params) {
15 Ext.data.XmlWriter.superclass.constructor.apply(this, arguments);
16 // compile the XTemplate for rendering XML documents.
17 this.tpl = (typeof(this.tpl) === 'string') ? new Ext.XTemplate(this.tpl).compile() : this.tpl.compile();
19 Ext.extend(Ext.data.XmlWriter, Ext.data.DataWriter, {
21 * @cfg {String} documentRoot [xrequest] (Optional) The name of the XML document root-node. <b>Note:</b>
22 * this parameter is required </b>only when</b> sending extra {@link Ext.data.Store#baseParams baseParams} to the server
23 * during a write-request -- if no baseParams are set, the {@link Ext.data.XmlReader#record} meta-property can
24 * suffice as the XML document root-node for write-actions involving just a <b>single record</b>. For requests
25 * involving <b>multiple</b> records and <b>NO</b> baseParams, the {@link Ext.data.XmlWriter#root} property can
26 * act as the XML document root.
28 documentRoot: 'xrequest',
30 * @cfg {Boolean} forceDocumentRoot [false] Set to <tt>true</tt> to force XML documents having a root-node as defined
31 * by {@link #documentRoot}, even with no baseParams defined.
33 forceDocumentRoot: false,
35 * @cfg {String} root [records] The name of the containing element which will contain the nodes of an write-action involving <b>multiple</b> records. Each
36 * xml-record written to the server will be wrapped in an element named after {@link Ext.data.XmlReader#record} property.
39 <?xml version="1.0" encoding="UTF-8"?>
40 <user><first>Barney</first></user>
42 * However, when <b>multiple</b> records are written in a batch-operation, these records must be wrapped in a containing
46 <?xml version="1.0" encoding="UTF-8"?>
48 <first>Barney</first></user>
49 <records><first>Barney</first></user>
52 * Defaults to <tt>records</tt>. Do not confuse the nature of this property with that of {@link #documentRoot}
56 * @cfg {String} xmlVersion [1.0] The <tt>version</tt> written to header of xml documents.
57 <code><pre><?xml version="1.0" encoding="ISO-8859-15"?></pre></code>
61 * @cfg {String} xmlEncoding [ISO-8859-15] The <tt>encoding</tt> written to header of xml documents.
62 <code><pre><?xml version="1.0" encoding="ISO-8859-15"?></pre></code>
64 xmlEncoding: 'ISO-8859-15',
66 * @cfg {String/Ext.XTemplate} tpl The XML template used to render {@link Ext.data.Api#actions write-actions} to your server.
67 * <p>One can easily provide his/her own custom {@link Ext.XTemplate#constructor template-definition} if the default does not suffice.</p>
70 <?xml version="{version}" encoding="{encoding}"?>
71 <tpl if="documentRoot"><{documentRoot}>
72 <tpl for="baseParams">
74 <{name}>{value}</{name}>
77 <tpl if="records.length > 1"><{root}>',
78 <tpl for="records">
81 <{name}>{value}</{name}>
85 <tpl if="records.length > 1"></{root}></tpl>
86 <tpl if="documentRoot"></{documentRoot}></tpl>
88 * <p>Templates will be called with the following API</p>
90 * <li>{String} version [1.0] The xml version.</li>
91 * <li>{String} encoding [ISO-8859-15] The xml encoding.</li>
92 * <li>{String/false} documentRoot The XML document root-node name or <tt>false</tt> if not required. See {@link #documentRoot} and {@link #forceDocumentRoot}.</li>
93 * <li>{String} record The meta-data parameter defined on your {@link Ext.data.XmlReader#record} configuration represents the name of the xml-tag containing each record.</li>
94 * <li>{String} root The meta-data parameter defined by {@link Ext.data.XmlWriter#root} configuration-parameter. Represents the name of the xml root-tag when sending <b>multiple</b> records to the server.</li>
95 * <li>{Array} records The records being sent to the server, ie: the subject of the write-action being performed. The records parameter will be always be an array, even when only a single record is being acted upon.
96 * Each item within the records array will contain an array of field objects having the following properties:
98 * <li>{String} name The field-name of the record as defined by your {@link Ext.data.Record#create Ext.data.Record definition}. The "mapping" property will be used, otherwise it will match the "name" property. Use this parameter to define the XML tag-name of the property.</li>
99 * <li>{Mixed} value The record value of the field enclosed within XML tags specified by name property above.</li>
101 * <li>{Array} baseParams. The baseParams as defined upon {@link Ext.data.Store#baseParams}. Note that the baseParams have been converted into an array of [{name : "foo", value: "bar"}, ...] pairs in the same manner as the <b>records</b> parameter above. See {@link #documentRoot} and {@link #forceDocumentRoot}.</li>
104 // Break up encoding here in case it's being included by some kind of page that will parse it (eg. PHP)
105 tpl: '<tpl for="."><' + '?xml version="{version}" encoding="{encoding}"?' + '><tpl if="documentRoot"><{documentRoot}><tpl for="baseParams"><tpl for="."><{name}>{value}</{name}</tpl></tpl></tpl><tpl if="records.length>1"><{root}></tpl><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></tpl>',
108 * XmlWriter implementation of the final stage of a write action.
109 * @param {Object} params Transport-proxy's (eg: {@link Ext.Ajax#request}) params-object to write-to.
110 * @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}.
111 * @param {Object/Object[]} data Data-object representing the compiled Store-recordset.
113 render : function(params, baseParams, data) {
114 baseParams = this.toArray(baseParams);
115 params.xmlData = this.tpl.applyTemplate({
116 version: this.xmlVersion,
117 encoding: this.xmlEncoding,
118 documentRoot: (baseParams.length > 0 || this.forceDocumentRoot === true) ? this.documentRoot : false,
119 record: this.meta.record,
121 baseParams: baseParams,
122 records: (Ext.isArray(data[0])) ? data : [data]
129 * @param {Ext.data.Record} rec
130 * @return {Array} Array of <tt>name:value</tt> pairs for attributes of the {@link Ext.data.Record}. See {@link Ext.data.DataWriter#toHash}.
132 createRecord : function(rec) {
133 return this.toArray(this.toHash(rec));
139 * @param {Ext.data.Record} rec
140 * @return {Array} Array of {name:value} pairs for attributes of the {@link Ext.data.Record}. See {@link Ext.data.DataWriter#toHash}.
142 updateRecord : function(rec) {
143 return this.toArray(this.toHash(rec));
149 * @param {Ext.data.Record} rec
150 * @return {Array} Array containing a attribute-object (name/value pair) representing the {@link Ext.data.DataReader#idProperty idProperty}.
152 destroyRecord : function(rec) {
154 data[this.meta.idProperty] = rec.id;
155 return this.toArray(data);
160 * @class Ext.data.XmlReader
161 * @extends Ext.data.DataReader
162 * <p>Data reader class to create an Array of {@link Ext.data.Record} objects from an XML document
163 * based on mappings in a provided {@link Ext.data.Record} constructor.</p>
164 * <p><b>Note</b>: that in order for the browser to parse a returned XML document, the Content-Type
165 * header in the HTTP response must be set to "text/xml" or "application/xml".</p>
166 * <p>Example code:</p>
168 var Employee = Ext.data.Record.create([
169 {name: 'name', mapping: 'name'}, // "mapping" property not needed if it is the same as "name"
170 {name: 'occupation'} // This field will use "occupation" as the mapping.
172 var myReader = new Ext.data.XmlReader({
173 totalProperty: "results", // The element which contains the total dataset size (optional)
174 record: "row", // The repeated element which contains row information
175 idProperty: "id" // The element within the row that provides an ID for the record (optional)
176 messageProperty: "msg" // The element within the response that provides a user-feedback message (optional)
180 * This would consume an XML file like this:
182 <?xml version="1.0" encoding="UTF-8"?>
184 <results>2</results>
187 <name>Bill</name>
188 <occupation>Gardener</occupation>
192 <name>Ben</name>
193 <occupation>Horticulturalist</occupation>
197 * @cfg {String} totalProperty The DomQuery path from which to retrieve the total number of records
198 * in the dataset. This is only needed if the whole dataset is not passed in one go, but is being
199 * paged from the remote server.
200 * @cfg {String} record The DomQuery path to the repeated element which contains record information.
201 * @cfg {String} record The DomQuery path to the repeated element which contains record information.
202 * @cfg {String} successProperty The DomQuery path to the success attribute used by forms.
203 * @cfg {String} idPath The DomQuery path relative from the record element to the element that contains
204 * a record identifier value.
206 * Create a new XmlReader.
207 * @param {Object} meta Metadata configuration options
208 * @param {Object} recordType Either an Array of field definition objects as passed to
209 * {@link Ext.data.Record#create}, or a Record constructor object created using {@link Ext.data.Record#create}.
211 Ext.data.XmlReader = function(meta, recordType){
214 // backwards compat, convert idPath or id / success
216 idProperty: meta.idProperty || meta.idPath || meta.id,
217 successProperty: meta.successProperty || meta.success
220 Ext.data.XmlReader.superclass.constructor.call(this, meta, recordType || meta.fields);
222 Ext.extend(Ext.data.XmlReader, Ext.data.DataReader, {
224 * This method is only used by a DataProxy which has retrieved data from a remote server.
225 * @param {Object} response The XHR object which contains the parsed XML document. The response is expected
226 * to contain a property called <tt>responseXML</tt> which refers to an XML document object.
227 * @return {Object} records A data block which is used by an {@link Ext.data.Store} as
228 * a cache of Ext.data.Records.
230 read : function(response){
231 var doc = response.responseXML;
233 throw {message: "XmlReader.read: XML Document not available"};
235 return this.readRecords(doc);
239 * Create a data block containing Ext.data.Records from an XML document.
240 * @param {Object} doc A parsed XML document.
241 * @return {Object} records A data block which is used by an {@link Ext.data.Store} as
242 * a cache of Ext.data.Records.
244 readRecords : function(doc){
246 * After any data loads/reads, the raw XML Document is available for further custom processing.
251 var root = doc.documentElement || doc,
256 if(this.meta.totalProperty){
257 totalRecords = this.getTotal(root, 0);
259 if(this.meta.successProperty){
260 success = this.getSuccess(root);
263 var records = this.extractData(q.select(this.meta.record, root), true); // <-- true to return Ext.data.Record[]
265 // TODO return Ext.data.Response instance. @see #readResponse
269 totalRecords : totalRecords || records.length
274 * Decode a json response from server.
275 * @param {String} action [{@link Ext.data.Api#actions} create|read|update|destroy]
276 * @param {Object} response HTTP Response object from browser.
277 * @return {Ext.data.Response} response Returns an instance of {@link Ext.data.Response}
279 readResponse : function(action, response) {
280 var q = Ext.DomQuery,
281 doc = response.responseXML;
283 // create general Response instance.
284 var res = new Ext.data.Response({
286 success : this.getSuccess(doc),
287 message: this.getMessage(doc),
288 data: this.extractData(q.select(this.meta.record, doc) || q.select(this.meta.root, doc), false),
292 if (Ext.isEmpty(res.success)) {
293 throw new Ext.data.DataReader.Error('successProperty-response', this.meta.successProperty);
296 // Create actions from a response having status 200 must return pk
297 if (action === Ext.data.Api.actions.create) {
298 var def = Ext.isDefined(res.data);
299 if (def && Ext.isEmpty(res.data)) {
300 throw new Ext.data.JsonReader.Error('root-empty', this.meta.root);
303 throw new Ext.data.JsonReader.Error('root-undefined-response', this.meta.root);
309 getSuccess : function() {
314 * build response-data extractor functions.
318 buildExtractors : function() {
323 Record = this.recordType,
324 f = Record.prototype.fields,
328 if(s.totalProperty) {
329 this.getTotal = this.createAccessor(s.totalProperty);
331 if(s.successProperty) {
332 this.getSuccess = this.createAccessor(s.successProperty);
334 if (s.messageProperty) {
335 this.getMessage = this.createAccessor(s.messageProperty);
337 this.getRoot = function(res) {
338 return (!Ext.isEmpty(res[this.meta.record])) ? res[this.meta.record] : res[this.meta.root];
340 if (s.idPath || s.idProperty) {
341 var g = this.createAccessor(s.idPath || s.idProperty);
342 this.getId = function(rec) {
343 var id = g(rec) || rec.id;
344 return (id === undefined || id === '') ? null : id;
347 this.getId = function(){return null;};
350 for(var i = 0; i < fl; i++){
352 var map = (f.mapping !== undefined && f.mapping !== null) ? f.mapping : f.name;
353 ef.push(this.createAccessor(map));
359 * Creates a function to return some particular key of data from a response.
360 * @param {String} key
365 createAccessor : function(){
366 var q = Ext.DomQuery;
367 return function(key) {
369 case this.meta.totalProperty:
370 return function(root, def){
371 return q.selectNumber(key, root, def);
374 case this.meta.successProperty:
375 return function(root, def) {
376 var sv = q.selectValue(key, root, true);
377 var success = sv !== false && sv !== 'false';
382 return function(root, def) {
383 return q.selectValue(key, root, def);
391 * extracts values and type-casts a row of data from server, extracted by #extractData
393 * @param {Ext.data.Field[]} items
394 * @param {Number} len
398 extractValues : function(data, items, len) {
400 for(var j = 0; j < len; j++){
402 var v = this.ef[j](data);
403 values[f.name] = f.convert((v !== undefined) ? v : f.defaultValue, data);
408 * @class Ext.data.XmlStore
\r
409 * @extends Ext.data.Store
\r
410 * <p>Small helper class to make creating {@link Ext.data.Store}s from XML data easier.
\r
411 * A XmlStore will be automatically configured with a {@link Ext.data.XmlReader}.</p>
\r
412 * <p>A store configuration would be something like:<pre><code>
\r
413 var store = new Ext.data.XmlStore({
\r
416 storeId: 'myStore',
\r
417 url: 'sheldon.xml', // automatically configures a HttpProxy
\r
419 record: 'Item', // records will have an "Item" tag
\r
421 totalRecords: '@TotalResults'
\r
423 // set up the fields mapping into the xml doc
\r
424 // The first needs mapping, the others are very basic
\r
425 {name: 'Author', mapping: 'ItemAttributes > Author'},
\r
426 'Title', 'Manufacturer', 'ProductGroup'
\r
429 * </code></pre></p>
\r
430 * <p>This store is configured to consume a returned object of the form:<pre><code>
\r
431 <?xml version="1.0" encoding="UTF-8"?>
\r
432 <ItemSearchResponse xmlns="http://webservices.amazon.com/AWSECommerceService/2009-05-15">
\r
435 <IsValid>True</IsValid>
\r
436 <ItemSearchRequest>
\r
437 <Author>Sidney Sheldon</Author>
\r
438 <SearchIndex>Books</SearchIndex>
\r
439 </ItemSearchRequest>
\r
441 <TotalResults>203</TotalResults>
\r
442 <TotalPages>21</TotalPages>
\r
444 <ASIN>0446355453</ASIN>
\r
446 http://www.amazon.com/
\r
447 </DetailPageURL>
\r
448 <ItemAttributes>
\r
449 <Author>Sidney Sheldon</Author>
\r
450 <Manufacturer>Warner Books</Manufacturer>
\r
451 <ProductGroup>Book</ProductGroup>
\r
452 <Title>Master of the Game</Title>
\r
453 </ItemAttributes>
\r
456 </ItemSearchResponse>
\r
458 * An object literal of this form could also be used as the {@link #data} config option.</p>
\r
459 * <p><b>Note:</b> Although not listed here, this class accepts all of the configuration options of
\r
460 * <b>{@link Ext.data.XmlReader XmlReader}</b>.</p>
\r
462 * @param {Object} config
\r
465 Ext.data.XmlStore = Ext.extend(Ext.data.Store, {
\r
467 * @cfg {Ext.data.DataReader} reader @hide
\r
469 constructor: function(config){
\r
470 Ext.data.XmlStore.superclass.constructor.call(this, Ext.apply(config, {
\r
471 reader: new Ext.data.XmlReader(config)
\r
475 Ext.reg('xmlstore', Ext.data.XmlStore);