Класс ModelValidator
Объект ModelValidator encapsulates все методы, связанные с валидацией данных для модели. Он также предоставляет API для динамического изменения правил валидации для каждого поля модели.
Реализует ArrayAccess для лёгкого изменения правил, как обычно делается с массивом определения Model::$validate
- ModelValidator implements ArrayAccess, IteratorAggregate, Countable
Ссылка: http://book.cakephp.org/2.0/ru/data-validation.html
Авторское право: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT Лицензия
Расположение: Cake/Model/ModelValidator.php
Краткое описание свойств
-
$_behaviorsprotectedСодержит список имён методов поведения, прикреплённых при создании этого объектаarray - Содержит массив объектов CakeValidationSet
$_fieldsprotected -
$_methodsprotectedarrayСодержит доступные пользовательские методы обратного вызова, обычно взятые из методов модели и методов поведения
- Содержит ссылку на модель, к которой прикреплён этот валидатор
$_modelprotected -
$_modelMethodsprotectedСодержит доступные пользовательские методы обратного вызова из моделиarray -
$_validateprotectedarrayСвойство $validate валидаторов, используемое для проверки того, изменились ли правила валидации в модели и необходимо ли их обновить в этом классе
Краткое описание методов
- __construct() publicКонструктор
- _parseRules() protected
Устанавливает объекты CakeValidationSet из свойства
Model::$validateЕслиModel::$validateне задано или пусто, этот метод возвращает false. В противном случае — true. - _triggerBeforeValidate() protectedРаспространяет событие beforeValidate
- _validateWithModels() protected
Выполняет валидацию для ассоциаций hasAndBelongsToMany, у которых установлены ключи 'with' и данные в наборе данных.
- _validationList() protectedОбрабатывает переданный fieldList и возвращает список полей для валидации
- add() public
Добавляет новое правило к набору правил поля. Если второй аргумент является массивом или экземпляром CakeValidationSet, то список правил для поля будет заменён вторым аргументом, а третий аргумент будет проигнорирован.
- count() publicВозвращает количество полей с правилами валидации
- errors() public
Возвращает массив полей, которые не прошли валидацию. Для текущей модели. Этот метод фактически выполнит правила валидации над данными, а не просто вернёт сообщения.
- getField() public
Возвращает объект CakeValidationSet, содержащий все правила валидации для поля. Если параметры не переданы, то возвращает массив со всеми объектами CakeValidationSet для каждого поля.
- getIterator() publicВозвращает итератор для каждого из полей, подлежащих валидации
- getMethods() public
Получает все возможные пользовательские методы из модели и прикреплённых поведений, которые будут использоваться в качестве валидаторов.
- getModel() publicПолучает модель, связанную с этим валидатором
- invalidate() public
Помечает поле как невалидное, необязательно задавая сообщение, объясняющее, почему правило не выполнилось.
- offsetExists() publicВозвращает, определён ли набор правил для поля или нет
- offsetGet() publicВозвращает набор правил для поля
- offsetSet() publicУстанавливает набор правил для поля
- offsetUnset() publicУдаляет набор правил для поля
- remove() publicУдаляет правило из набора по его имени
- setValidationDomain() publicУстанавливает домен I18n для сообщений валидации. Этот метод цепляется.
- validateAssociated() publicВалидирует один рекорд, а также все его непосредственно связанные рекорды.
- validateMany() publicВалидирует несколько отдельных рекордов для одной модели
- validates() public
Возвращает true, если все поля проходят валидацию. Также валидирует ассоциации hasAndBelongsToMany, которые используют ключ 'with'. Поскольку
Model::_saveMultiне может завершить операцию сохранения.
Подробное описание методов
__construct()source public
__construct( Model $Model )
Конструктор
Параметры
-
Model$Model - Ссылка на модель, к которой прикреплён валидатор
_parseRules()source protected
_parseRules( )
Устанавливает объекты CakeValidationSet из свойства Model::$validate Если Model::$validate не задано или пусто, этот метод возвращает false. В противном случае — true.
Возвращает
booleantrue, если
Model::$validate был обработан, иначе false_triggerBeforeValidate()source protected
_triggerBeforeValidate( array $options array() )
Распространяет событие beforeValidate
Параметры
- массив
$optionsнеобязательно массив() - Параметры для передачи в вызов обратного вызова.
Возвращает
booleanВызывает
Model.beforeValidate $model, массив($options)_validateWithModels()source protected
_validateWithModels( array $options )
Выполняет валидацию для ассоциаций hasAndBelongsToMany, у которых установлены ключи 'with' и данные в наборе данных.
Параметры
- массив
$options - Массив параметров для использования при валидации с моделями
Возвращает
booleanОшибка валидации моделей с ключом 'with'
См. также
Model::validates()_validationList()source protected
_validationList( array $fieldList array() )
Обрабатывает переданный fieldList и возвращает список полей для валидации
Параметры
- массив
$fieldListнеобязательно массив() - список полей, которые будут использоваться для валидации
Возвращает
CakeValidationSet[]Список правил валидации, которые будут применены
add()source public
add( string $field , string|array|CakeValidationSet $name , array|CakeValidationRule $rule null )
Добавляет новое правило к набору правил поля. Если второй аргумент является массивом или экземпляром CakeValidationSet, то список правил для поля будет заменён вторым аргументом, а третий аргумент будет проигнорирован.
Пример:
$validator
->add('title', 'required', array('rule' => 'notBlank', 'required' => true))
->add('user_id', 'valid', array('rule' => 'numeric', 'message' => 'Invalid User'))
$validator->add('password', array(
'size' => array('rule' => array('lengthBetween', 8, 20)),
'hasSpecialCharacter' => array('rule' => 'validateSpecialchar', 'message' => 'not valid')
)); Параметры
- строка
$field - Имя поля, к которому добавляется правило
- строка|массив|
CakeValidationSet$name - Имя добавляемого правила или список правил для поля
- массив|
CakeValidationRule$ruleнеобязательно null - или список правил, которые нужно добавить к набору правил поля
Возвращает
ModelValidatorcount()source public
count( )
Возвращает количество полей, имеющих правила валидации
Возвращает
целое числоРеализация
Countable::count() errors()source public
errors( string $options array() )
Возвращает массив полей, которые не прошли валидацию. На текущей модели. Этот метод фактически выполнит правила валидации на данных, а не просто вернёт сообщения.
Параметры
- строка
$optionsнеобязательно массив() - Необязательный массив пользовательских параметров, которые будут доступны в обратном вызове beforeValidate
Возвращает
массивМассив невалидных полей
Вызывает
Model.afterValidate $modelСм. также
ModelValidator::validates()getField()source public
getField( string $name null )
Возвращает объект CakeValidationSet, содержащий все правила валидации для поля. Если параметры не переданы, возвращает массив со всеми объектами CakeValidationSet для каждого поля.
Параметры
- строка
$nameнеобязательно null - [необязательно] Имя поля для извлечения. По умолчанию null.
Возвращает
CakeValidationSet|массив|nullgetIterator()source public
getIterator( )
Возвращает итератор для каждого поля, подлежащего валидации
Возвращает
ArrayIteratorРеализация
IteratorAggregate::getIterator() getMethods()source public
getMethods( )
Получает все возможные пользовательские методы из модели и присоединённых поведений, которые могут быть использованы как валидаторы
Возвращает
массивСписок вызываемых объектов, которые будут использоваться в качестве методов валидации
invalidate()source public
invalidate( string $field , string $message true )
Помечает поле как невалидное, необязательно задавая сообщение, объясняющее, почему правило не выполнилось
Параметры
- строка
$field - Имя поля, которое нужно пометить как невалидное
- строка
$messageнеобязательно true - Сообщение валидации, объясняющее, почему правило не выполнилось, по умолчанию true.
offsetExists()source public
offsetExists( string $field )
Возвращает, определён ли набор правил для поля или нет
Параметры
- строка
$field - имя поля для проверки
Возвращает
логическое значениеРеализация
ArrayAccess::offsetExists() offsetGet()source public
offsetGet( string $field )
Возвращает набор правил для поля
Параметры
- строка
$field - имя поля для проверки
Возвращает
CakeValidationSetРеализация
ArrayAccess::offsetGet() offsetSet()source public
offsetSet( string $field , array|CakeValidationSet $rules )
Устанавливает набор правил для поля
Параметры
- строка
$field - имя поля для установки
- массив|
CakeValidationSet$rules - набор правил для применения к полю
Реализация
ArrayAccess::offsetSet() offsetUnset()source public
offsetUnset( string $field )
Удаляет набор правил для поля
Параметры
- строка
$field - имя поля для удаления
Реализация
ArrayAccess::offsetUnset() remove()source public
remove( string $field , string $rule null )
Удаляет правило из набора по его имени
Пример:
$validator
->remove('title', 'required')
->remove('user_id') Параметры
- строка
$field - Имя поля, из которого будет удалено правило
- строка
$ruleнеобязательно null - имя правила, которое нужно удалить
Возвращает
ModelValidatorsetValidationDomain()source public
setValidationDomain( string $validationDomain null )
Устанавливает домен I18n для сообщений валидации. Этот метод цепной.
Параметры
- строка
$validationDomainнеобязательно null - [необязательно] Домен валидации, который будет использоваться.
Возвращает
ModelValidatorvalidateAssociated()source public
validateAssociated( array $data , array $options array() )
Валидирует одну запись, а также все её непосредственно связанные записи.
Параметры
- массив
$data - Данные записи для валидации. Должен быть массивом, индексированным по имени ассоциации.
- массив
$optionsнеобязательно массив() - Параметры, используемые при валидации данных записи (см. выше). См. также $options в validates().
Возвращает
массив|логическое значениеПри atomic: true при успехе или false при неудаче. В противном случае: массив, аналогичный массиву $data, переданному, но значения установлены в true/false в зависимости от того, успешно ли прошла валидация каждой записи.
validateMany()source public
validateMany( array $data , array $options array() )
Валидирует несколько отдельных записей для одной модели
Параметры
- массив
$data - Данные записей для валидации. Это должен быть массив с числовым индексированием
- массив
$optionsнеобязательно массив() - Параметры, используемые при валидации данных записи (см. выше). См. также $options в validates().
Возвращает
смешанный типПри atomic: true при успехе или false при неудаче. В противном случае: массив, аналогичный переданному массиву $data, но значения установлены в true/false в зависимости от того, успешно ли прошла валидация каждой записи.
validates()source public
validates( array $options array() )
Возвращает true, если все поля проходят валидацию. Также валидирует ассоциации hasAndBelongsToMany, использующие ключ 'with'. Поскольку Model::_saveMulti не может прервать операцию сохранения.
Валидирует текущие установленные данные. Используйте Model::set() или Model::create() для установки активных данных.
Параметры
- массив
$optionsнеобязательно массив() - Необязательный массив с пользовательскими параметрами, которые будут доступны в обратном вызове beforeValidate
Возвращает
booleanTrue, если нет ошибок
Подробное описание свойств
$_behaviorssource
protected массив
Хранит список имен методов, которые были подключены при создании этого объекта
array()
$_methodssource
protected массив
Хранит доступные пользовательские методы обратного вызова, обычно взятые из методов модели и методов поведения
array()
$_modelMethodssource
protected массив
Хранит доступные пользовательские методы обратного вызова из модели
array()
$_validatesource
protected массив
Свойство $validate валидатора, используемое для проверки, изменились ли правила валидации в модели, и необходимо ли обновить этот класс
array()
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/2.9/class-ModelValidator.html