Класс ValidationRule
Объект ValidationRule. Представляет метод валидации, сообщение об ошибке и правила для применения этого метода к полю.
Краткое описание свойств
- $_last protected
boolКлюч 'last'
- $_message protected
stringКлюч 'message'
- $_on protected
string|callableКлюч '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() public
__construct(array $validator = [])
Конструктор
Параметры
-
array$validator optional [необязательно] Свойства валидатора
_addValidatorProps() protected
_addValidatorProps(array $validator = []): void
Устанавливает свойства правила из записи правила в validate
Параметры
-
array$validator optional [необязательно]
Возвращаемое значение
void_skip() protected
_skip(array $context): bool
Проверяет, должно ли правило валидации быть пропущено
Параметры
-
array$context -
Список значений пар ключ-значение, которые могут быть использованы в качестве контекста во время валидации. Распознаваемые ключи:
- newRecord: (boolean) указывает, относится ли данные к новой записи
- data: Полные данные, переданные в процесс валидации
- providers ассоциативный массив с объектами или именами классов, которые будут переданы в качестве последнего аргумента для метода валидации
Возвращаемое значение
boolget() public
get(string $property): mixed
Возвращает значение свойства по имени
Параметры
-
string$property Имя свойства, которое нужно получить.
Возвращаемое значение
mixedisLast() public
isLast(): bool
Возвращает, должно ли это правило прервать процесс валидации связанного поля после его неудачи
Возвращаемое значение
boolprocess() public
process(mixed $value, array $providers, array $context = []): bool|string|array
Пересылает правило валидации в заданный метод валидатора и возвращает булево значение, указывающее, прошло ли правило или нет. Если возвращается строка, считается, что правило не прошло, и в результате было возвращено сообщение об ошибке.
Параметры
-
mixed$value Данные для валидации
-
array$providers Ассоциативный массив с объектами или именами классов, которые будут переданы в качестве последнего аргумента для метода валидации
-
array$context optional -
Список значений пар ключ-значение, которые могут быть использованы в качестве контекста во время валидации. Распознаваемые ключи:
- newRecord: (boolean) указывает, относится ли данные к новой записи
- data: Полные данные, переданные в процесс валидации
- field: Имя поля, которое обрабатывается
Возвращаемое значение
bool|string|arrayИсключения
InvalidArgumentExceptionпри невалидности переданного правила в качестве вызываемой функции для заданного контекста
Подробное описание свойств
$_last protected
Ключ 'last'
Тип
bool$_message protected
Ключ 'message'
Тип
string$_on protected
Ключ 'on'
Тип
string|callable$_pass protected
Дополнительные аргументы, которые нужно передать методу валидации
Тип
array$_provider protected
Ключ, под которым находится объект или класс, содержащий метод, используемый для валидации
Тип
string$_rule 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/4.2/class-Cake.Validation.ValidationRule.html
