Class CQ.Ext.data.XmlWriter

One can easily provide his/her own custom 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

• {String} version [1.0] The xml version.
• {String} encoding [ISO-8859-15] The xml encoding.
• {String/false} documentRoot The XML document root-node name or false if not required. See documentRoot and forceDocumentRoot.
• {String} record The meta-data parameter defined on your CQ.Ext.data.XmlReader.record configuration represents the name of the xml-tag containing each record.
• {String} root The meta-data parameter defined by CQ.Ext.data.XmlWriter.root configuration-parameter. Represents the name of the xml root-tag when sending multiple records to the server.
• {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. Each item within the records array will contain an array of field objects having the following properties:
  • {String} name The field-name of the record as defined by your CQ.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.
  • {Mixed} value The record value of the field enclosed within XML tags specified by name property above.
• {Array} baseParams. The baseParams as defined upon CQ.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 records parameter above. See documentRoot and forceDocumentRoot.