Класс 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
Устанавливает свойства правила из записи правила в validate
_skip() protected
Проверяет, нужно ли пропустить правило валидации
get() public
Возвращает значение свойства по имени
isLast() public

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

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

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

__construct()source public

__construct( array $validator = [] )

Конструктор

Параметры

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

_addValidatorProps()source protected

_addValidatorProps( array $validator = [] )

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

Параметры

array $validator необязательный []: [необязательно]

_skip()source protected

_skip( array $context )

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

Параметры

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

Возвращает

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

get()source public

get( string $property )

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

Параметры

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

Возвращает

mixed

isLast()source public

isLast( )

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

Возвращает

boolean

process()source public

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

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

Параметры

mixed $value: Данные для валидации
array $providers: Ассоциативный массив с объектами или именами классов, которые будут переданы в качестве последнего аргумента для метода валидации
array $context необязательный []: Список пар «ключ-значение» данных, которые могут быть использованы в качестве контекста во время валидации. Распознанные ключи: - newRecord: (булево) относится ли проверяемые данные к новой записи - 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.7/class-Cake.Validation.ValidationRule.html