Класс ModelValidator
Объект ModelValidator объединяет все методы, связанные с проверкой данных для модели. Он также предоставляет API для динамического изменения правил проверки для каждого поля модели.
Реализует ArrayAccess для удобной модификации правил, как обычно делается с массивом определения Model::$validate.
- ModelValidator реализует ArrayAccess, IteratorAggregate, Countable
Ссылка: https://book.cakephp.org/2.0/ru/data-validation.html
Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: MIT License
Расположение: 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 - Массив параметров для использования при проверке с моделями 'with'
Возвращаемое значение
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 - $data Данные записи для проверки. Это должен быть массив, индексированный именем ассоциации.
- массив
$optionsнеобязательно массив() - Параметры для использования при проверке данных записи (см. выше). См. также $options в validates().
Возвращает
массив|булевоЕсли атомарно: Истина при успехе или ложь при неудаче. В противном случае: массив, похожий на переданный массив $data, но значения установлены в true/false в зависимости от того, прошла ли проверка каждой записи успешно.
validateMany()source public
validateMany( array $data , array $options array() )
Проверяет несколько отдельных записей для одной модели.
Параметры
- массив
$data - $data Данные записи для проверки. Это должен быть массив с числовыми индексами.
- массив
$optionsнеобязательно массив() - Параметры для использования при проверке данных записи (см. выше). См. также $options в validates().
Возвращает
смешанный типЕсли атомарно: Истина при успехе или ложь при неудаче. В противном случае: массив, похожий на переданный массив $data, но значения установлены в true/false в зависимости от того, прошла ли проверка каждой записи успешно.
validates()source public
validates( array $options array() )
Возвращает true, если все поля проходят валидацию. Также валидирует ассоциации hasAndBelongsToMany, которые используют ключ 'with'. Поскольку Model::_saveMulti не может выйти из операции сохранения.
Валидирует текущие данные. Используйте Model::set() или Model::create() для установки активных данных.
Параметры
- массив
$optionsнеобязательно array() - Необязательный массив пользовательских опций, которые будут доступны в обратном вызове beforeValidate
Возвращает
booleanTrue, если нет ошибок
Подробное описание свойств
$_behaviorssource
protected массив
Хранит список имен поведений, которые были подключены при создании этого объекта
array()
$_methodssource
protected массив
Хранит доступные пользовательские методы обратного вызова, обычно взятые из методов модели и методов поведения
array()
$_modelsource
protected Model
Содержит ссылку на модель, к которой прикреплен этот валидатор
array()
$_modelMethodssource
protected массив
Хранит доступные пользовательские методы обратного вызова из модели
array()
$_validatesource
protected массив
Свойство $validate валидаторов, используемое для проверки того, изменились ли правила валидации в модели и необходимо ли обновить этот класс
array()
© 2005–2017 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.10/class-ModelValidator.html