Класс Validator

__construct()source public

__construct( )

Конструктор

__debugInfo()source public

__debugInfo( )

Получить печатную версию этого объекта.

Возвращает

массив

_canBeEmpty()source protected

_canBeEmpty( Cake\Validation\ValidationSet $field , array $context )

Возвращает, может ли поле быть пустым в соответствии с allowEmpty

Параметры

Cake\Validation\ValidationSet $field

набор правил для поля

массив $context

список значений данных, содержащий контекст валидации.

Возвращает

логическое значение

_checkPresence()source protected

_checkPresence( Cake\Validation\ValidationSet $field , array $context )

Возвращает false, если какая-либо валидация для переданного набора правил должна быть остановлена из-за отсутствия поля в массиве данных

Параметры

Cake\Validation\ValidationSet $field

Набор правил для поля.

массив $context

Список значений данных, содержащий контекст валидации.

Возвращает

логическое значение

_convertValidatorToArray()source protected

_convertValidatorToArray( integer|string $fieldName , array $defaults [] , string|array $settings [] )

Преобразует валидатор в массив fieldName => $settings

Параметры

целое число/строка $fieldName

имя поля

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

настройки по умолчанию

строка/массив $settings необязательно []

настройки из данных

Возвращает

массив

_fieldIsEmpty()source protected

_fieldIsEmpty( mixed $data )

Возвращает true, если поле пустое в переданном массиве данных

Параметры

смешанный $data

значение для проверки

Возвращает

логическое значение

_processRules()source protected

_processRules( string $field , Cake\Validation\ValidationSet $rules , array $data , boolean $newRecord )

Перебирает каждое правило в наборе валидации и собирает ошибки, полученные в результате их выполнения

Параметры

строка $field

Имя обрабатываемого поля

Cake\Validation\ValidationSet $rules

список правил для поля

массив $data

полные данные, переданные валидатору

логическое значение $newRecord

является ли это новым или существующим записями

Возвращает

массив

add()source public

add( string $field , array|string $name , array|Cake\Validation\ValidationRule $rule [] )

Добавляет новое правило в набор правил поля. Если второй аргумент — массив, то список правил для поля будет заменён вторым аргументом, а третий аргумент будет проигнорирован.

Пример:

$validator
         ->add('title', 'required', ['rule' => 'notBlank'])
         ->add('user_id', 'valid', ['rule' => 'numeric', 'message' => 'Invalid User'])

     $validator->add('password', [
         'size' => ['rule' => ['lengthBetween', 8, 20]],
         'hasSpecialCharacter' => ['rule' => 'validateSpecialchar', 'message' => 'not valid']
     ]);

Параметры

строка $field

Имя поля, к которому будет добавлено правило

массив/строка $name

Псевдоним для одного правила или массива правил

массив/Cake\Validation\ValidationRule $rule необязательно []

правило для добавления

Возвращает

$this

addDefaultProvider()source public static

addDefaultProvider( string $name , object|string $object )

Связывает объект с именем, чтобы он мог быть использован как поставщик по умолчанию.

Параметры

строка $name

Имя, под которым должен быть установлен поставщик.

объект/строка $object

Объект или имя класса-поставщика.

addNested()source public

addNested( string $field , Cake\Validation\Validator $validator )

Добавляет вложенный валидатор.

Вложенные валидаторы позволяют определять валидаторы для массивов. Например, вложенные валидаторы идеально подходят для проверки поддокумента или сложных типов массивов.

Этот метод предполагает, что поддокумент имеет отношение 1:1 к родительскому документу.

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

Параметры

строка $field

Корневое поле для вложенного валидатора.

Cake\Validation\Validator $validator

Вложенный валидатор.

Возвращает

$this

addNestedMany()source public

addNestedMany( string $field , Cake\Validation\Validator $validator )

Добавляет вложенный валидатор.

Вложенные валидаторы позволяют определять валидаторы для массивов. Например, вложенные валидаторы идеально подходят для проверки нескольких похожих поддокументов или сложных типов массивов.

Этот метод предполагает, что поддокумент имеет отношение 1:N к родительскому документу.

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

Параметры

строка $field

Корневое поле для вложенного валидатора.

Cake\Validation\Validator $validator

Вложенный валидатор.

Возвращает

$this

allowEmpty()source public

allowEmpty( string|array $field , boolean|string|callable $when true , string|null $message null )

Разрешает пустое поле. Вы также можете передать массив. Использование массива позволит вам предоставить следующие ключи:

• when индивидуальное условие для поля
• 'message' индивидуальное сообщение для поля

Вы также можете установить «когда» и «сообщение» для всех переданных полей, при этом индивидуальные настройки имеют приоритет над групповыми настройками.

Это противоположно notEmpty(), которое требует, чтобы поле не было пустым. Используя $mode, равный 'create' или 'update', вы можете разрешить пустые поля при первом создании записей или при их обновлении.

Пример:

// Email can be empty
$validator->allowEmpty('email');

