setFormErrors() method

Author: joshstoik1

README.md

@@ -71,6 +71,32 @@ When `fieldName` is passed, the method will return the error corresponding to th
 </div>
 ```
 
+
+### Method: setFormErrors()
+
+This method can be used to set arbitrary form errors. The errors do not necessarily need to correspond to a field, but the form must be a valid `v-form` element.
+
+#### Arguments
+
+| Type | Name | Description |
+| ---- | ---- | ----------- |
+| *string* | formName | The name of the form. |
+| *object* | errors | An object with keys relating to fields or error codes, and values being errors strings. |
+
+#### Returns
+
+This method will update the form errors and return `TRUE`, or `FALSE` if bad arguments were passed.
+
+#### Example
+
+```javascript
+var errors = {
+    fieldOne: 'This is all wrong.',
+    fieldTwo: 'This too is not correct.',
+};
+this.setFormErrors('myForm', errors);
+```
+
 ### Method: formTouched()
 
 This method can be used to determine whether or not a form or a specific field has been "touched".
@@ -130,7 +156,7 @@ Note: `FALSE` is also returned if the form name is invalid or not bound to the `
 </form>
 ```
 
-```js
+```javascript
 submitForm = function() {
     if (!this.validateForm('myForm')) {
         return false;
@@ -154,7 +180,7 @@ If the value is valid, the function should return `TRUE`, otherwise it should re
 <input type="text" data-custom-callback="validateUsername" />
 ```
 
-```js
+```javascript
 validateUsername = function(value) {
     if (this.users.indexOf(value) !== -1) {
         return true;

demo/assets/vue-blob-forms.min.js

@@ -592,6 +592,84 @@
 			return errorKeys.length ? errors : true;
 		};
 
+		/**
+		 * Set Errors
+		 *
+		 * Pass arbitrary errors to a form. These do not necessarily
+		 * have to correspond to fields, but they must correspond to
+		 * a v-form.
+		 *
+		 * @param string $name Form name.
+		 * @param object $errors Errors.
+		 * @return bool True/false.
+		 */
+		Vue.prototype.setFormErrors = function(name, errors) {
+			// Make sure the form is valid.
+			if (!name || (typeof this.blobErrors[name] === 'undefined')) {
+				return false;
+			}
+
+			// This should be a keyed object.
+			if (
+				(typeof errors !== 'object') ||
+				(errors === null) ||
+				Array.isArray(errors)
+			) {
+				return false;
+			}
+
+			var fields = Object.keys(this.blobFields[name]),
+				keys = Object.keys(errors),
+				changed = false;
+
+			// Again, exit if the data is bad.
+			if (!keys.length) {
+				return false;
+			}
+
+			// Loop through everything!
+			for (i=0; i<keys.length; i++) {
+				var key = keys[i],
+					value = errors[keys[i]];
+
+				// Bad error?
+				if (!value || (typeof value !== 'string')) {
+					continue;
+				}
+
+				changed = true;
+
+				// Record the main error.
+				this.blobErrors[name][key] = value;
+
+				// If this is a field, we should also update its
+				// validity details.
+				if (fields.indexOf(key) !== -1) {
+					// Update internal meta.
+					if (this.blobFields[name][key].valid) {
+						Vue.set(this.blobFields[name][key], 'valid', false);
+					}
+					if (this.blobFields[name][key].el.classList.contains('is-valid')) {
+						this.blobFields[name][key].el.classList.remove('is-valid');
+					}
+					if (!this.blobFields[name][key].el.classList.contains('is-invalid')) {
+						this.blobFields[name][key].el.classList.add('is-invalid');
+					}
+
+					// And for good measure, the field's constraint error.
+					this.blobFields[name][key].el.setCustomValidity(value);
+				}
+			}
+
+			// If we made changes, update the form classes.
+			if (changed) {
+				this.$forceUpdate();
+				_updateFormClasses(this.blobForms[name].el);
+			}
+
+			return true;
+		};
+
 		/**
 		 * Gravatar URL
 		 *
@@ -677,6 +755,11 @@
 			// Cast $touch to a boolean.
 			touch = !!touch;
 
+			// Before we start validating, let's reset the error holder
+			// to clear any arbitrary messages a user might have
+			// injected.
+			this.blobErrors[name] = {};
+
 			// Loop through and validate each field.
 			var fieldKeys = Object.keys($scope[name].blobFields[name]);
 			for (i=0; i<fieldKeys.length; i++) {