Класс ValidationRule

Объект ValidationRule. Представляет метод валидации, сообщение об ошибке и правила для применения такого метода к полю.

Пространство имён: Cake\Validation
Расположение: Validation/ValidationRule.php

Краткое описание свойств

$_last protected

boolean
Ключ 'last'
$_message protected

string
Ключ 'message'
$_on protected

string
Ключ 'on'
$_pass protected

array
Дополнительные аргументы, которые необходимо передать методу валидации
$_provider protected

string

Ключ, под которым будет найден объект или класс, содержащий метод, используемый для валидации
$_rule protected

string|callable
Метод, который нужно вызвать для данного контекста

Краткое описание методов

__construct() public
Конструктор
_addValidatorProps() protected
Устанавливает свойства правила из записи правила в валидаторе
_skip() protected
Проверяет, следует ли пропустить правило валидации
get() public
Возвращает значение свойства по имени
isLast() public

Возвращает, нужно ли прервать процесс валидации для связанного поля после его провала
process() public

Передает правило валидации заданному методу валидатора и возвращает булево значение, указывающее, прошло ли правило или нет. Если возвращается строка, предполагается, что правило не выполнено, и в результате возвращается сообщение об ошибке.

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

__construct()source public

__construct( array $validator = [] )

Конструктор

Параметры

массив $validator необязательно []: [необязательно] Свойства валидатора

_addValidatorProps()source protected

_addValidatorProps( array $validator = [] )

Устанавливает свойства правила из записи правила в валидаторе

Параметры

массив $validator необязательно []: [необязательно]

_skip()source protected

_skip( array $context )

Проверяет, следует ли пропустить правило валидации

Параметры

массив $context: Список пар ключ-значение данных, которые могут использоваться в качестве контекста при валидации. Признанные ключи: - newRecord: (boolean) относится ли данные, подлежащие валидации, к новой записи - data: Все данные, переданные в процесс валидации - providers ассоциативный массив с объектами или именами классов, которые будут переданы в качестве последнего аргумента для метода валидации

Возвращаемое значение

boolean
True, если ValidationRule следует пропустить

get()source public

get( string $property )

Возвращает значение свойства по имени

Параметры

строка $property: Имя свойства для получения.

Возвращаемое значение

mixed

isLast()source public

isLast( )

Возвращает, нужно ли прервать процесс валидации для связанного поля после его провала

Возвращаемое значение

boolean

process()source public

process( mixed $value , array $providers , array $context = [] )

Передает правило валидации заданному методу валидатора и возвращает булево значение, указывающее, прошло ли правило или нет. Если возвращается строка, предполагается, что правило не выполнено, и в результате возвращается сообщение об ошибке.

Параметры

mixed $value: Данные для валидации
массив $providers: Ассоциативный массив с объектами или именами классов, которые будут переданы в качестве последнего аргумента для метода валидации
массив $context необязательно []: Список пар ключ-значение данных, которые могут использоваться в качестве контекста при валидации. Признанные ключи: - newRecord: (boolean) относится ли данные, подлежащие валидации, к новой записи - data: Все данные, переданные в процесс валидации - field: Имя поля, которое обрабатывается

Возвращаемое значение

boolean|string

Исключения

InvalidArgumentException

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

Подробное описание свойств

$_lastsource

protected boolean

Ключ 'last'

false

$_messagesource

protected string

Ключ 'message'

$_onsource

protected string

Ключ 'on'

$_passsource

protected array

Дополнительные аргументы, которые необходимо передать методу валидации

[]

$_providersource

protected string

Ключ, под которым будет найден объект или класс, содержащий метод, используемый для валидации

'default'

$_rulesource

protected string|callable

Метод, который нужно вызвать для данного контекста

© 2005–present 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.8/class-Cake.Validation.ValidationRule.html