// Email can be empty on create
$validator->allowEmpty('email', 'create');

// Email can be empty on update
$validator->allowEmpty('email', 'update');

// Email and subject can be empty on update
$validator->allowEmpty(['email', 'subject'], 'update');

// Email can be always empty, subject and content can be empty on update.
$validator->allowEmpty(
     [
         'email' => [
             'when' => true
         ],
         'content' => [
             'message' => 'Content cannot be empty'
         ],
         'subject'
     ],
     'update'
);

Возможна условная разрешенность пустоты в поле путем передачи обратного вызова как второго аргумента. Обратный вызов получит массив контекста валидации в качестве аргумента:

$validator->allowEmpty('email', function ($context) {
 return !$context['newRecord'] || $context['data']['role'] === 'admin';
});

Этот метод правильно определит пустые загрузки файлов и поля даты/времени.

Поскольку этот и notEmpty() изменяют одно и то же внутреннее состояние, последний вызываемый метод будет иметь приоритет.

Параметры

строка|массив $field

название поля или список полей

boolean|строка|вызов $when необязательно true

Указывает, когда поле разрешено быть пустым. Допустимые значения — true (всегда), 'create', 'update'. Если передан вызываемый объект, то поле будет разрешено быть пустым только когда вызываемый объект вернёт true.

строка|null $message необязательно null

Сообщение, которое отобразится, если поле не

Возвращает

$this

alphaNumeric()source public

alphaNumeric( string $field , string|null $message null , string|callable|null $when null )

Добавляет правило буквенно-цифрового формата к полю.

Параметры

строка $field

Поле, к которому нужно применить правило.

строка|null $message необязательно null

Сообщение об ошибке при нарушении правила.

строка|вызов|null $when необязательно null

«create» или «update» или вызываемый объект, возвращающий true, когда правило валидации должно быть применено.

Возвращает

$this

См.

\Cake\Validation\Validation::alphaNumeric()

ascii()source public

ascii( string $field , string|null $message null , string|callable|null $when null )

Добавляет правило валидации, чтобы гарантировать, что поле содержит только байты ASCII.

Параметры

строка $field

Поле, к которому нужно применить правило.

строка|null $message необязательно null

Сообщение об ошибке при нарушении правила.

строка|вызов|null $when необязательно null

«create» или «update» или вызываемый объект, возвращающий true, когда правило валидации должно быть применено.

Возвращает

$this

См.

\Cake\Validation\Validation::ascii()

boolean()source public

boolean( string $field , string|null $message null , string|callable|null $when null )

Добавляет правило валидации булевого типа к полю.

Параметры

строка $field

Поле, к которому нужно применить правило.

строка|null $message необязательно null

Сообщение об ошибке при нарушении правила.

строка|вызов|null $when необязательно null

«create» или «update» или вызываемый объект, возвращающий true, когда правило валидации должно быть применено.

Возвращает

$this

См.

\Cake\Validation\Validation::boolean()

containsNonAlphaNumeric()source public

containsNonAlphaNumeric( string $field , integer $limit 1 , string|null $message null , string|callable|null $when null )

Добавляет правило проверки, содержатся ли в поле небуквенно-цифровые символы.

Параметры

строка $field

Поле, к которому нужно применить правило.

целое число $limit необязательно 1

Минимальное количество небуквенно-цифровых символов, необходимых для выполнения правила.

строка|null $message необязательно null

Сообщение об ошибке при нарушении правила.

строка|вызов|null $when необязательно null

«create» или «update» или вызываемый объект, возвращающий true, когда правило валидации должно быть применено.

Возвращает

$this

См.

\Cake\Validation\Validation::containsNonAlphaNumeric()

count()source public

count( )

Возвращает количество полей с правилами валидации

Возвращает

целое число

Реализация

Countable::count()

creditCard()source public

creditCard( string $field , string $type 'all' , string|null $message null , string|callable|null $when null )

Добавляет правило валидации номера кредитной карты к полю.

Параметры

строка $field

Поле, к которому нужно применить правило.

строка $type необязательно 'all'

Тип карт, которые вы хотите разрешить. По умолчанию «all». Также можно указать массив допустимых типов карт. Например, ['mastercard', 'visa', 'amex']

строка|null $message необязательно null

Сообщение об ошибке при нарушении правила.

строка|вызов|null $when необязательно null

«create» или «update» или вызываемый объект, возвращающий true, когда правило валидации должно быть применено.

Возвращает

$this

См.

\Cake\Validation\Validation::cc()

date()source public

date( string $field , array $formats ['ymd'] , string|null $message null , string|callable|null $when null )

Добавляет правило валидации формата даты к полю.

Параметры

строка $field

Поле, к которому нужно применить правило.

массив $formats необязательно ['ymd']

Список допустимых форматов дат.

строка|null $message необязательно null

Сообщение об ошибке при нарушении правила.

строка|вызов|null $when необязательно null

«create» или «update» или вызываемый объект, возвращающий true, когда правило валидации должно быть применено.

Возвращает

$this

См.

