X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/25ef3491bd9ae007ff1fc2b0d7943e6eaaccf775..6b044c28b5f26fb99c86c237ffad19741c0f7f3d:/src/data/XmlWriter.js diff --git a/src/data/XmlWriter.js b/src/data/XmlWriter.js index 270de9e6..365b1806 100644 --- a/src/data/XmlWriter.js +++ b/src/data/XmlWriter.js @@ -1,21 +1,38 @@ /*! - * Ext JS Library 3.0.3 - * Copyright(c) 2006-2009 Ext JS, LLC - * licensing@extjs.com - * http://www.extjs.com/license + * Ext JS Library 3.3.1 + * Copyright(c) 2006-2010 Sencha Inc. + * licensing@sencha.com + * http://www.sencha.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); - this.tpl = new Ext.XTemplate(this.tpl).compile(); + // 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} root [records] The name of the root element when writing multiple records to the server. Each + * @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: 
@@ -32,7 +49,7 @@ Ext.extend(Ext.data.XmlWriter, Ext.data.DataWriter, {
         <records><first>Barney</first></user>
     </records>
- * Defaults to records + * Defaults to records. Do not confuse the nature of this property with that of {@link #documentRoot} */ root: 'records', /** @@ -46,88 +63,96 @@ Ext.extend(Ext.data.XmlWriter, Ext.data.DataWriter, { */ xmlEncoding: 'ISO-8859-15', /** - * @cfg {String} tpl The xml template. Defaults to + * @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="{[values.nodes.length>1]}"><{root}}>',
+    <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="fields">
+        <tpl for=".">
             <{name}>{value}</{name}>
         </tpl>
         </{parent.record}>
     </tpl>
-    <tpl if="{[values.records.length>1]}"></{root}}></tpl>
+    <tpl if="records.length > 1"></{root}></tpl>
+    <tpl if="documentRoot"></{documentRoot}></tpl>
+ *

Templates will be called with the following API

+ * */ - // Break up encoding here in case it's being included by some kind of page that will parse it (eg. PHP) - tpl: '<' + '?xml version="{version}" encoding="{encoding}"?' + '><{documentRoot}><{name}>{value}<{root}><{parent.record}><{name}>{value}', + // 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}', + /** - * Final action of a write event. Apply the written data-object to params. - * @param {String} action [Ext.data.Api.create|read|update|destroy] - * @param {Ext.data.Record/Ext.data.Record[]} rs - * @param {Object} http params - * @param {Object/Object[]} rendered data. + * 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(action, rs, params, data) { + 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, - records: (Ext.isArray(rs)) ? data : [data] + baseParams: baseParams, + records: (Ext.isArray(data[0])) ? data : [data] }); }, - /** - * Converts an Ext.data.Record to xml - * @param {Ext.data.Record} rec - * @return {String} rendered xml-element - * @private - */ - toXml : function(data) { - var fields = []; - Ext.iterate(data, function(k, v) { - fields.push({ - name: k, - value: v - }); - },this); - return { - fields: fields - }; - }, - /** * createRecord + * @protected * @param {Ext.data.Record} rec - * @return {String} xml element - * @private + * @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.toXml(this.toHash(rec)); + return this.toArray(this.toHash(rec)); }, /** * updateRecord + * @protected * @param {Ext.data.Record} rec - * @return {String} xml element - * @private + * @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.toXml(this.toHash(rec)); + return this.toArray(this.toHash(rec)); }, /** * destroyRecord + * @protected * @param {Ext.data.Record} rec - * @return {String} xml element + * @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.toXml(data); + return this.toArray(data); } }); -