Класс 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 [] )

Конструктор

Параметры

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

_addValidatorProps()source protected

_addValidatorProps( array $validator [] )

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

Параметры

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

_skip()source protected

_skip( array $context )

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

Параметры

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

Возвращает

boolean
Истина, если ValidationRule должно быть пропущено

get()source public

get( string $property )

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

Параметры

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

Возвращает

mixed

isLast()source public

isLast( )

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

Возвращает

boolean

process()source public

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

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

Параметры

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

Возвращает

boolean|string

Вызывает исключение

InvalidArgumentException

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

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

$_lastsource

protected boolean

Ключ 'last'

false

$_messagesource

protected string

Ключ 'message'

null

$_onsource

protected string

Ключ 'on'

null

$_passsource

protected массив

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

[]

$_providersource

protected строка

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

'default'

$_rulesource

protected строка|вызываемый объект

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

© 2005–2016 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.
http://api.cakephp.org/3.2/class-Cake.Validation.ValidationRule.html