\Cake\Validation\Validation::date()

dateTime()source public

dateTime( string $field , array $formats ['ymd'] , string|null $message null , string|callable|null $when null )

Добавить правило валидации формата даты и времени для поля.

Параметры

строка $field

Поле, к которому нужно применить правило.

массив $formats необязательно ['ymd']

Список допустимых форматов дат.

строка|null $message необязательно null

Сообщение об ошибке при нарушении правила.

строка|вызываемый объект|null $when необязательно null

Значение 'create' или 'update' или вызываемый объект, возвращающий true, когда правило валидации должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::datetime()

decimal()source public

decimal( string $field , integer|null $places null , string|null $message null , string|callable|null $when null )

Добавить правило валидации десятичного числа для поля.

Параметры

строка $field

Поле, к которому нужно применить правило.

целое число|null $places необязательно null

Количество знаков после запятой, которое требуется.

строка|null $message необязательно null

Сообщение об ошибке при нарушении правила.

строка|вызываемый объект|null $when необязательно null

Значение 'create' или 'update' или вызываемый объект, возвращающий true, когда правило валидации должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::decimal()

email()source public

email( string $field , boolean $checkMX false , string|null $message null , string|callable|null $when null )

Добавить правило валидации адреса электронной почты для поля.

Параметры

строка $field

Поле, к которому нужно применить правило.

логическое значение $checkMX необязательно false

Флаг проверки MX-записей.

строка|null $message необязательно null

Сообщение об ошибке при нарушении правила.

строка|вызываемый объект|null $when необязательно null

Значение 'create' или 'update' или вызываемый объект, возвращающий true, когда правило валидации должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::email()

equals()source public

equals( string $field , integer|float $value , string|null $message null , string|callable|null $when null )

Добавить правило сравнения на равенство для поля.

Параметры

строка $field

Поле, к которому нужно применить правило.

целое число|вещественное число $value

Значение, с которым должно совпадать пользовательское значение данных.

строка|null $message необязательно null

Сообщение об ошибке при нарушении правила.

строка|вызываемый объект|null $when необязательно null

Значение 'create' или 'update' или вызываемый объект, возвращающий true, когда правило валидации должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::comparison()

errors()source public

errors( array $data , boolean $newRecord true )

Возвращает массив полей, которые не прошли валидацию. Для текущей модели. Этот метод фактически выполняет правила валидации над данными, а не просто возвращает сообщения.

Параметры

массив $data

Данные, которые необходимо проверить на ошибки

логическое значение $newRecord необязательно true

Указывает, являются ли данные, которые нужно валидировать, новыми или обновляемыми.

Возвращает

массив
Массив недопустимых полей

field()source public

field( string $name , Cake\Validation\ValidationSet $set null )

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

Параметры

строка $name

[необязательно] Имя поля для извлечения.

Cake\Validation\ValidationSet $set необязательно null

Набор правил для поля

Возвращает

Cake\Validation\ValidationSet

getDefaultProvider()source public static

getDefaultProvider( string $name )

Возвращает поставщика по умолчанию, сохранённого под этим именем, если он существует.

Параметры

строка $name

Имя, под которым должен быть получен поставщик.

Возвращает

объект|строка|null

getDefaultProviders()source public static

getDefaultProviders( )

Получить список поставщиков по умолчанию.

Возвращает

массив

getIterator()source public

getIterator( )

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

Возвращает

ArrayIterator

Реализация

IteratorAggregate::getIterator()

getProvider()source public

getProvider( string $name )

Возвращает поставщика, сохранённого под этим именем, если он существует.

Параметры

строка $name

Имя, под которым должен быть установлен поставщик.

Возвращает

объект|строка|null

greaterThan()source public

greaterThan( string $field , integer|float $value , string|null $message null , string|callable|null $when null )

Добавить правило сравнения больше, чем для поля.

Параметры

строка $field

Поле, к которому нужно применить правило.

целое число|вещественное число $value

Значение, которое должно быть больше пользовательского значения данных.

строка|null $message необязательно null

Сообщение об ошибке при нарушении правила.

строка|вызываемый объект|null $when необязательно null

Значение 'create' или 'update' или вызываемый объект, возвращающий true, когда правило валидации должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::comparison()

greaterThanOrEqual()source public

greaterThanOrEqual( string $field , integer|float $value , string|null $message null , string|callable|null $when null )

Добавить правило сравнения больше или равно для поля.

Параметры

строка $field

Поле, к которому нужно применить правило.

целое число|вещественное число $value

Значение, которое должно быть больше или равно пользовательскому значению данных.

строка|null $message необязательно null

Сообщение об ошибке при нарушении правила.

строка|вызываемый объект|null $when необязательно null

Значение 'create' или 'update' или вызываемый объект, возвращающий true, когда правило валидации должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::comparison()

hasAtLeast()source public

hasAtLeast( string $field , integer $count , string|null $message null , string|callable|null $when null )

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

Параметры

строка $field

Поле, к которому нужно применить правило.

