Класс 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: (булево) относится ли данные, подлежащие валидации, к новой записи - data: полные данные, которые были переданы в процесс валидации - providers ассоциативный массив с объектами или именами классов, которые будут переданы в качестве последнего аргумента для метода валидации

Возвращает

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

get()source public

get( string $property )

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

Параметры

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

Возвращает

смешанный тип

isLast()source public

isLast( )

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

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

boolean

process()source public

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

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

Параметры

mixed $value: Данные для валидации
array $providers: ассоциативный массив с объектами или именами классов, которые будут переданы в качестве последнего аргумента для метода валидации
array $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–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/3.4/class-Cake.Validation.ValidationRule.html