Класс yii\validators\BooleanValidator
| Наследование | yii\validators\BooleanValidator » yii\validators\Validator » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/validators/BooleanValidator.php |
BooleanValidator проверяет, является ли значение атрибута булевым значением.
Возможные булевы значения можно настроить с помощью свойств $trueValue и $falseValue. Сравнение может быть либо $strict, либо нет.
Общедоступные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $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 |
| $falseValue | смешанный тип | Значение, представляющее ложное состояние. | yii\validators\BooleanValidator |
| $isEmpty | вызов функции PHP | Функция PHP, которая заменяет стандартную реализацию isEmpty(). | yii\validators\Validator |
| $message | строка | Определённое пользователем сообщение об ошибке. | yii\validators\Validator |
| $on | массив|строка | Сценарии, для которых валидатор может применяться. | yii\validators\Validator |
| $skipOnEmpty | булево | Пропустить проверку, если значение атрибута равно null или пустой строке. | yii\validators\Validator |
| $skipOnError | булево | Пропустить проверку, если для атрибута уже есть ошибка валидации. | yii\validators\Validator |
| $strict | булево | Строгое сравнение с $trueValue и $falseValue. | yii\validators\BooleanValidator |
| $trueValue | смешанный тип | Значение, представляющее истинное состояние. | yii\validators\BooleanValidator |
| $when | вызов функции PHP | Функция 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\BooleanValidator |
| 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\BooleanValidator |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли какой-либо обработчик, присоединённый к заданному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Component |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство для этого компонента. | yii\base\Component |
| init() | Инициализирует объект. | yii\validators\BooleanValidator |
| 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\BooleanValidator |
Подробное описание свойств
$falseValue общедоступное свойство
Значение, представляющее ложное состояние. По умолчанию '0'.
public mixed $falseValue = '0'
$strict общедоступное свойство
Является ли сравнение со $trueValue и $falseValue строгим. Если это значение true, значение и тип атрибута должны совпадать со значениями $trueValue или $falseValue. По умолчанию false, что означает необходимость совпадения только значений.
public boolean $strict = false
$trueValue общедоступное свойство
Значение, представляющее истинное состояние. По умолчанию '1'.
public mixed $trueValue = '1'
Подробное описание методов
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-booleanvalidator.html