целое число $count

Минимальное количество элементов в массиве.

строка|null $message необязательно null

Сообщение об ошибке при нарушении правила.

строка|вызываемый объект|null $when необязательно null

Значение 'create' или 'update' или вызываемый объект, возвращающий true, когда правило валидации должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::numElements()

hasAtMost()source public

hasAtMost( string $field , integer $count , string|null $message null , string|callable|null $when null )

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

Параметры

строка $field

Поле, к которому вы хотите применить правило.

целое число $count

Максимальное количество элементов, которое должно содержать поле

строка|null $message необязательно null

Сообщение об ошибке, если правило не выполняется.

строка|вызываемый объект|null $when необязательно null

Либо 'create', либо 'update', либо вызываемый объект, который возвращает true, когда правило валидации должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::numElements()

hasField()source public

hasField( string $name )

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

Параметры

строка $name

Имя поля для проверки.

Возвращает

boolean

hexColor()source public

hexColor( string $field , string|null $message null , string|callable|null $when null )

Добавить правило валидации, чтобы убедиться, что поле имеет значение шестнадцатеричного цвета из 6 цифр.

Параметры

строка $field

Поле, к которому вы хотите применить правило.

строка|null $message необязательно null

Сообщение об ошибке, если правило не выполняется.

строка|вызываемый объект|null $when необязательно null

Либо 'create', либо 'update', либо вызываемый объект, который возвращает true, когда правило валидации должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::hexColor()

inList()source public

inList( string $field , array $list , string|null $message null , string|callable|null $when null )

Добавить правило валидации, чтобы убедиться, что значение поля находится в белом списке.

Параметры

строка $field

Поле, к которому вы хотите применить правило.

массив $list

Список допустимых вариантов.

строка|null $message необязательно null

Сообщение об ошибке, если правило не выполняется.

строка|вызываемый объект|null $when необязательно null

Либо 'create', либо 'update', либо вызываемый объект, который возвращает true, когда правило валидации должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::inList()

integer()source public

integer( string $field , string|null $message null , string|callable|null $when null )

Добавить правило валидации, чтобы убедиться, что поле имеет целое числовое значение.

Параметры

строка $field

Поле, к которому вы хотите применить правило.

строка|null $message необязательно null

Сообщение об ошибке, если правило не выполняется.

строка|вызываемый объект|null $when необязательно null

Либо 'create', либо 'update', либо вызываемый объект, который возвращает true, когда правило валидации должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::isInteger()

ip()source public

ip( string $field , string|null $message null , string|callable|null $when null )

Добавить правило валидации IP-адреса к полю.

Это правило будет принимать как IPv4, так и IPv6 адреса.

Параметры

строка $field

Поле, к которому вы хотите применить правило.

строка|null $message необязательно null

Сообщение об ошибке, если правило не выполняется.

строка|вызываемый объект|null $when необязательно null

Либо 'create', либо 'update', либо вызываемый объект, который возвращает true, когда правило валидации должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::ip()

ipv4()source public

ipv4( string $field , string|null $message null , string|callable|null $when null )

Добавить правило валидации IPv4 к полю.

Параметры

строка $field

Поле, к которому вы хотите применить правило.

строка|null $message необязательно null

Сообщение об ошибке, если правило не выполняется.

строка|вызываемый объект|null $when необязательно null

Либо 'create', либо 'update', либо вызываемый объект, который возвращает true, когда правило валидации должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::ip()

ipv6()source public

ipv6( string $field , string|null $message null , string|callable|null $when null )

Добавить правило валидации IPv6 к полю.

Параметры

строка $field

Поле, к которому вы хотите применить правило.

строка|null $message необязательно null

Сообщение об ошибке, если правило не выполняется.

строка|вызываемый объект|null $when необязательно null

Либо 'create', либо 'update', либо вызываемый объект, который возвращает true, когда правило валидации должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::ip()

isArray()source public

isArray( string $field , string|null $message null , string|callable|null $when null )

Добавить правило валидации, чтобы убедиться, что поле содержит массив.

Параметры

строка $field

Поле, к которому вы хотите применить правило.

строка|null $message необязательно null

Сообщение об ошибке, если правило не выполняется.

строка|вызываемый объект|null $when необязательно null

Либо 'create', либо 'update', либо вызываемый объект, который возвращает true, когда правило валидации должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::isArray()

isEmptyAllowed()source public

isEmptyAllowed( string $field , boolean $newRecord )

Возвращает, разрешено ли оставить поле пустым для новой или уже существующей записи.

Параметры

строка $field

Имя поля.

boolean $newRecord

Являются ли данные, которые нужно валидировать, новыми или обновляемыми.

Возвращает

boolean

isPresenceRequired()source public

isPresenceRequired( string $field , boolean $newRecord )

Возвращает, требуется ли присутствие поля для новой или уже существующей записи.

Параметры

строка $field

Имя поля.

boolean $newRecord

Являются ли данные, которые нужно валидировать, новыми или обновляемыми.

