Класс ValidationRule
Объект ValidationRule. Представляет метод валидации, сообщение об ошибке и правила для применения этого метода к полю.
Краткое описание свойств
-
$_lastprotectedКлюч 'last'boolean -
$_messageprotectedКлюч 'message'string -
$_onprotectedКлюч 'on'string -
$_passprotectedДополнительные аргументы, передаваемые методу валидацииarray -
$_providerprotectedstringКлюч, по которому будет найден объект или класс, содержащий метод, используемый для валидации
-
$_ruleprotectedМетод, вызываемый для заданного контекстаstring|callable
Краткое описание методов
- __construct() publicКонструктор
- _addValidatorProps() protectedУстанавливает свойства правила из записи правила в validate
- _skip() protectedПроверяет, должно ли быть пропущено правило валидации
- get() publicВозвращает значение свойства по имени
- isLast() public
Возвращает, следует ли прервать процесс валидации для связанного поля после его неудачи
- process() public
Передает правило валидации заданному методу валидации и возвращает булево значение, указывающее, прошло ли правило или нет. Если возвращается строка, предполагается, что правило не прошло, и в результате возвращается сообщение об ошибке.
Подробное описание методов
__construct()source public
__construct( array $validator [] )
Конструктор
Параметры
- array
$validatoroptional [] - [необязательно] Свойства валидатора
_addValidatorProps()source protected
_addValidatorProps( array $validator [] )
Устанавливает свойства правила из записи правила в validate
Параметры
- array
$validatoroptional [] - [необязательно]
_skip()source protected
_skip( array $context )
Проверяет, должно ли быть пропущено правило валидации
Параметры
- array
$context Список пар «ключ-значение» данных, которые могут быть использованы в качестве контекста во время валидации. Распознанные ключи: - newRecord: (boolean) относится ли проверяемые данные к новой записи - data: Полные данные, переданные в процесс валидации - providers ассоциативный массив с объектами или именами классов, которые будут переданы в качестве последнего аргумента для метода валидации
Возвращает
booleanTrue, если ValidationRule должно быть пропущено
get()source public
get( string $property )
Возвращает значение свойства по имени
Параметры
- string
$property - Имя свойства для получения.
Возвращает
mixedisLast()source public
isLast( )
Возвращает, следует ли прервать процесс валидации для связанного поля после его неудачи
Возвращает
booleanprocess()source public
process( mixed $value , array $providers , array $context [] )
Передает правило валидации заданному методу валидации и возвращает булево значение, указывающее, прошло ли правило или нет. Если возвращается строка, предполагается, что правило не прошло, и в результате возвращается сообщение об ошибке.
Параметры
- mixed
$value - Данные для валидации
- array
$providers Ассоциативный массив с объектами или именами классов, которые будут переданы в качестве последнего аргумента для метода валидации
- array
$contextoptional [] Список пар «ключ-значение» данных, которые могут быть использованы в качестве контекста во время валидации. Распознанные ключи: - newRecord: (boolean) относится ли проверяемые данные к новой записи - data: Полные данные, переданные в процесс валидации - field: Имя поля, обрабатываемого в данный момент
Возвращает
boolean|stringИсключения
InvalidArgumentExceptionкогда предоставленное правило не является допустимым вызываемым для настроенного контекста
Подробное описание свойств
$_providersource
protected string
Ключ, по которому будет найден объект или класс, содержащий метод, используемый для валидации
'default'
© 2005–2018 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/3.5/class-Cake.Validation.ValidationRule.html