Класс yii\validators\RequiredValidator

Все классы | Свойства | Методы

Наследование	yii\validators\RequiredValidator » yii\validators\Validator » yii\base\Component » yii\base\Object
Реализует	yii\base\Configurable
Доступно с версии	2.0
Исходный код	https://github.com/yiisoft/yii2/blob/master/framework/validators/RequiredValidator.php

RequiredValidator проверяет, что указанный атрибут не имеет значения null или пустого значения.

Публичные свойства

Свойство	Тип	Описание	Определено в
$attributeNames	массив	Имена атрибутов.	yii\validators\Validator
$attributes	массив\|строка	Атрибуты, которые должны быть проверены этим валидатором.	yii\validators\Validator
$behaviors	yii\base\Behavior[]	Список поведений, прикрепленных к этому компоненту	yii\base\Component
$builtInValidators	массив	Список встроенных валидаторов (имя => класс или конфигурация)	yii\validators\Validator
$enableClientValidation	булево	Включить проверку на стороне клиента для этого валидатора.	yii\validators\Validator
$except	массив\|строка	Сценарии, для которых валидатор не должен применяться.	yii\validators\Validator
$isEmpty	вызываемый элемент	PHP вызываемый элемент, заменяющий стандартную реализацию isEmpty().	yii\validators\Validator
$message	строка	Пользовательское сообщение об ошибке.	yii\validators\RequiredValidator
$on	массив\|строка	Сценарии, для которых валидатор может применяться.	yii\validators\Validator
$requiredValue	смешанный тип	Требуемое значение, которое должен иметь атрибут.	yii\validators\RequiredValidator
$skipOnEmpty	булево	Пропустить валидатор, если значение, которое проверяется, пустое.	yii\validators\RequiredValidator
$skipOnError	булево	Пропустить данную проверку, если у атрибута уже есть ошибка валидации согласно предыдущим правилам.	yii\validators\Validator
$strict	булево	Является ли сравнение значения атрибута и $requiredValue строгое.	yii\validators\RequiredValidator
$when	вызываемый элемент	PHP вызываемый элемент, значение которого определяет, должен ли применяться этот валидатор.	yii\validators\Validator
$whenClient	строка	Имя JavaScript функции, значение которой определяет, должен ли применяться этот валидатор на стороне клиента.	yii\validators\Validator

Публичные методы

Метод	Описание	Определено в
__call()	Вызывает именованный метод, который не является методом класса.	yii\base\Component
__clone()	Этот метод вызывается после создания объекта путем клонирования существующего.	yii\base\Component
__construct()	Конструктор.	yii\base\Object
__get()	Возвращает значение свойства компонента.	yii\base\Component
__isset()	Проверяет, установлено ли свойство, т. е. определено и не равно null.	yii\base\Component
__set()	Устанавливает значение свойства компонента.	yii\base\Component
__unset()	Устанавливает свойство компонента в значение null.	yii\base\Component
addError()	Добавляет ошибку об указанном атрибуте в объект модели.	yii\validators\Validator
attachBehavior()	Прикрепляет поведение к данному компоненту.	yii\base\Component
attachBehaviors()	Прикрепляет список поведений к компоненту.	yii\base\Component
behaviors()	Возвращает список поведений, по которым должен вести себя данный компонент.	yii\base\Component
canGetProperty()	Возвращает значение, указывающее, можно ли прочитать свойство.	yii\base\Component
canSetProperty()	Возвращает значение, указывающее, можно ли установить свойство.	yii\base\Component
className()	Возвращает полное квалифицированное имя этого класса.	yii\base\Object
clientValidateAttribute()	Возвращает JavaScript, необходимый для выполнения проверки на стороне клиента.	yii\validators\RequiredValidator
createValidator()	Создает объект валидатора.	yii\validators\Validator
detachBehavior()	Отсоединяет поведение от компонента.	yii\base\Component
detachBehaviors()	Отсоединяет все поведения от компонента.	yii\base\Component
ensureBehaviors()	Убеждается, что поведения, объявленные в behaviors(), прикреплены к этому компоненту.	yii\base\Component
getAttributeNames()	Возвращает очищенные имена атрибутов без символа `!` в начале	yii\validators\Validator
getBehavior()	Возвращает объект именованного поведения.	yii\base\Component
getBehaviors()	Возвращает все прикрепленные к этому компоненту поведения.	yii\base\Component
getClientOptions()	Возвращает параметры проверки на стороне клиента.	yii\validators\RequiredValidator
hasEventHandlers()	Возвращает значение, указывающее, есть ли какой-либо обработчик, прикрепленный к указанному событию.	yii\base\Component
hasMethod()	Возвращает значение, указывающее, определен ли метод.	yii\base\Component
hasProperty()	Возвращает значение, указывающее, определено ли свойство для этого компонента.	yii\base\Component
init()	Инициализирует объект.	yii\validators\RequiredValidator
isActive()	Возвращает значение, указывающее, активен ли валидатор для данного сценария и атрибута.	yii\validators\Validator
isEmpty()	Проверяет, пусто ли заданное значение.	yii\validators\Validator
off()	Отсоединяет существующий обработчик событий от этого компонента.	yii\base\Component
on()	Прикрепляет обработчик событий к событию.	yii\base\Component
trigger()	Вызывает событие.	yii\base\Component
validate()	Проверяет заданное значение.	yii\validators\Validator
validateAttribute()	Проверяет отдельный атрибут.	yii\validators\Validator
validateAttributes()	Проверяет указанный объект.	yii\validators\Validator

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