Возвращает

boolean

latLong()source public

latLong( string $field , string|null $message null , string|callable|null $when null )

Добавить правило валидации для проверки, является ли поле кортежем широты/долготы.

например: <lat>, <lng>

Параметры

строка $field

Поле, к которому вы хотите применить правило.

строка|null $message необязательно null

Сообщение об ошибке, если правило не выполняется.

строка|вызываемый объект|null $when необязательно null

Либо 'create', либо 'update', либо вызываемый объект, который возвращает true, когда правило валидации должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::uuid()

latitude()source public

latitude( string $field , string|null $message null , string|callable|null $when null )

Добавить правило валидации, чтобы убедиться, что поле является широтой.

Параметры

строка $field

Поле, к которому нужно применить правило.

строка|null $message необязательно null

Сообщение об ошибке, если правило не выполняется.

строка|вызов|null $when необязательно null

Либо 'create', либо 'update', либо вызов, возвращающий true, когда правило валидации должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::latitude()

lengthBetween()source public

lengthBetween( string $field , array $range , string|null $message null , string|callable|null $when null )

Добавить правило, гарантирующее, что длина строки находится в определённом диапазоне.

Параметры

строка $field

Поле, к которому нужно применить правило.

массив $range

Включающие минимальную и максимальную длину, разрешённые для поля.

строка|null $message необязательно null

Сообщение об ошибке, если правило не выполняется.

строка|вызов|null $when необязательно null

Либо 'create', либо 'update', либо вызов, возвращающий true, когда правило валидации должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::alphaNumeric()

lessThan()source public

lessThan( string $field , integer|float $value , string|null $message null , string|callable|null $when null )

Добавить правило сравнения "меньше", чем для поля.

Параметры

строка $field

Поле, к которому нужно применить правило.

целое|вещественное $value

Значение, которое данные пользователя должны быть меньше.

строка|null $message необязательно null

Сообщение об ошибке, если правило не выполняется.

строка|вызов|null $when необязательно null

Либо 'create', либо 'update', либо вызов, возвращающий true, когда правило валидации должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::comparison()

lessThanOrEqual()source public

lessThanOrEqual( string $field , integer|float $value , string|null $message null , string|callable|null $when null )

Добавить правило сравнения "меньше или равно" для поля.

Параметры

строка $field

Поле, к которому нужно применить правило.

целое|вещественное $value

Значение, которому данные пользователя должны быть меньше или равны.

строка|null $message необязательно null

Сообщение об ошибке, если правило не выполняется.

строка|вызов|null $when необязательно null

Либо 'create', либо 'update', либо вызов, возвращающий true, когда правило валидации должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::comparison()

localizedTime()source public

localizedTime( string $field , string $type 'datetime' , string|null $message null , string|callable|null $when null )

Добавить правило валидации локализованного формата времени, даты или даты и времени для поля.

Параметры

строка $field

Поле, к которому нужно применить правило.

строка $type необязательно 'datetime'

Тип парсера, один из 'date', 'time' и 'datetime'

строка|null $message необязательно null

Сообщение об ошибке, если правило не выполняется.

строка|вызов|null $when необязательно null

Либо 'create', либо 'update', либо вызов, возвращающий true, когда правило валидации должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::localizedTime()

longitude()source public

longitude( string $field , string|null $message null , string|callable|null $when null )

Добавить правило валидации, чтобы убедиться, что поле является долготой.

Параметры

строка $field

Поле, к которому нужно применить правило.

строка|null $message необязательно null

Сообщение об ошибке, если правило не выполняется.

строка|вызов|null $when необязательно null

Либо 'create', либо 'update', либо вызов, возвращающий true, когда правило валидации должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::longitude()

maxLength()source public

maxLength( string $field , integer $max , string|null $message null , string|callable|null $when null )

Добавить правило валидации длины строки для поля.

Параметры

строка $field

Поле, к которому нужно применить правило.

целое $max

Максимальная разрешённая длина.

строка|null $message необязательно null

Сообщение об ошибке, если правило не выполняется.

строка|вызов|null $when необязательно null

Либо 'create', либо 'update', либо вызов, возвращающий true, когда правило валидации должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::maxLength()

maxLengthBytes()source public

maxLengthBytes( string $field , integer $max , string|null $message null , string|callable|null $when null )

Добавить правило валидации длины строки для поля.

Параметры

строка $field

Поле, к которому нужно применить правило.

целое $max

Максимальная разрешённая длина.

строка|null $message необязательно null

Сообщение об ошибке, если правило не выполняется.

строка|вызов|null $when необязательно null

Либо 'create', либо 'update', либо вызов, возвращающий true, когда правило валидации должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::maxLengthBytes()

minLength()source public

minLength( string $field , integer $min , string|null $message null , string|callable|null $when null )

Добавить правило валидации длины строки для поля.

Параметры

строка $field

Поле, к которому нужно применить правило.

целое $min

Минимальная необходимая длина.

строка|null $message необязательно null

