#

API Docs for: 3.10.3
Show: Inherited Protected Private Deprecated

# File: datasource/js/datasource-xmlschema.js

    /**
     * Extends DataSource with schema-parsing on XML data.
     *
     * @module datasource
     * @submodule datasource-xmlschema
     */

    /**
     * Adds schema-parsing to the DataSource Utility.
     * @class DataSourceXMLSchema
     * @extends Plugin.Base
     */
    var DataSourceXMLSchema = function() {
        DataSourceXMLSchema.superclass.constructor.apply(this, arguments);
    };

    Y.mix(DataSourceXMLSchema, {
        /**
         * The namespace for the plugin. This will be the property on the host which
         * references the plugin instance.
         *
         * @property NS
         * @type String
         * @static
         * @final
         * @value "schema"
         */
        NS: "schema",

        /**
         * Class name.
         *
         * @property NAME
         * @type String
         * @static
         * @final
         * @value "dataSourceXMLSchema"
         */
        NAME: "dataSourceXMLSchema",

        /////////////////////////////////////////////////////////////////////////////
        //
        // DataSourceXMLSchema Attributes
        //
        /////////////////////////////////////////////////////////////////////////////

        ATTRS: {
            schema: {
                //value: {}
            }
        }
    });

    Y.extend(DataSourceXMLSchema, Y.Plugin.Base, {
        /**
        * Internal init() handler.
        *
        * @method initializer
        * @param config {Object} Config object.
        * @private
        */
        initializer: function(config) {
            this.doBefore("_defDataFn", this._beforeDefDataFn);
        },

        /**
         * Parses raw data into a normalized response.
         *
         * @method _beforeDefDataFn
         * @param tId {Number} Unique transaction ID.
         * @param request {Object} The request.
         * @param callback {Object} The callback object with the following properties:
         *     <dl>
         *         <dt>success (Function)</dt> <dd>Success handler.</dd>
         *         <dt>failure (Function)</dt> <dd>Failure handler.</dd>
         *     </dl>
         * @param data {Object} Raw data.
         * @protected
         */
        _beforeDefDataFn: function(e) {
            var schema = this.get('schema'),
                payload = e.details[0],
                // TODO: Do I need to sniff for DS.IO + responseXML.nodeType 9?
                data = Y.XML.parse(e.data.responseText) || e.data;

            payload.response = Y.DataSchema.XML.apply.call(this, schema, data) || {
                meta: {},
                results: data
            };

            this.get("host").fire("response", payload);

            return new Y.Do.Halt("DataSourceXMLSchema plugin halted _defDataFn");
        }
    });

    Y.namespace('Plugin').DataSourceXMLSchema = DataSourceXMLSchema;