/*
|
This file is part of Ext JS 4.2
|
|
Copyright (c) 2011-2013 Sencha Inc
|
|
Contact: http://www.sencha.com/contact
|
|
GNU General Public License Usage
|
This file may be used under the terms of the GNU General Public License version 3.0 as
|
published by the Free Software Foundation and appearing in the file LICENSE included in the
|
packaging of this file.
|
|
Please review the following information to ensure the GNU General Public License version 3.0
|
requirements will be met: http://www.gnu.org/copyleft/gpl.html.
|
|
If you are unsure which license is appropriate for your use, please contact the sales department
|
at http://www.sencha.com/contact.
|
|
Build date: 2013-05-16 14:36:50 (f9be68accb407158ba2b1be2c226a6ce1f649314)
|
*/
|
/**
|
* @author Ed Spencer
|
* @class Ext.data.writer.Xml
|
|
This class is used to write {@link Ext.data.Model} data to the server in an XML format.
|
The {@link #documentRoot} property is used to specify the root element in the XML document.
|
The {@link #record} option is used to specify the element name for each record that will make
|
up the XML document.
|
|
* @markdown
|
*/
|
Ext.define('Ext.data.writer.Xml', {
|
|
/* Begin Definitions */
|
|
extend: 'Ext.data.writer.Writer',
|
alternateClassName: 'Ext.data.XmlWriter',
|
|
alias: 'writer.xml',
|
|
/* End Definitions */
|
|
/**
|
* @cfg {String} documentRoot The name of the root element of the document. Defaults to <tt>'xmlData'</tt>.
|
* If there is more than 1 record and the root is not specified, the default document root will still be used
|
* to ensure a valid XML document is created.
|
*/
|
documentRoot: 'xmlData',
|
|
/**
|
* @cfg {String} defaultDocumentRoot The root to be used if {@link #documentRoot} is empty and a root is required
|
* to form a valid XML document.
|
*/
|
defaultDocumentRoot: 'xmlData',
|
|
/**
|
* @cfg {String} header A header to use in the XML document (such as setting the encoding or version).
|
* Defaults to <tt>''</tt>.
|
*/
|
header: '',
|
|
/**
|
* @cfg {String} record The name of the node to use for each record. Defaults to <tt>'record'</tt>.
|
*/
|
record: 'record',
|
|
//inherit docs
|
writeRecords: function(request, data) {
|
var me = this,
|
xml = [],
|
i = 0,
|
len = data.length,
|
root = me.documentRoot,
|
record = me.record,
|
needsRoot = data.length !== 1,
|
item,
|
key;
|
|
// may not exist
|
xml.push(me.header || '');
|
|
if (!root && needsRoot) {
|
root = me.defaultDocumentRoot;
|
}
|
|
if (root) {
|
xml.push('<', root, '>');
|
}
|
|
for (; i < len; ++i) {
|
item = data[i];
|
xml.push('<', record, '>');
|
for (key in item) {
|
if (item.hasOwnProperty(key)) {
|
xml.push('<', key, '>', item[key], '</', key, '>');
|
}
|
}
|
xml.push('</', record, '>');
|
}
|
|
if (root) {
|
xml.push('</', root, '>');
|
}
|
|
request.xmlData = xml.join('');
|
return request;
|
}
|
});
|