Сообщение об ошибке, если правило не выполняется.

строка|вызов|null $when необязательно null

Либо 'create', либо 'update', либо вызов, возвращающий true, когда правило валидации должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::minLength()

minLengthBytes()source public

minLengthBytes( string $field , integer $min , string|null $message null , string|callable|null $when null )

Добавить правило валидации длины строки для поля.

Параметры

строка $field

Поле, к которому нужно применить правило.

целое $min

Минимальная необходимая длина.

строка|null $message необязательно null

Сообщение об ошибке, если правило не выполняется.

строка|вызов|null $when необязательно null

Либо 'create', либо 'update', либо вызов, возвращающий true, когда правило валидации должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::minLengthBytes()

multipleOptions()source public

multipleOptions( string $field , array $options [] , string|null $message null , string|callable|null $when null )

Добавление правила валидации для множественного выбора. Сравнение по умолчанию регистрозависимое.

Параметры

строка $field

Поле, к которому нужно применить правило.

массив $options optional []

Параметры валидатора. Включает параметры, определённые в \Cake\Validation\Validation::multiple(), и параметр caseInsensitive.

строка|null $message optional null

Сообщение об ошибке при нарушении правила.

строка|вызов|null $when optional null

Значение 'create', 'update' или вызов, возвращающий true, когда правило валидации должно быть применено.

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

$this

См. также

\Cake\Validation\Validation::multiple()

naturalNumber()source public

naturalNumber( string $field , string|null $message null , string|callable|null $when null )

Добавление правила валидации для натурального числа в поле.

Параметры

строка $field

Поле, к которому нужно применить правило.

строка|null $message optional null

Сообщение об ошибке при нарушении правила.

строка|вызов|null $when optional null

Значение 'create', 'update' или вызов, возвращающий true, когда правило валидации должно быть применено.

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

$this

См. также

\Cake\Validation\Validation::naturalNumber()

nonNegativeInteger()source public

nonNegativeInteger( string $field , string|null $message null , string|callable|null $when null )

Добавление правила валидации для неотрицательного целого числа в поле.

Параметры

строка $field

Поле, к которому нужно применить правило.

строка|null $message optional null

Сообщение об ошибке при нарушении правила.

строка|вызов|null $when optional null

Значение 'create', 'update' или вызов, возвращающий true, когда правило валидации должно быть применено.

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

$this

См. также

\Cake\Validation\Validation::naturalNumber()

notBlank()source public

notBlank( string $field , string|null $message null , string|callable|null $when null )

Добавление правила notBlank для поля.

Параметры

строка $field

Поле, к которому нужно применить правило.

строка|null $message optional null

Сообщение об ошибке при нарушении правила.

строка|вызов|null $when optional null

Значение 'create', 'update' или вызов, возвращающий true, когда правило валидации должно быть применено.

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

$this

См. также

\Cake\Validation\Validation::notBlank()

notEmpty()source public

notEmpty( string|array $field , string|null $message null , boolean|string|callable $when false )

Устанавливает требование для поля не быть пустым. Также можно передать массив. Использование массива позволяет указать следующие ключи:

• when индивидуальное условие для поля
• message индивидуальное сообщение об ошибке для поля

Также можно установить when и message для всех переданных полей, индивидуальное значение имеет приоритет над групповыми настройками.

Это противоположность allowEmpty(), которая разрешает пустые поля. Используя $mode равное 'create' или 'update', можно сделать поля обязательными при первом создании записей или при их обновлении.

Пример:

$message = 'This field cannot be empty';

// Email cannot be empty
$validator->notEmpty('email');

// Email can be empty on update, but not create
$validator->notEmpty('email', $message, 'create');

// Email can be empty on create, but required on update.
$validator->notEmpty('email', $message, 'update');

// Email and title can be empty on create, but are required on update.
$validator->notEmpty(['email', 'title'], $message, 'update');

// Email can be empty on create, title must always be not empty
$validator->notEmpty(
     [
         'email',
         'title' => [
             'when' => true,
             'message' => 'Title cannot be empty'
         ]
     ],
     $message,
     'update'
);

Можно условно запретить пустое значение для поля, передав коллбек в качестве третьего аргумента. Коллбек получит массив контекста валидации в качестве аргумента:

$validator->notEmpty('email', 'Email is required', function ($context) {
  return $context['newRecord'] && $context['data']['role'] !== 'admin';
});

Поскольку этот и allowEmpty() методы изменяют одинаковое внутреннее состояние, последний вызванный метод будет иметь приоритет.

Параметры

строка|массив $field

имя поля или список полей

строка|null $message optional null

Сообщение, отображаемое, если поле пустое

boolean|строка|вызов $when optional false

Указывает, когда поле не должно быть пустым. Допустимые значения: true (всегда), 'create', 'update'. Если передан вызов, поле будет разрешено быть пустым только когда коллбек вернёт false.

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

$this

notEquals()source public

notEquals( string $field , integer|float $value , string|null $message null , string|callable|null $when null )

