InlineValidator

API reference › yii › validators › InlineValidator

class	`yii\validators\InlineValidator`
Extends	`Validator` » `yii\base\Component` » `yii\base\BaseObject`
Implements	`yii\base\Configurable`
Since	2.0
Source	`framework/validators/InlineValidator.php`

InlineValidator represents a validator which is defined as a method in the object being validated.

Properties

Property	Type	Description	Defined by
`$attributeNames` read-only	`array`	Attribute names.	`Validator`
`$attributes`	`array\|string`	Attributes to be validated by this validator. Default: `[]`.	`Validator`
`$behaviors` read-only	`array<yii\base\Behavior<static>>`	List of behaviors attached to this component.	`yii\base\Component`
`$builtInValidators` static	`array`	List of built-in validators (name => class or configuration) Default: ['boolean' => 'yii\validators\BooleanValidator', 'captcha' => 'yii\captcha\CaptchaValidator', 'compare' => 'yii\validators\CompareValidator', 'date' => 'yii\validators\DateValidator', 'datetime' => ['class' => 'yii\validators\DateValidator', 'type' => \yii\validators\DateValidator::TYPE_DATETIME], 'time' => ['class' => 'yii\validators\DateValidator', 'type' => \yii\validators\DateValidator::TYPE_TIME], 'default' => 'yii\validators\DefaultValueValidator', 'double' => 'yii\validators\NumberValidator', 'each' => 'yii\validators\EachValidator', 'email' => 'yii\validators\EmailValidator', 'exist' => 'yii\validators\ExistValidator', 'file' => 'yii\validators\FileValidator', 'filter' => 'yii\validators\FilterValidator', 'image' => 'yii\validators\ImageValidator', 'in' => 'yii\validators\RangeValidator', 'integer' => ['class' => 'yii\validators\NumberValidator', 'integerOnly' => true], 'match' => 'yii\validators\RegularExpressionValidator', 'number' => 'yii\validators\NumberValidator', 'required' => 'yii\validators\RequiredValidator', 'safe' => 'yii\validators\SafeValidator', 'string' => 'yii\validators\StringValidator', 'trim' => ['class' => 'yii\validators\TrimValidator', 'skipOnArray' => true], 'unique' => 'yii\validators\UniqueValidator', 'url' => 'yii\validators\UrlValidator', 'ip' => 'yii\validators\IpValidator'].	`Validator`
`$clientValidate`	`string\|Closure`	An anonymous function or the name of a model class method that returns the client validation code. Default: `null`.	`InlineValidator`
`$current`	`mixed`	The value of attribute being currently validated. Default: `null`. Available since 2.0.36.	`InlineValidator`
`$enableClientValidation`	`bool`	Whether to enable client-side validation for this validator. Default: `true`.	`Validator`
`$except`	`array\|string`	Scenarios that the validator should not be applied to. Default: `[]`.	`Validator`
`$isEmpty`	`callable\|null`	A PHP callable that replaces the default implementation of `isEmpty()`. Default: `null`.	`Validator`
`$message`	`string\|null`	The user-defined error message. Default: `null`.	`Validator`
`$method`	`string\|callable`	An anonymous function or the name of a model class method that will be called to perform the actual validation. Default: `null`.	`InlineValidator`
`$on`	`array\|string`	Scenarios that the validator can be applied to. Default: `[]`.	`Validator`
`$params`	`mixed`	Additional parameters that are passed to the validation method Default: `null`.	`InlineValidator`
`$skipOnEmpty`	`bool`	Whether this validation rule should be skipped if the attribute value is null or an empty string. Default: `true`.	`Validator`
`$skipOnError`	`bool`	Whether this validation rule should be skipped if the attribute being validated already has some validation error according to some previous rules. Default: `true`.	`Validator`
`$validationAttributes` read-only	`array\|null`	List of attribute names.	`Validator`
`$when`	`callable\|null`	A PHP callable whose return value determines whether this validator should be applied. Default: `null`.	`Validator`
`$whenClient`	`string\|null`	A JavaScript function name whose return value determines whether this validator should be applied on the client-side. Default: `null`.	`Validator`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__call()`	Calls the named method which is not a class method.	`yii\base\Component`
`__clone()`	This method is called after the object is created by cloning an existing one.	`yii\base\Component`
`__get()`	Returns the value of a component property.	`yii\base\Component`
`__isset()`	Checks if a property is set, i.e. defined and not null.	`yii\base\Component`
`__set()`	Sets the value of a component property.	`yii\base\Component`
`__unset()`	Sets a component property to be null.	`yii\base\Component`
`addError()`	Adds an error about the specified attribute to the model object.	`Validator`
`attachBehavior()`	Attaches a behavior to this component.	`yii\base\Component`
`attachBehaviors()`	Attaches a list of behaviors to the component.	`yii\base\Component`
`behaviors()`	Returns a list of behaviors that this component should behave as.	`yii\base\Component`
`canGetProperty()`	Returns a value indicating whether a property can be read.	`yii\base\Component`
`canSetProperty()`	Returns a value indicating whether a property can be set.	`yii\base\Component`
`className()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`clientValidateAttribute()`	Returns the JavaScript needed for performing client-side validation.	`InlineValidator`
`createValidator()` static	Creates a validator object.	`Validator`
`detachBehavior()`	Detaches a behavior from the component.	`yii\base\Component`
`detachBehaviors()`	Detaches all behaviors from the component.	`yii\base\Component`
`ensureBehaviors()`	Makes sure that the behaviors declared in `behaviors()` are attached to this component.	`yii\base\Component`
`getAttributeNames()`	Returns cleaned attribute names without the `!` character at the beginning.	`Validator`
`getBehavior()`	Returns the named behavior object.	`yii\base\Component`
`getBehaviors()`	Returns all behaviors attached to this component.	`yii\base\Component`
`getClientOptions()`	Returns the client-side validation options.	`Validator`
`getFormattedClientMessage()`	Returns the formatted validation message for client-side validation.	`Validator`
`getValidationAttributes()`	Returns a list of attributes this validator applies to.	`Validator`
`hasEventHandlers()`	Returns a value indicating whether there is any handler attached to the named event.	`yii\base\Component`
`hasMethod()`	Returns a value indicating whether a method is defined.	`yii\base\Component`
`hasProperty()`	Returns a value indicating whether a property is defined for this component.	`yii\base\Component`
`init()`	Initializes the object.	`Validator`
`isActive()`	Returns a value indicating whether the validator is active for the given scenario and attribute.	`Validator`
`isEmpty()`	Checks if the given value is empty.	`Validator`
`off()`	Detaches an existing event handler from this component.	`yii\base\Component`
`on()`	Attaches an event handler to an event.	`yii\base\Component`
`trigger()`	Triggers an event.	`yii\base\Component`
`validate()`	Validates a given value.	`Validator`
`validateAttribute()`	Validates a single attribute.	`InlineValidator`
`validateAttributes()`	Validates the specified object.	`Validator`
`formatMessage()` protected	Formats a mesage using the I18N, or simple strtr if `\Yii::$app` is not available.	`Validator`
`validateValue()` protected	Validates a value.	`Validator`

