add extjs 6.0.1 sources

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

/**\r
 * Wraps a collection of validation error responses and provides convenient functions for\r
 * accessing and errors for specific fields.\r
 *\r
 * Usually this class does not need to be instantiated directly - instances are instead\r
 * created automatically when {@link Ext.data.Model#validate validate} on a model instance:\r
 *\r
 *      // Validate some existing model instance - in this case it returned 2 failures\r
 *      // messages\r
 *      \r
 *      var errors = myModel.validate();\r
 *      errors.isValid(); //false\r
 *      \r
 *      errors.length; //2\r
 *      errors.getByField('name');  // [{field: 'name',  message: 'must be present'}]\r
 *      errors.getByField('title'); // [{field: 'title', message: 'is too short'}]\r
 *\r
 * @deprecated 5.0 Use `Ext.data.Validation` instead.\r
 */\r
Ext.define('Ext.data.ErrorCollection', {\r
    extend: 'Ext.util.MixedCollection', // not Ext.util.Collection due to API differences\r
\r
    alternateClassName: 'Ext.data.Errors',\r
\r
    requires: [\r
        'Ext.data.Error'\r
    ],\r
\r
    init: function (record) {\r
        var me = this,\r
            fields = record.fields,\r
            data = record.data,\r
            before, field, item, i, len, msg, val, name;\r
\r
        for (i = 0, len = fields.length; i < len; ++i) {\r
            field = fields[i];\r
            name = field.name;\r
            val = data[name];\r
\r
            if (field.validate && !field.validate.$nullFn) {\r
                before = me.length;\r
                msg = field.validate(val, null, me, record);\r
                if (before === me.length && msg !== true) {\r
                    me.add(name, msg);\r
                }\r
            }\r
        }\r
\r
        return me;\r
    },\r
\r
    add: function (key, value) {\r
        var me = this,\r
            defaultMessage = Ext.data.field.Field.defaultInvalidMessage,\r
            obj = key, // for single argument form\r
            current;\r
\r
        if (Ext.isString(key)) {\r
            obj = new Ext.data.Error({\r
                field: key,\r
                message: value || defaultMessage\r
            });\r
        } else {\r
            if (!(obj.isError)) {\r
                obj = new Ext.data.Error({\r
                    field: obj.field || obj.name,\r
                    message: obj.error || obj.message || obj.msg || defaultMessage\r
                });\r
            }\r
\r
            key = obj.field;\r
        }\r
\r
        current = me.get(key);\r
        if (current) {\r
            if (Ext.isArray(current)) {\r
                current.push(obj);\r
                return current;\r
            }\r
\r
            me.removeAtKey(key);\r
            obj = [ current, obj ];\r
            obj.field = key;\r
\r
            // Because the value we want in the collection is an array, we need to wrap it\r
            // another layer of array or the base add method will add each element.\r
            obj = [ obj ];\r
        }\r
\r
        return me.callParent([ obj ]);\r
    },\r
\r
    getKey: function (item) {\r
        return item.field;\r
    },\r
\r
    /**\r
     * Returns true if there are no errors in the collection\r
     * @return {Boolean}\r
     */\r
    isValid: function() {\r
        return this.length === 0;\r
    },\r
\r
    /**\r
     * Returns all of the errors for the given field\r
     * @param {String} fieldName The field to get errors for\r
     * @return {Object[]} All errors for the given field\r
     */\r
    getByField: function(fieldName) {\r
        var values = this.get(fieldName);\r
\r
        if (values && !Ext.isArray(values)) {\r
            values = [values];\r
        }\r
\r
        return values || [];\r
    }\r
});\r