3 * Copyright(c) 2006-2010 Ext JS, Inc.
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 // Encoding the ? here in case it's being included by some kind of page that will parse it (eg. PHP)
105 tpl: '<tpl for="."><\u003fxml version="{version}" encoding="{encoding}"\u003f><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>',
109 * XmlWriter implementation of the final stage of a write action.
110 * @param {Object} params Transport-proxy's (eg: {@link Ext.Ajax#request}) params-object to write-to.
111 * @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}.
112 * @param {Object/Object[]} data Data-object representing the compiled Store-recordset.
114 render : function(params, baseParams, data) {
115 baseParams = this.toArray(baseParams);
116 params.xmlData = this.tpl.applyTemplate({
117 version: this.xmlVersion,
118 encoding: this.xmlEncoding,
119 documentRoot: (baseParams.length > 0 || this.forceDocumentRoot === true) ? this.documentRoot : false,
120 record: this.meta.record,
122 baseParams: baseParams,
123 records: (Ext.isArray(data[0])) ? data : [data]
130 * @param {Ext.data.Record} rec
131 * @return {Array} Array of <tt>name:value</tt> pairs for attributes of the {@link Ext.data.Record}. See {@link Ext.data.DataWriter#toHash}.
133 createRecord : function(rec) {
134 return this.toArray(this.toHash(rec));
140 * @param {Ext.data.Record} rec
141 * @return {Array} Array of {name:value} pairs for attributes of the {@link Ext.data.Record}. See {@link Ext.data.DataWriter#toHash}.
143 updateRecord : function(rec) {
144 return this.toArray(this.toHash(rec));
150 * @param {Ext.data.Record} rec
151 * @return {Array} Array containing a attribute-object (name/value pair) representing the {@link Ext.data.DataReader#idProperty idProperty}.
153 destroyRecord : function(rec) {
155 data[this.meta.idProperty] = rec.id;
156 return this.toArray(data);