Class: IsTrueValidator

sogv.IsTrueValidator

Validates that a value is true.

Specifically, this checks if the value is exactly true, exactly the integer 1, or exactly the string "1".

new sogv.IsTrueValidator (data, options, optionRules, lang, internal)

Create a new Validator.

Name Type Description
data * The data which needs to be validated.
options Object The setting options
optionRules Object The validation rules for setting options.
lang String The language used by the application. Default: "en".
internal Boolean If this parameter is true, it means, that validation called from core.
Properties:
Name Type Description
alias Array

The aliases for the current validator.

They could be used in the short validation format.

Defined aliases: ['is-true', 'true'].
options Object The description of the required options.
Example
var validator = new sogv.IsTrueValidator(data);
if (false === validator.isValid()) {
     validator.errors().first();
}

Extends

Members

data * inherited

Data that needs to be validated.

lang String inherited

Language of error messages.

message String

This message is shown if the underlying data is not true.

Default: "This value should be true."

You can use the following parameters in this message:

Parameter Description
%%value%% The current (invalid) value

Methods

errors ()sogv.Error inherited

Return error errors

Returns:
Type Description
sogv.Error Error messages

isValid ()Boolean inherited overrides

Check if data valid.

Returns:
Type Description
Boolean Validation status