Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / pkgs / data-xml-debug.js
diff --git a/pkgs/data-xml-debug.js b/pkgs/data-xml-debug.js
deleted file mode 100644 (file)
index 25fde48..0000000
+++ /dev/null
@@ -1,475 +0,0 @@
-/*!
- * Ext JS Library 3.1.1
- * Copyright(c) 2006-2010 Ext JS, LLC
- * licensing@extjs.com
- * http://www.extjs.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);
-    // 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} documentRoot [xrequest] (Optional) The name of the XML document root-node.  <b>Note:</b>
-     * this parameter is required </b>only when</b> 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 <b>single record</b>.  For requests
-     * involving <b>multiple</b> records and <b>NO</b> baseParams, the {@link Ext.data.XmlWriter#root} property can
-     * act as the XML document root.
-     */
-    documentRoot: 'xrequest',
-    /**
-     * @cfg {Boolean} forceDocumentRoot [false] Set to <tt>true</tt> 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 <b>multiple</b> records.  Each
-     * xml-record written to the server will be wrapped in an element named after {@link Ext.data.XmlReader#record} property.
-     * eg:
-<code><pre>
-&lt;?xml version="1.0" encoding="UTF-8"?>
-&lt;user>&lt;first>Barney&lt;/first>&lt;/user>
-</code></pre>
-     * However, when <b>multiple</b> records are written in a batch-operation, these records must be wrapped in a containing
-     * Element.
-     * eg:
-<code><pre>
-&lt;?xml version="1.0" encoding="UTF-8"?>
-    &lt;records>
-        &lt;first>Barney&lt;/first>&lt;/user>
-        &lt;records>&lt;first>Barney&lt;/first>&lt;/user>
-    &lt;/records>
-</code></pre>
-     * Defaults to <tt>records</tt>.  Do not confuse the nature of this property with that of {@link #documentRoot}
-     */
-    root: 'records',
-    /**
-     * @cfg {String} xmlVersion [1.0] The <tt>version</tt> written to header of xml documents.
-<code><pre>&lt;?xml version="1.0" encoding="ISO-8859-15"?></pre></code>
-     */
-    xmlVersion : '1.0',
-    /**
-     * @cfg {String} xmlEncoding [ISO-8859-15] The <tt>encoding</tt> written to header of xml documents.
-<code><pre>&lt;?xml version="1.0" encoding="ISO-8859-15"?></pre></code>
-     */
-    xmlEncoding: 'ISO-8859-15',
-    /**
-     * @cfg {String/Ext.XTemplate} tpl The XML template used to render {@link Ext.data.Api#actions write-actions} to your server.
-     * <p>One can easily provide his/her own custom {@link Ext.XTemplate#constructor template-definition} if the default does not suffice.</p>
-     * <p>Defaults to:</p>
-<code><pre>
-&lt;?xml version="{version}" encoding="{encoding}"?>
-    &lt;tpl if="documentRoot">&lt;{documentRoot}>
-    &lt;tpl for="baseParams">
-        &lt;tpl for=".">
-            &lt;{name}>{value}&lt;/{name}>
-        &lt;/tpl>
-    &lt;/tpl>
-    &lt;tpl if="records.length &gt; 1">&lt;{root}>',
-    &lt;tpl for="records">
-        &lt;{parent.record}>
-        &lt;tpl for=".">
-            &lt;{name}>{value}&lt;/{name}>
-        &lt;/tpl>
-        &lt;/{parent.record}>
-    &lt;/tpl>
-    &lt;tpl if="records.length &gt; 1">&lt;/{root}>&lt;/tpl>
-    &lt;tpl if="documentRoot">&lt;/{documentRoot}>&lt;/tpl>
-</pre></code>
-     * <p>Templates will be called with the following API</p>
-     * <ul>
-     * <li>{String} version [1.0] The xml version.</li>
-     * <li>{String} encoding [ISO-8859-15] The xml encoding.</li>
-     * <li>{String/false} documentRoot The XML document root-node name or <tt>false</tt> if not required.  See {@link #documentRoot} and {@link #forceDocumentRoot}.</li>
-     * <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>
-     * <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>
-     * <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.
-     *     Each item within the records array will contain an array of field objects having the following properties:
-     *     <ul>
-     *         <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>
-     *         <li>{Mixed} value The record value of the field enclosed within XML tags specified by name property above.</li>
-     *     </ul></li>
-     * <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>
-     * </ul>
-     */
-    // Break up encoding here in case it's being included by some kind of page that will parse it (eg. PHP)
-    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&gt;1"><{root}></tpl><tpl for="records"><{parent.record}><tpl for="."><{name}>{value}</{name}></tpl></{parent.record}></tpl><tpl if="records.length&gt;1"></{root}></tpl><tpl if="documentRoot"></{documentRoot}></tpl></tpl>',
-
-    /**
-     * 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(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,
-            baseParams: baseParams,
-            records: (Ext.isArray(data[0])) ? data : [data]
-        });
-    },
-
-    /**
-     * createRecord
-     * @protected
-     * @param {Ext.data.Record} rec
-     * @return {Array} Array of <tt>name:value</tt> pairs for attributes of the {@link Ext.data.Record}.  See {@link Ext.data.DataWriter#toHash}.
-     */
-    createRecord : function(rec) {
-        return this.toArray(this.toHash(rec));
-    },
-
-    /**
-     * updateRecord
-     * @protected
-     * @param {Ext.data.Record} rec
-     * @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.toArray(this.toHash(rec));
-
-    },
-    /**
-     * destroyRecord
-     * @protected
-     * @param {Ext.data.Record} rec
-     * @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.toArray(data);
-    }
-});
-
-/**
- * @class Ext.data.XmlReader
- * @extends Ext.data.DataReader
- * <p>Data reader class to create an Array of {@link Ext.data.Record} objects from an XML document
- * based on mappings in a provided {@link Ext.data.Record} constructor.</p>
- * <p><b>Note</b>: that in order for the browser to parse a returned XML document, the Content-Type
- * header in the HTTP response must be set to "text/xml" or "application/xml".</p>
- * <p>Example code:</p>
- * <pre><code>
-var Employee = Ext.data.Record.create([
-   {name: 'name', mapping: 'name'},     // "mapping" property not needed if it is the same as "name"
-   {name: 'occupation'}                 // This field will use "occupation" as the mapping.
-]);
-var myReader = new Ext.data.XmlReader({
-   totalProperty: "results", // The element which contains the total dataset size (optional)
-   record: "row",           // The repeated element which contains row information
-   idProperty: "id"         // The element within the row that provides an ID for the record (optional)
-   messageProperty: "msg"   // The element within the response that provides a user-feedback message (optional)
-}, Employee);
-</code></pre>
- * <p>
- * This would consume an XML file like this:
- * <pre><code>
-&lt;?xml version="1.0" encoding="UTF-8"?>
-&lt;dataset>
- &lt;results>2&lt;/results>
- &lt;row>
-   &lt;id>1&lt;/id>
-   &lt;name>Bill&lt;/name>
-   &lt;occupation>Gardener&lt;/occupation>
- &lt;/row>
- &lt;row>
-   &lt;id>2&lt;/id>
-   &lt;name>Ben&lt;/name>
-   &lt;occupation>Horticulturalist&lt;/occupation>
- &lt;/row>
-&lt;/dataset>
-</code></pre>
- * @cfg {String} totalProperty The DomQuery path from which to retrieve the total number of records
- * in the dataset. This is only needed if the whole dataset is not passed in one go, but is being
- * paged from the remote server.
- * @cfg {String} record The DomQuery path to the repeated element which contains record information.
- * @cfg {String} record The DomQuery path to the repeated element which contains record information.
- * @cfg {String} successProperty The DomQuery path to the success attribute used by forms.
- * @cfg {String} idPath The DomQuery path relative from the record element to the element that contains
- * a record identifier value.
- * @constructor
- * Create a new XmlReader.
- * @param {Object} meta Metadata configuration options
- * @param {Object} recordType Either an Array of field definition objects as passed to
- * {@link Ext.data.Record#create}, or a Record constructor object created using {@link Ext.data.Record#create}.
- */
-Ext.data.XmlReader = function(meta, recordType){
-    meta = meta || {};
-
-    // backwards compat, convert idPath or id / success
-    Ext.applyIf(meta, {
-        idProperty: meta.idProperty || meta.idPath || meta.id,
-        successProperty: meta.successProperty || meta.success
-    });
-
-    Ext.data.XmlReader.superclass.constructor.call(this, meta, recordType || meta.fields);
-};
-Ext.extend(Ext.data.XmlReader, Ext.data.DataReader, {
-    /**
-     * This method is only used by a DataProxy which has retrieved data from a remote server.
-     * @param {Object} response The XHR object which contains the parsed XML document.  The response is expected
-     * to contain a property called <tt>responseXML</tt> which refers to an XML document object.
-     * @return {Object} records A data block which is used by an {@link Ext.data.Store} as
-     * a cache of Ext.data.Records.
-     */
-    read : function(response){
-        var doc = response.responseXML;
-        if(!doc) {
-            throw {message: "XmlReader.read: XML Document not available"};
-        }
-        return this.readRecords(doc);
-    },
-
-    /**
-     * Create a data block containing Ext.data.Records from an XML document.
-     * @param {Object} doc A parsed XML document.
-     * @return {Object} records A data block which is used by an {@link Ext.data.Store} as
-     * a cache of Ext.data.Records.
-     */
-    readRecords : function(doc){
-        /**
-         * After any data loads/reads, the raw XML Document is available for further custom processing.
-         * @type XMLDocument
-         */
-        this.xmlData = doc;
-
-        var root    = doc.documentElement || doc,
-            q       = Ext.DomQuery,
-            totalRecords = 0,
-            success = true;
-
-        if(this.meta.totalProperty){
-            totalRecords = this.getTotal(root, 0);
-        }
-        if(this.meta.successProperty){
-            success = this.getSuccess(root);
-        }
-
-        var records = this.extractData(q.select(this.meta.record, root), true); // <-- true to return Ext.data.Record[]
-
-        // TODO return Ext.data.Response instance.  @see #readResponse
-        return {
-            success : success,
-            records : records,
-            totalRecords : totalRecords || records.length
-        };
-    },
-
-    /**
-     * Decode a json response from server.
-     * @param {String} action [{@link Ext.data.Api#actions} create|read|update|destroy]
-     * @param {Object} response HTTP Response object from browser.
-     * @return {Ext.data.Response} response Returns an instance of {@link Ext.data.Response}
-     */
-    readResponse : function(action, response) {
-        var q   = Ext.DomQuery,
-        doc     = response.responseXML;
-
-        // create general Response instance.
-        var res = new Ext.data.Response({
-            action: action,
-            success : this.getSuccess(doc),
-            message: this.getMessage(doc),
-            data: this.extractData(q.select(this.meta.record, doc) || q.select(this.meta.root, doc), false),
-            raw: doc
-        });
-
-        if (Ext.isEmpty(res.success)) {
-            throw new Ext.data.DataReader.Error('successProperty-response', this.meta.successProperty);
-        }
-
-        // Create actions from a response having status 200 must return pk
-        if (action === Ext.data.Api.actions.create) {
-            var def = Ext.isDefined(res.data);
-            if (def && Ext.isEmpty(res.data)) {
-                throw new Ext.data.JsonReader.Error('root-empty', this.meta.root);
-            }
-            else if (!def) {
-                throw new Ext.data.JsonReader.Error('root-undefined-response', this.meta.root);
-            }
-        }
-        return res;
-    },
-
-    getSuccess : function() {
-        return true;
-    },
-
-    /**
-     * build response-data extractor functions.
-     * @private
-     * @ignore
-     */
-    buildExtractors : function() {
-        if(this.ef){
-            return;
-        }
-        var s       = this.meta,
-            Record  = this.recordType,
-            f       = Record.prototype.fields,
-            fi      = f.items,
-            fl      = f.length;
-
-        if(s.totalProperty) {
-            this.getTotal = this.createAccessor(s.totalProperty);
-        }
-        if(s.successProperty) {
-            this.getSuccess = this.createAccessor(s.successProperty);
-        }
-        if (s.messageProperty) {
-            this.getMessage = this.createAccessor(s.messageProperty);
-        }
-        this.getRoot = function(res) {
-            return (!Ext.isEmpty(res[this.meta.record])) ? res[this.meta.record] : res[this.meta.root];
-        }
-        if (s.idPath || s.idProperty) {
-            var g = this.createAccessor(s.idPath || s.idProperty);
-            this.getId = function(rec) {
-                var id = g(rec) || rec.id;
-                return (id === undefined || id === '') ? null : id;
-            };
-        } else {
-            this.getId = function(){return null;};
-        }
-        var ef = [];
-        for(var i = 0; i < fl; i++){
-            f = fi[i];
-            var map = (f.mapping !== undefined && f.mapping !== null) ? f.mapping : f.name;
-            ef.push(this.createAccessor(map));
-        }
-        this.ef = ef;
-    },
-
-    /**
-     * Creates a function to return some particular key of data from a response.
-     * @param {String} key
-     * @return {Function}
-     * @private
-     * @ignore
-     */
-    createAccessor : function(){
-        var q = Ext.DomQuery;
-        return function(key) {
-            switch(key) {
-                case this.meta.totalProperty:
-                    return function(root, def){
-                        return q.selectNumber(key, root, def);
-                    }
-                    break;
-                case this.meta.successProperty:
-                    return function(root, def) {
-                        var sv = q.selectValue(key, root, true);
-                        var success = sv !== false && sv !== 'false';
-                        return success;
-                    }
-                    break;
-                default:
-                    return function(root, def) {
-                        return q.selectValue(key, root, def);
-                    }
-                    break;
-            }
-        };
-    }(),
-
-    /**
-     * extracts values and type-casts a row of data from server, extracted by #extractData
-     * @param {Hash} data
-     * @param {Ext.data.Field[]} items
-     * @param {Number} len
-     * @private
-     * @ignore
-     */
-    extractValues : function(data, items, len) {
-        var f, values = {};
-        for(var j = 0; j < len; j++){
-            f = items[j];
-            var v = this.ef[j](data);
-            values[f.name] = f.convert((v !== undefined) ? v : f.defaultValue, data);
-        }
-        return values;
-    }
-});/**\r
- * @class Ext.data.XmlStore\r
- * @extends Ext.data.Store\r
- * <p>Small helper class to make creating {@link Ext.data.Store}s from XML data easier.\r
- * A XmlStore will be automatically configured with a {@link Ext.data.XmlReader}.</p>\r
- * <p>A store configuration would be something like:<pre><code>\r
-var store = new Ext.data.XmlStore({\r
-    // store configs\r
-    autoDestroy: true,\r
-    storeId: 'myStore',\r
-    url: 'sheldon.xml', // automatically configures a HttpProxy\r
-    // reader configs\r
-    record: 'Item', // records will have an "Item" tag\r
-    idPath: 'ASIN',\r
-    totalRecords: '@TotalResults'\r
-    fields: [\r
-        // set up the fields mapping into the xml doc\r
-        // The first needs mapping, the others are very basic\r
-        {name: 'Author', mapping: 'ItemAttributes > Author'},\r
-        'Title', 'Manufacturer', 'ProductGroup'\r
-    ]\r
-});\r
- * </code></pre></p>\r
- * <p>This store is configured to consume a returned object of the form:<pre><code>\r
-&#60?xml version="1.0" encoding="UTF-8"?>\r
-&#60ItemSearchResponse xmlns="http://webservices.amazon.com/AWSECommerceService/2009-05-15">\r
-    &#60Items>\r
-        &#60Request>\r
-            &#60IsValid>True&#60/IsValid>\r
-            &#60ItemSearchRequest>\r
-                &#60Author>Sidney Sheldon&#60/Author>\r
-                &#60SearchIndex>Books&#60/SearchIndex>\r
-            &#60/ItemSearchRequest>\r
-        &#60/Request>\r
-        &#60TotalResults>203&#60/TotalResults>\r
-        &#60TotalPages>21&#60/TotalPages>\r
-        &#60Item>\r
-            &#60ASIN>0446355453&#60/ASIN>\r
-            &#60DetailPageURL>\r
-                http://www.amazon.com/\r
-            &#60/DetailPageURL>\r
-            &#60ItemAttributes>\r
-                &#60Author>Sidney Sheldon&#60/Author>\r
-                &#60Manufacturer>Warner Books&#60/Manufacturer>\r
-                &#60ProductGroup>Book&#60/ProductGroup>\r
-                &#60Title>Master of the Game&#60/Title>\r
-            &#60/ItemAttributes>\r
-        &#60/Item>\r
-    &#60/Items>\r
-&#60/ItemSearchResponse>\r
- * </code></pre>\r
- * An object literal of this form could also be used as the {@link #data} config option.</p>\r
- * <p><b>Note:</b> Although not listed here, this class accepts all of the configuration options of \r
- * <b>{@link Ext.data.XmlReader XmlReader}</b>.</p>\r
- * @constructor\r
- * @param {Object} config\r
- * @xtype xmlstore\r
- */\r
-Ext.data.XmlStore = Ext.extend(Ext.data.Store, {\r
-    /**\r
-     * @cfg {Ext.data.DataReader} reader @hide\r
-     */\r
-    constructor: function(config){\r
-        Ext.data.XmlStore.superclass.constructor.call(this, Ext.apply(config, {\r
-            reader: new Ext.data.XmlReader(config)\r
-        }));\r
-    }\r
-});\r
-Ext.reg('xmlstore', Ext.data.XmlStore);
\ No newline at end of file