You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

402 lines
13 KiB

12 years ago
/**
* Yii form widget.
*
* This is the JavaScript widget used by the yii\widgets\ActiveForm widget.
*
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license http://www.yiiframework.com/license/
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/
(function ($) {
$.fn.yiiActiveForm = function (method) {
if (methods[method]) {
return methods[method].apply(this, Array.prototype.slice.call(arguments, 1));
} else if (typeof method === 'object' || !method) {
return methods.init.apply(this, arguments);
} else {
$.error('Method ' + method + ' does not exist on jQuery.yiiActiveForm');
return false;
}
};
var defaults = {
12 years ago
// the jQuery selector for the error summary
errorSummary: undefined,
12 years ago
// whether to perform validation before submitting the form.
validateOnSubmit: true,
// the container CSS class representing the corresponding attribute has validation error
errorCssClass: 'error',
// the container CSS class representing the corresponding attribute passes validation
successCssClass: 'success',
// the container CSS class representing the corresponding attribute is being validated
validatingCssClass: 'validating',
12 years ago
// the URL for performing AJAX-based validation. If not set, it will use the the form's action
validationUrl: undefined,
// a callback that is called before submitting the form. The signature of the callback should be:
// function ($form) { ...return false to cancel submission...}
beforeSubmit: undefined,
// a callback that is called before validating each attribute. The signature of the callback should be:
// function ($form, attribute, messages) { ...return false to cancel the validation...}
12 years ago
beforeValidate: undefined,
// a callback that is called after an attribute is validated. The signature of the callback should be:
// function ($form, attribute, messages)
afterValidate: undefined,
12 years ago
// the GET parameter name indicating an AJAX-based validation
ajaxVar: 'ajax'
12 years ago
};
12 years ago
var attributeDefaults = {
// attribute name or expression (e.g. "[0]content" for tabular input)
name: undefined,
// the jQuery selector of the container of the input field
container: undefined,
// the jQuery selector of the input field
input: undefined,
// the jQuery selector of the error tag
error: undefined,
// whether to perform validation when a change is detected on the input
validateOnChange: false,
// whether to perform validation when the user is typing.
validateOnType: false,
12 years ago
// number of milliseconds that the validation should be delayed when a user is typing in the input field.
validationDelay: 200,
// whether to enable AJAX-based validation.
enableAjaxValidation: false,
// function (attribute, value, messages), the client-side validation function.
validate: undefined,
// status of the input field, 0: empty, not entered before, 1: validated, 2: pending validation, 3: validating
status: 0,
// the value of the input
value: undefined
};
12 years ago
var methods = {
init: function (attributes, options) {
return this.each(function () {
var $form = $(this);
if ($form.data('yiiActiveForm')) {
return;
}
12 years ago
var settings = $.extend({}, defaults, options || {});
12 years ago
if (settings.validationUrl === undefined) {
settings.validationUrl = $form.prop('action');
12 years ago
}
$.each(attributes, function (i) {
attributes[i] = $.extend({value: getValue($form, this)}, attributeDefaults, this);
12 years ago
});
$form.data('yiiActiveForm', {
settings: settings,
12 years ago
attributes: attributes,
12 years ago
submitting: false,
validated: false
12 years ago
});
12 years ago
watchAttributes($form, attributes);
12 years ago
12 years ago
/**
12 years ago
* Clean up error status when the form is reset.
* Note that $form.on('reset', ...) does work because the "reset" event does not bubble on IE.
12 years ago
*/
12 years ago
$form.bind('reset.yiiActiveForm', methods.resetForm);
12 years ago
if (settings.validateOnSubmit) {
12 years ago
$form.on('mouseup.yiiActiveForm keyup.yiiActiveForm', ':submit', function () {
12 years ago
$form.data('yiiActiveForm').submitObject = $(this);
12 years ago
});
12 years ago
$form.on('submit', methods.submitForm);
12 years ago
}
});
},
destroy: function () {
return this.each(function () {
$(window).unbind('.yiiActiveForm');
$(this).removeData('yiiActiveForm');
});
12 years ago
},
data: function() {
return this.data('yiiActiveForm');
},
12 years ago
submitForm: function () {
var $form = $(this),
12 years ago
data = $form.data('yiiActiveForm');
if (data.validated) {
// continue submitting the form since validation passes
data.validated = false;
return true;
}
if (data.settings.timer !== undefined) {
clearTimeout(data.settings.timer);
}
data.submitting = true;
if (!data.settings.beforeSubmit || data.settings.beforeSubmit($form)) {
12 years ago
validate($form, function (messages) {
var errors = [];
12 years ago
$.each(data.attributes, function () {
if (updateInput($form, this, messages)) {
errors.push(this.input);
}
12 years ago
});
updateSummary($form, messages);
if (errors.length) {
var top = $form.find(errors.join(',')).first().offset().top;
var wtop = $(window).scrollTop();
if (top < wtop || top > wtop + $(window).height) {
$(window).scrollTop(top);
}
} else {
data.validated = true;
var $button = data.submitObject || $form.find(':submit:first');
// TODO: if the submission is caused by "change" event, it will not work
if ($button.length) {
$button.click();
} else {
// no submit button in the form
$form.submit();
12 years ago
}
return;
12 years ago
}
data.submitting = false;
}, function () {
data.submitting = false;
});
} else {
data.submitting = false;
}
return false;
},
resetForm: function () {
var $form = $(this);
12 years ago
var data = $form.data('yiiActiveForm');
// Because we bind directly to a form reset event instead of a reset button (that may not exist),
// when this function is executed form input values have not been reset yet.
// Therefore we do the actual reset work through setTimeout.
setTimeout(function () {
$.each(data.attributes, function () {
// Without setTimeout() we would get the input values that are not reset yet.
this.value = getValue($form, this);
this.status = 0;
var $container = $form.find(this.container);
$container.removeClass(
data.settings.validatingCssClass + ' ' +
data.settings.errorCssClass + ' ' +
data.settings.successCssClass
);
$container.find(this.error).html('');
});
$form.find(data.settings.summary).hide().find('ul').html('');
}, 1);
12 years ago
}
};
12 years ago
var watchAttributes = function ($form, attributes) {
12 years ago
$.each(attributes, function (i, attribute) {
12 years ago
var $input = findInput($form, attribute);
if (attribute.validateOnChange) {
12 years ago
$input.on('change.yiiActiveForm', function () {
validateAttribute($form, attribute, false);
}).on('blur.yiiActiveForm', function () {
if (attribute.status == 0 || attribute.status == 1) {
validateAttribute($form, attribute, !attribute.status);
12 years ago
}
});
12 years ago
}
12 years ago
if (attribute.validateOnType) {
12 years ago
$input.on('keyup.yiiActiveForm', function () {
if (attribute.value !== getValue($form, attribute)) {
validateAttribute($form, attribute, false);
12 years ago
}
});
}
});
};
12 years ago
var validateAttribute = function ($form, attribute, forceValidate) {
var data = $form.data('yiiActiveForm');
if (forceValidate) {
attribute.status = 2;
}
$.each(data.attributes, function () {
if (this.value !== getValue($form, this)) {
this.status = 2;
forceValidate = true;
}
});
if (!forceValidate) {
return;
}
if (data.settings.timer !== undefined) {
clearTimeout(data.settings.timer);
}
data.settings.timer = setTimeout(function () {
if (data.submitting || $form.is(':hidden')) {
return;
}
$.each(data.attributes, function () {
if (this.status === 2) {
this.status = 3;
$form.find(this.container).addClass(data.settings.validatingCssClass);
}
});
validate($form, function (messages) {
var hasError = false;
12 years ago
$.each(data.attributes, function () {
if (this.status === 2 || this.status === 3) {
hasError = updateInput($form, this, messages) || hasError;
12 years ago
}
});
});
12 years ago
}, data.settings.validationDelay);
};
12 years ago
/**
12 years ago
* Performs validation.
* @param $form jQuery the jquery representation of the form
* @param successCallback function the function to be invoked if the validation completes
* @param errorCallback function the function to be invoked if the ajax validation request fails
12 years ago
*/
12 years ago
var validate = function ($form, successCallback, errorCallback) {
12 years ago
var data = $form.data('yiiActiveForm'),
12 years ago
needAjaxValidation = false,
messages = {};
12 years ago
$.each(data.attributes, function () {
12 years ago
if (data.submitting || this.status === 2 || this.status === 3) {
var msg = [];
if (!data.settings.beforeValidate || data.settings.beforeValidate($form, this, msg)) {
if (this.validate) {
this.validate(this, getValue($form, this), msg);
}
12 years ago
if (msg.length) {
messages[this.name] = msg;
} else if (this.enableAjaxValidation) {
needAjaxValidation = true;
12 years ago
}
}
12 years ago
}
});
12 years ago
if (needAjaxValidation && (!data.submitting || $.isEmptyObject(messages))) {
12 years ago
// Perform ajax validation when at least one input needs it.
// If the validation is triggered by form submission, ajax validation
// should be done only when all inputs pass client validation
12 years ago
var $button = data.submitObject,
extData = '&' + data.settings.ajaxVar + '=' + $form.prop('id');
if ($button && $button.length && $button.prop('name')) {
extData += '&' + $button.prop('name') + '=' + $button.prop('value');
12 years ago
}
12 years ago
$.ajax({
url: data.settings.validationUrl,
type: $form.prop('method'),
12 years ago
data: $form.serialize() + extData,
dataType: 'json',
success: function (msgs) {
if (msgs !== null && typeof msgs === 'object') {
$.each(data.attributes, function () {
if (!this.enableAjaxValidation) {
delete msgs[this.name];
}
});
successCallback($.extend({}, messages, msgs));
} else {
successCallback(messages);
12 years ago
}
12 years ago
},
error: errorCallback
12 years ago
});
12 years ago
} else if (data.submitting) {
// delay callback so that the form can be submitted without problem
setTimeout(function () {
successCallback(messages);
}, 200);
12 years ago
} else {
12 years ago
successCallback(messages);
12 years ago
}
12 years ago
};
/**
12 years ago
* Updates the error message and the input container for a particular attribute.
* @param $form the form jQuery object
12 years ago
* @param attribute object the configuration for a particular attribute.
* @param messages array the validation error messages
12 years ago
* @return boolean whether there is a validation error for the specified attribute
*/
12 years ago
var updateInput = function ($form, attribute, messages) {
var data = $form.data('yiiActiveForm'),
$input = findInput($form, attribute),
hasError = false;
12 years ago
if (data.settings.afterValidate) {
data.settings.afterValidate($form, attribute, messages);
}
12 years ago
attribute.status = 1;
if ($input.length) {
12 years ago
hasError = messages && $.isArray(messages[attribute.name]) && messages[attribute.name].length;
12 years ago
var $container = $form.find(attribute.container);
12 years ago
var $error = $container.find(attribute.error);
12 years ago
if (hasError) {
12 years ago
$error.html(messages[attribute.name][0]);
$container.removeClass(data.settings.validatingCssClass + ' ' + data.settings.successCssClass)
.addClass(data.settings.errorCssClass);
} else {
$error.html('');
$container.removeClass(data.settings.validatingCssClass + ' ' + data.settings.errorCssClass + ' ')
.addClass(data.settings.successCssClass);
12 years ago
}
12 years ago
attribute.value = getValue($form, attribute);
12 years ago
}
return hasError;
};
12 years ago
/**
* Updates the error summary.
* @param $form the form jQuery object
* @param messages array the validation error messages
*/
12 years ago
var updateSummary = function ($form, messages) {
var data = $form.data('yiiActiveForm'),
12 years ago
$summary = $form.find(data.settings.errorSummary),
12 years ago
content = '';
12 years ago
if ($summary.length && messages) {
$.each(data.attributes, function () {
12 years ago
if ($.isArray(messages[this.name]) && messages[this.name].length) {
content += '<li>' + messages[this.name][0] + '</li>';
12 years ago
}
});
12 years ago
$summary.toggle(content !== '').find('ul').html(content);
12 years ago
}
12 years ago
};
12 years ago
var getValue = function ($form, attribute) {
var $input = findInput($form, attribute);
var type = $input.prop('type');
12 years ago
if (type === 'checkbox' || type === 'radio') {
return $input.filter(':checked').val();
} else {
return $input.val();
}
};
var findInput = function ($form, attribute) {
var $input = $form.find(attribute.input);
if ($input.length && $input[0].tagName.toLowerCase() === 'div') {
// checkbox list or radio list
return $input.find('input');
} else {
return $input;
}
};
})(window.jQuery);