Добавление правила сравнения неравенства для поля.

Параметры

строка $field

Поле, к которому нужно применить правило.

целое|дробное $value

Значение, которому данные пользователя не должны быть равны.

строка|null $message optional null

Сообщение об ошибке при нарушении правила.

строка|вызов|null $when optional null

Значение 'create', 'update' или вызов, возвращающий true, когда правило валидации должно быть применено.

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

$this

См. также

\Cake\Validation\Validation::comparison()

numeric()source public

numeric( string $field , string|null $message null , string|callable|null $when null )

Добавление правила валидации для числового значения в поле.

Параметры

строка $field

Поле, к которому нужно применить правило.

строка|null $message optional null

Сообщение об ошибке при нарушении правила.

строка|вызов|null $when optional null

Значение 'create', 'update' или вызов, возвращающий true, когда правило валидации должно быть применено.

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

$this

См. также

\Cake\Validation\Validation::numeric()

offsetExists()source public

offsetExists( string $field )

Возвращает, определён ли набор правил для поля.

Параметры

строка $field

имя поля для проверки

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

boolean

Реализация

ArrayAccess::offsetExists()

offsetGet()source public

offsetGet( string $field )

Возвращает набор правил для поля.

Параметры

строка $field

имя поля для проверки

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

Cake\Validation\ValidationSet

Реализация

ArrayAccess::offsetGet()

offsetSet()source public

offsetSet( string $field , array|Cake\Validation\ValidationSet $rules )

Устанавливает набор правил для поля.

Параметры

строка $field

имя поля для установки

массив|Cake\Validation\ValidationSet $rules

набор правил для применения к полю

Реализация

ArrayAccess::offsetSet()

offsetUnset()source public

offsetUnset( string $field )

Удаляет набор правил для поля.

Параметры

строка $field

имя поля для удаления

Реализация

ArrayAccess::offsetUnset()

provider()source public

provider( string $name , null|object|string $object null )

Связывает объект с именем, чтобы его можно было использовать в качестве поставщика. Поставщики — это объекты или имена классов, которые могут содержать методы, используемые во время проверки для определения, может ли быть применено правило проверки. Все методы проверки при вызове получат полный список поставщиков, хранящихся в этом валидаторе.

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

Устарело

3.4.0 Используйте setProvider()/getProvider() вместо этого.

Параметры

строка $name

Имя, под которым должен быть задан поставщик.

null|объект|строка $object необязательно null

Объект или имя класса поставщика.

Возвращает

$this|объект|строка|null

providers()source public

providers( )

Получить список поставщиков в этом валидаторе.

Возвращает

массив

range()source public

range( string $field , array $range , string|null $message null , string|callable|null $when null )

Добавить правило проверки, чтобы убедиться, что поле находится в числовом диапазоне

Параметры

строка $field

Поле, к которому нужно применить правило.

массив $range

Включающие верхнюю и нижнюю границы допустимого диапазона.

строка|null $message необязательно null

Сообщение об ошибке, когда правило не выполняется.

строка|вызов|null $when необязательно null

Либо 'create', либо 'update', либо вызов, который возвращает true, когда правило проверки должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::range()

regex()source public

regex( string $field , string $regex , string|null $message null , string|callable|null $when null )

Возвращает true или false, соответствует ли поле регулярному выражению.

Параметры

строка $field

Имя поля.

строка $regex

Регулярное выражение.

строка|null $message необязательно null

Сообщение об ошибке, когда правило не выполняется.

строка|вызов|null $when необязательно null

Либо 'create', либо 'update', либо вызов, который возвращает true, когда правило проверки должно быть применено.

Возвращает

boolean

remove()source public

remove( string $field , string|null $rule null )

Удаляет правило из набора по его имени

Пример:

$validator
         ->remove('title', 'required')
         ->remove('user_id')

Параметры

строка $field

Имя поля, из которого будет удалено правило

строка|null $rule необязательно null

имя правила, которое нужно удалить

Возвращает

$this

requirePresence()source public

requirePresence( string|array $field , boolean|string|callable $mode true , string|null $message null )

Устанавливает, требуется ли присутствие поля в массиве данных. Вы также можете передать массив. Использование массива позволит вам предоставить следующие ключи:

• mode индивидуальный режим для поля
• message индивидуальное сообщение об ошибке для поля

Вы также можете установить режим и сообщение для всех переданных полей, индивидуальное значение имеет приоритет над групповыми настройками.

Параметры

строка|массив $field

имя поля или список полей.

boolean|строка|вызов $mode необязательно true

Допустимые значения — true, false, 'create', 'update'. Если передан вызов, то поле будет требоваться только тогда, когда обратный вызов вернёт true.

строка|null $message необязательно null

Сообщение, отображаемое, если проверка присутствия поля не пройдена.

Возвращает

$this

sameAs()source public

sameAs( mixed $field , mixed $secondField , string|null $message null , string|callable|null $when null )

Добавить правило для сравнения двух полей друг с другом.