Property details

$clientValidate

public string|Closure $clientValidate = null

An anonymous function or the name of a model class method that returns the client validation code.

The signature of the method should be like the following:

function (string $attribute, mixed $params, InlineValidator $validator, mixed $current, View $view): string
{
    // $view->registerJs('JS validation function');
    // or \app\assets\ValidationAsset::register($view);
    return "calling JS validation function";
}

Please refer to clientValidateAttribute() and guide for details on how to return client validation code.

$method

public string|callable $method = null

An anonymous function or the name of a model class method that will be called to perform the actual validation.

The signature of the method should be like the following:

function (string $attribute, mixed $params, InlineValidator $validator, mixed $current): bool {
}

$attribute is the name of the attribute to be validated
$params contains the value of $params that you specify when declaring the inline validation rule
$validator is a reference to related InlineValidator object. This parameter is available since version 2.0.11
$current is the attribute value. This parameter is available since version 2.0.36

Method details

clientValidateAttribute()

public function clientValidateAttribute(mixed $model, mixed $attribute, mixed $view): string|null

Returns the JavaScript needed for performing client-side validation.

Calls getClientOptions() to generate options array for client-side validation.

You may override this method to return the JavaScript validation code if the validator can support client-side validation.

The following JavaScript variables are predefined and can be used in the validation code:

attribute: an object describing the the attribute being validated.
value: the value being validated.
messages: an array used to hold the validation error messages for the attribute.
deferred: an array used to hold deferred objects for asynchronous validation
$form: a jQuery object containing the form element

The attribute object contains the following properties:

id: a unique ID identifying the attribute (e.g. “loginform-username”) in the form
name: attribute name or expression (e.g. “[0]content” for tabular input)
container: the jQuery selector of the container of the input field
input: the jQuery selector of the input field under the context of the form
error: the jQuery selector of the error tag under the context of the container
status: status of the input field, 0: empty, not entered before, 1: validated, 2: pending validation, 3: validating

Parameters

Parameter	Type	Description
`$model`	`mixed`	The data model being validated
`$attribute`	`mixed`	The name of the attribute to be validated.
`$view`	`mixed`	The view object that is going to be used to render views or view files containing a model form with this validator applied.

Returns

string|null: The client-side validation script. Null if the validator does not support client-side validation.

validateAttribute()

public function validateAttribute(mixed $model, mixed $attribute): mixed

Validates a single attribute.

Child classes must implement this method to provide the actual validation logic.

Parameters

Parameter	Type	Description
`$model`	`mixed`	The data model to be validated
`$attribute`	`mixed`	The name of the attribute to be validated.

Returns

mixed