Метод	Описание	Определено в
formatMessage()	Форматирует сообщение, используя I18N, или простой strtr, если `\Yii::$app` недоступен.	yii\validators\Validator
validateValue()	Проверяет значение.	yii\validators\RequiredValidator

Подробности свойств

$message публичное свойство

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

{attribute}: метка проверяемого атрибута
{value}: значение проверяемого атрибута
{requiredValue}: значение $requiredValue

public string $message = null

$requiredValue публичное свойство

Желаемое значение, которое должен иметь атрибут. Если это null, валидатор проверит, что указанный атрибут не пуст. Если это задано как ненулевое значение, валидатор проверит, что значение атрибута совпадает со значением этого свойства. По умолчанию равно null.

См. также $strict.

public mixed $requiredValue = null

$skipOnEmpty публичное свойство

Следует ли пропустить этот валидатор, если проверяемое значение пусто.

public boolean $skipOnEmpty = false

$strict публичное свойство

Является ли сравнение между значением атрибута и $requiredValue строгим. Когда это true, должны совпадать как значения, так и типы. По умолчанию false, означающее, что должны совпадать только значения. Обратите внимание, что когда $requiredValue равно null, если это свойство true, валидатор проверит, является ли значение атрибута null; если это свойство false, валидатор вызовет isEmpty() для проверки, является ли значение атрибута пустым.

public boolean $strict = false

Подробности методов

clientValidateAttribute() public method

Возвращает JavaScript, необходимый для выполнения проверки на стороне клиента.

Вызывает getClientOptions() для генерации массива параметров для проверки на стороне клиента.

Вы можете переопределить этот метод, чтобы вернуть код проверки JavaScript, если валидатор поддерживает проверку на стороне клиента.

В коде проверки предварительно определены следующие переменные JavaScript:

attribute: объект, описывающий атрибут, который проверяется.
value: значение, которое проверяется.
messages: массив, используемый для хранения сообщений об ошибках проверки для атрибута.
deferred: массив, используемый для хранения отложенных объектов для асинхронной проверки
$form: объект jQuery, содержащий элемент формы

Объект attribute содержит следующие свойства:

id: уникальный идентификатор атрибута (например, "loginform-username") в форме
name: имя атрибута или выражение (например, "[0]content" для табличных данных)
container: селектор jQuery контейнера поля ввода
input: селектор jQuery поля ввода в контексте формы
error: селектор jQuery тега ошибки в контексте контейнера
status: состояние поля ввода, 0: пустое, не введено ранее, 1: проверка пройдена, 2: ожидается проверка, 3: проверка в процессе

public string\|null clientValidateAttribute ( $model, $attribute, $view )
$model	yii\base\Model	Модель данных, которая проверяется
$attribute	string	Имя атрибута, который нужно проверить.
$view	yii\web\View	Объект представления, который будет использоваться для рендеринга представлений или файлов представления, содержащих форму модели с применённым этим валидатором.
return	string\|null	Скрипт проверки на стороне клиента. Null, если валидатор не поддерживает проверку на стороне клиента.

getClientOptions() public method

Возвращает параметры проверки на стороне клиента.

Этот метод обычно вызывается из clientValidateAttribute(). Вы можете переопределить этот метод, чтобы изменить параметры, которые будут переданы в проверку на стороне клиента.

public array getClientOptions ( $model, $attribute )
$model	yii\base\Model	Модель, которая проверяется
$attribute	string	Имя атрибута, который проверяется
return	array	Параметры проверки на стороне клиента

init() public method

Инициализирует объект.

Этот метод вызывается в конце конструктора после инициализации объекта заданными параметрами конфигурации.

public void init ( )

validateValue() protected method

Проверяет значение.

Класс валидатора может реализовать этот метод для поддержки проверки данных вне контекста модели данных.

protected array\|null validateValue ( $value )
$value	mixed	Значение данных, которое нужно проверить.
return	array\|null	Сообщение об ошибке и параметры, которые нужно вставить в сообщение об ошибке. Null должен быть возвращён, если данные валидны.
throws	yii\base\NotSupportedException	если валидатор не поддерживает проверку данных без модели

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-validators-requiredvalidator.html