Если оба поля имеют точно одинаковое значение, правило выполнится.

Параметры

смешанный $field

Поле, к которому нужно применить правило.

смешанный $secondField

Поле, с которым нужно сравнить.

строка|null $message необязательно null

Сообщение об ошибке, когда правило не выполняется.

строка|вызов|null $when необязательно null

Либо 'create', либо 'update', либо вызов, который возвращает true, когда правило проверки должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::compareWith()

scalar()source public

scalar( string $field , string|null $message null , string|callable|null $when null )

Добавить правило проверки, чтобы убедиться, что поле содержит скаляр.

Параметры

строка $field

Поле, к которому нужно применить правило.

строка|null $message необязательно null

Сообщение об ошибке, когда правило не выполняется.

строка|вызов|null $when необязательно null

Либо 'create', либо 'update', либо вызов, который возвращает true, когда правило проверки должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::isScalar()

setProvider()source public

setProvider( string $name , object|string $object )

Связывает объект с именем, чтобы его можно было использовать в качестве поставщика. Поставщики — это объекты или имена классов, которые могут содержать методы, используемые во время проверки для определения, может ли быть применено правило проверки. Все методы проверки при вызове получат полный список поставщиков, хранящихся в этом валидаторе.

Параметры

строка $name

Имя, под которым должен быть задан поставщик.

объект|строка $object

Объект или имя класса поставщика.

Возвращает

$this

time()source public

time( string $field , string|null $message null , string|callable|null $when null )

Добавить правило проверки формата времени для поля.

Параметры

строка $field

Поле, к которому нужно применить правило.

строка|null $message необязательно null

Сообщение об ошибке, когда правило не выполняется.

строка|вызов|null $when необязательно null

Либо 'create', либо 'update', либо вызов, который возвращает true, когда правило проверки должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::time()

uploadedFile()source public

uploadedFile( string $field , array $options , string|null $message null , string|callable|null $when null )

Добавить правило проверки, чтобы убедиться, что поле является загруженным файлом

Для параметров см. Cake\Validation\Validation::uploadedFile()

Параметры

строка $field

Поле, к которому нужно применить правило.

массив $options

Массив параметров.

строка|null $message необязательно null

Сообщение об ошибке, когда правило не выполняется.

строка|вызов|null $when необязательно null

Либо 'create', либо 'update', либо вызов, который возвращает true, когда правило проверки должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::uploadedFile()

url()source public

url( string $field , string|null $message null , string|callable|null $when null )

Добавить правило проверки, чтобы убедиться, что поле является URL.

Этот валидатор не требует протокола.

Параметры

string $field

Поле, к которому нужно применить правило.

string|null $message необязательно null

Сообщение об ошибке, если правило не выполняется.

string|callable|null $when необязательно null

Либо 'create', либо 'update', либо вызываемый объект, возвращающий true, когда правило проверки должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::url()

urlWithProtocol()source public

urlWithProtocol( string $field , string|null $message null , string|callable|null $when null )

Добавить правило проверки, чтобы убедиться, что поле является URL.

Этот валидатор требует, чтобы URL содержал протокол.

Параметры

string $field

Поле, к которому нужно применить правило.

string|null $message необязательно null

Сообщение об ошибке, если правило не выполняется.

string|callable|null $when необязательно null

Либо 'create', либо 'update', либо вызываемый объект, возвращающий true, когда правило проверки должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::url()

utf8()source public

utf8( string $field , string|null $message null , string|callable|null $when null )

Добавить правило проверки, чтобы убедиться, что поле содержит только байты BMP utf8.

Параметры

string $field

Поле, к которому нужно применить правило.

string|null $message необязательно null

Сообщение об ошибке, если правило не выполняется.

string|callable|null $when необязательно null

Либо 'create', либо 'update', либо вызываемый объект, возвращающий true, когда правило проверки должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::utf8()

utf8Extended()source public

utf8Extended( string $field , string|null $message null , string|callable|null $when null )

Добавить правило проверки, чтобы убедиться, что поле содержит только байты utf8.

Это правило будет принимать 3- и 4-байтовые последовательности UTF8, необходимые для эмодзи.

Параметры

string $field

Поле, к которому нужно применить правило.

string|null $message необязательно null

Сообщение об ошибке, если правило не выполняется.

string|callable|null $when необязательно null

Либо 'create', либо 'update', либо вызываемый объект, возвращающий true, когда правило проверки должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::utf8()

uuid()source public

uuid( string $field , string|null $message null , string|callable|null $when null )

Добавить правило проверки, чтобы убедиться, что поле является UUID.

Параметры

string $field

Поле, к которому нужно применить правило.

string|null $message необязательно null

Сообщение об ошибке, если правило не выполняется.

string|callable|null $when необязательно null

Либо 'create', либо 'update', либо вызываемый объект, возвращающий true, когда правило проверки должно быть применено.

Возвращает

$this

См. также

\Cake\Validation\Validation::uuid()

[]

[]

[]

[]

[]

false