Класс yii\validators\Validator

Validator — базовый класс для всех валидаторов.

Подклассы должны переопределять методы validateValue() и/или validateAttribute(), чтобы реализовать логику валидации данных. Подклассы также могут переопределять метод clientValidateAttribute() для поддержки валидации на стороне клиента.

Validator объявляет набор встроенных валидаторов, которые можно использовать с короткими именами. Они перечислены ниже:

• boolean: yii\validators\BooleanValidator
• captcha: yii\captcha\CaptchaValidator
• compare: yii\validators\CompareValidator
• date: yii\validators\DateValidator
• datetime: yii\validators\DateValidator
• time: yii\validators\DateValidator
• 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: yii\validators\NumberValidator
• match: yii\validators\RegularExpressionValidator
• required: yii\validators\RequiredValidator
• safe: yii\validators\SafeValidator
• string: yii\validators\StringValidator
• trim: yii\validators\FilterValidator
• unique: yii\validators\UniqueValidator
• url: yii\validators\UrlValidator
• ip: yii\validators\IpValidator

Для получения более подробной информации и руководства по использованию Validator, см. статью в руководстве по валидаторам.

Общедоступные свойства

Общедоступные методы

Защищённые методы

Подробное описание свойств

$attributeNames общедоступное только для чтения свойство

Имена атрибутов.

public array getAttributeNames ( )

$attributes общедоступное свойство

Атрибуты, которые должны быть проверены этим валидатором. Для нескольких атрибутов укажите их в виде массива; для одного атрибута можно использовать строку или массив.

public array|string $attributes = []

$builtInValidators общедоступное статическое свойство

Список встроенных валидаторов (имя => класс или конфигурация)

public static array $builtInValidators = ['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\FilterValidator', 'filter' => 'trim', 'skipOnArray' => true], 'unique' => 'yii\validators\UniqueValidator', 'url' => 'yii\validators\UrlValidator', 'ip' => 'yii\validators\IpValidator']

$enableClientValidation общедоступное свойство

Включить проверку на стороне клиента для этого валидатора. Фактическая проверка на стороне клиента выполняется с помощью JavaScript-кода, возвращаемого clientValidateAttribute(). Если этот метод возвращает null, даже если это свойство имеет значение true, проверка на стороне клиента этим валидатором не будет выполнена.

public boolean $enableClientValidation = true

$except общедоступное свойство

Сценарии, для которых валидатор не должен применяться. Для нескольких сценариев укажите их в виде массива; для одного сценария можно использовать строку или массив.

public array|string $except = []

$isEmpty общедоступное свойство

Вызываемый PHP-код, заменяющий стандартную реализацию isEmpty(). Если не задано, isEmpty() будет использоваться для проверки, пустое ли значение. Подпись вызываемого кода должна быть function ($value) которая возвращает boolean, показывающий, пустое ли значение.

public callable $isEmpty = null

$message общедоступное свойство

Определённое пользователем сообщение об ошибке. Оно может содержать следующие заполнитель которые будут заменены валидатором:

• {attribute}: метка атрибута, проверяемого валидатором
• {value}: значение проверяемого атрибута

Обратите внимание, что некоторые валидаторы могут вводить другие свойства для сообщений об ошибках, используемых, когда не выполняются определённые условия проверки. Обратитесь к документации API отдельного класса для получения подробностей о этих свойствах. По соглашению, это свойство представляет основное сообщение об ошибке, используемое, когда не выполняется самое важное условие проверки.

public string $message = null

$on public property

Сценарии, к которым может быть применён валидатор. Для нескольких сценариев укажите массив; для одного сценария можно использовать строку или массив.

public array|string $on = []

$skipOnEmpty public property

Нужно ли пропустить эту валидационную правило, если значение атрибута равно null или пустой строке.

public boolean $skipOnEmpty = true

$skipOnError public property

Нужно ли пропустить это правило валидации, если у атрибута, который проверяется, уже есть ошибка валидации в соответствии с предыдущими правилами. По умолчанию значение true.

public boolean $skipOnError = true

$when public property

PHP-вызов, значение возвращаемого которого определяет, нужно ли применять этот валидатор. Подпись вызова должна быть function ($model, $attribute), где $model и $attribute относятся к модели и атрибуту, которые в данный момент проверяются. Вызов должен возвращать значение boolean.

Этот параметр в основном предназначен для поддержки условной валидации на стороне сервера. Если этот параметр не задан, этот валидатор всегда будет применяться на стороне сервера.

Следующий пример включит валидатор только тогда, когда выбранная страна — США:

function ($model) {
    return $model->country == Country::USA;
}

См. также $whenClient.

public callable $when = null

$whenClient public property

Имя JavaScript-функции, возвращаемое значение которой определяет, нужно ли применять этот валидатор на стороне клиента. Подпись функции должна быть function (attribute, value), где attribute — объект, описывающий атрибут, который проверяется (см. clientValidateAttribute()), а value — текущее значение атрибута.

Этот параметр в основном предназначен для поддержки условной валидации на стороне клиента. Если этот параметр не задан, этот валидатор всегда будет применяться на стороне клиента.

Следующий пример включит валидатор только тогда, когда выбранная страна — США:

function (attribute, value) {
    return $('#country').val() === 'USA';
}

См. также $when.

public string $whenClient = null

Method Details