add extjs 6.0.1 sources

[extjs.git] / extjs / packages / core / src / data / XmlStore.js

/**\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.reader.Xml}.</p>\r
 * <p>A store configuration would be something like:<pre><code>\r
var store = new Ext.data.XmlStore({\r
    // store configs\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 #cfg-data} config option.</p>\r
 * <p><b>Note:</b> This class accepts all of the configuration options of\r
 * <b>{@link Ext.data.reader.Xml XmlReader}</b>.</p>\r
 */\r
Ext.define('Ext.data.XmlStore', {\r
    extend: 'Ext.data.Store',\r
    alias: 'store.xml',\r
\r
    requires: [\r
        'Ext.data.proxy.Ajax',\r
        'Ext.data.reader.Xml',\r
        'Ext.data.writer.Xml'\r
    ],\r
    \r
    constructor: function(config){\r
        config = Ext.apply({\r
            proxy: {\r
                type: 'ajax',\r
                reader: 'xml',\r
                writer: 'xml'\r
            }\r
        }, config);\r
\r
        this.callParent([config]);\r
    }\r
});