Класс 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, если поле пусто в переданном массиве данных

Устарело

3.7.0 Используйте isEmpty() вместо этого

Параметры

смешанное $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 , string|null $message = null , string|callable|null $when = null )

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

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

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

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

Параметры

строка $field

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

Cake\Validation\Validator $validator

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

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

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

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

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

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

$this

addNestedMany()source public

addNestedMany( string $field , Cake\Validation\Validator $validator , string|null $message = null , string|callable|null $when = null )

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

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

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

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

Параметры

строка $field

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

Cake\Validation\Validator $validator

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

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

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

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

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

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

$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() изменяют одно и то же внутреннее состояние, последний вызванный метод будет иметь приоритет.

Устарело

3.7.0 Используйте allowEmptyString(), allowEmptyArray(), allowEmptyFile(), allowEmptyDate(), allowEmptyTime() или allowEmptyDateTime() вместо этого.

Параметры

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

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

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

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

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

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

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

$this

allowEmptyArray()source public

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

Разрешает поле быть пустым массивом.

Этот метод эквивалентен вызову allowEmptyFor() со флагами EMPTY_STRING + EMPTY_ARRAY.

Параметры

строка $field

Имя поля.

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

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

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

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

Возвращает

$this

С тех пор

3.7.0

См. также

\Cake\Validation\Validator::allowEmptyFor() для примеров.

allowEmptyDate()source public

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

Разрешает поле быть пустой датой.

Пустые значения даты — это null, '', [] и массивы, где все значения — '' и ключ year присутствует.

Параметры

строка $field

Имя поля.

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

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

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

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

Возвращает

$this

С тех пор

3.7.0

См. также

\Cake\Validation\Validator::allowEmptyFor() для примеров

allowEmptyDateTime()source public

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

Разрешает поле быть пустой датой/временем.

Пустые значения даты — null, '', [] и массивы, где все значения — '' и ключи year и hour присутствуют.

Этот метод эквивалентен вызову allowEmptyFor() со флагами EMPTY_STRING + EMPTY_DATE + EMPTY_TIME.

Параметры

строка $field

Имя поля.

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

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

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

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

Возвращает

$this

С тех пор

3.7.0

См. также

\Cake\Validation\Validator::allowEmptyFor() для примеров.

allowEmptyFile()source public

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

Разрешает поле быть пустым файлом.

Этот метод эквивалентен вызову allowEmptyFor() с флагом EMPTY_FILE. Поля типа «файл» не будут принимать '', или [] в качестве пустых значений. Только null и загрузка файла с error равным UPLOAD_ERR_NO_FILE будут считаться пустыми.

Параметры

строка $field

Имя поля.

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

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

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

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

Возвращает

$this

С тех пор

3.7.0

См. также

\Cake\Validation\Validator::allowEmptyFor() Для подробного использования

allowEmptyFor()source public

allowEmptyFor( string $field , integer|null $flags , boolean|string|callable $when = true , string|null $message = null )

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

В целом, этот метод использовать не следует. Вместо него следует использовать:

• allowEmptyString()
• allowEmptyArray()
• allowEmptyFile()
• allowEmptyDate()
• allowEmptyDatetime()
• allowEmptyTime()

Следует использовать их API, так как они проще в использовании и чтении.

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

Пример:

// Email can be empty
$validator->allowEmptyFor('email', Validator::EMPTY_STRING);

// Email can be empty on create
$validator->allowEmptyFor('email', Validator::EMPTY_STRING, 'create');

// Email can be empty on update
$validator->allowEmptyFor('email', Validator::EMPTY_STRING, 'update');

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

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

Если требуется разрешить другие типы пустых данных в поле, необходимо передать другие флаги:

$validator->allowEmptyFor('photo', Validator::EMPTY_FILE);
$validator->allowEmptyFor('published', Validator::EMPTY_STRING | Validator::EMPTY_DATE | Validator::EMPTY_TIME);
$validator->allowEmptyFor('items', Validator::EMPTY_STRING | Validator::EMPTY_ARRAY);

Также можно использовать удобные обертки этого метода. Следующие вызовы эквивалентны приведенным выше:

$validator->allowEmptyFile('photo');
$validator->allowEmptyDateTime('published');
$validator->allowEmptyArray('items');

Параметры

строка $field

Имя поля.

целое число|null $flags

Маска битов EMPTY_* флагов, которые указывают, что является пустым

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

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

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

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

Возвращает

$this

С тех пор

3.7.0

allowEmptyString()source public

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

Разрешает поле быть пустой строкой.

Этот метод эквивалентен вызову allowEmptyFor() с флагом EMPTY_STRING.

Параметры

строка $field

Имя поля.

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

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

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

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

Возвращает

$this

С тех пор

3.7.0

См. также

\Cake\Validation\Validator::allowEmptyFor() Для подробного использования

allowEmptyTime()source public

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

Разрешает поле быть пустым временем.

Пустые значения даты — null, '', [] и массивы, где все значения — '' и ключ hour присутствует.

Этот метод эквивалентен вызову allowEmptyFor() со флагами EMPTY_STRING + EMPTY_TIME.

Параметры

строка $field

Имя поля.

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

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

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

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

Возвращает

$this

С тех пор

3.7.0

См. также

\Cake\Validation\Validator::allowEmptyFor() для примеров.

alphaNumeric()source public

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

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

Параметры

строка $field

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

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

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

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

Either 'create' or 'update' or a callable that returns true when the validation rule should be applied.

Возвращает

$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::creditCard()

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()

equalToField()source public

equalToField( string $field , string $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::compareFields()

С тех пор как

3.6.0

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 статический

getDefaultProvider( string $name )

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

Параметры

строка $name

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

Возвращает

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

getDefaultProviders()source public статический

getDefaultProviders( )

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

Возвращает

строки[]

getIterator()source public

getIterator( )

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

Возвращает

ArrayIterator

Реализация

IteratorAggregate::getIterator()

getNotEmptyMessage()source public

getNotEmptyMessage( string $field )

Получить сообщение о непустом поле

Параметры

строка $field

Имя поля

Возвращает

строка|null

getProvider()source public

getProvider( string $name )

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

Параметры

строка $name

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

Возвращает

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

Исключения

ReflectionException

getRequiredMessage()source public

getRequiredMessage( string $field )

Получить сообщение об обязательности поля

Параметры

строка $field

Имя поля

Возвращает

строка|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()

greaterThanField()source public

greaterThanField( string $field , string $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::compareFields()

С версии

3.6.0

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()

greaterThanOrEqualToField()source public

greaterThanOrEqualToField( string $field , string $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::compareFields()

С версии

3.6.0

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()

invertWhenClause()source protected

invertWhenClause( boolean|string|callable $when )

Инвертировать условие when для создания правил notEmpty

Параметры

boolean|string|вызов $when

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

Возвращает

boolean|string|вызов

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()

isEmpty()source protected

isEmpty( mixed $data , integer $flags )

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

Параметры

смешанное $data

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

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

Побитовая маска флагов EMPTY_*, которые определяют пустоту

Возвращает

boolean

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()

lessThanField()source public

lessThanField( string $field , string $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::compareFields()

С версии

3.6.0

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()

lessThanOrEqualToField()source public

lessThanOrEqualToField( string $field , string $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::compareFields()

С версии

3.6.0

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 необязательно []

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

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

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

строка|вызов функции|null $when необязательно 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 необязательно null

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

строка|вызов функции|null $when необязательно 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 необязательно null

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

строка|вызов функции|null $when необязательно 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 необязательно null

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

строка|вызов функции|null $when необязательно 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() изменяют одно и то же внутреннее состояние, последний вызванный метод будет иметь приоритет.

Устарело

3.7.0 Используйте вместо этого notEmptyString(), notEmptyArray(), notEmptyFile(), notEmptyDate(), notEmptyTime() или notEmptyDateTime().

Параметры

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

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

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

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

логическое значение|строка|вызов функции $when необязательно false

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

Возвращает

$this

notEmptyArray()source public

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

Требует, чтобы поле было непустым массивом

Противоположно allowEmptyArray()

Параметры

строка $field

Имя поля.

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

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

логическое значение|строка|вызов функции $when необязательно false

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

Возвращает

$this

См. также

\Cake\Validation\Validator::allowEmptyArray()

С версии

3.8.0

notEmptyDate()source public

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

Требует непустое значение даты

Параметры

строка $field

Имя поля.

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

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

логическое значение|строка|вызов функции $when необязательно false

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

Возвращает

$this

С версии

3.8.0

См. также

\Cake\Validation\Validator::allowEmptyDate() для примеров

notEmptyDateTime()source public

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

Требуется поле, чтобы быть непустой датой/временем.

Противное allowEmptyDateTime

Параметры

строка $field

Имя поля.

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

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

boolean|строка|callable $when необязательно false

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

Возвращает

$this

С тех пор

3.8.0

См. также

\Cake\Validation\Validator::allowEmptyDateTime()

notEmptyFile()source public

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

Требуется поле, чтобы быть непустым файлом.

Противное allowEmptyFile()

Параметры

строка $field

Имя поля.

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

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

boolean|строка|callable $when необязательно false

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

Возвращает

$this

С тех пор

3.8.0

См. также

\Cake\Validation\Validator::allowEmptyFile()

notEmptyString()source public

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

Требуется поле, чтобы не быть пустой строкой.

Противное allowEmptyString()

Параметры

строка $field

Имя поля.

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

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

boolean|строка|callable $when необязательно false

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

Возвращает

$this

См. также

\Cake\Validation\Validator::allowEmptyString()

С тех пор

3.8.0

notEmptyTime()source public

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

Требуется поле, чтобы быть непустым временем.

Противное allowEmptyTime()

Параметры

строка $field

Имя поля.

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

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

boolean|строка|callable $when необязательно false

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

Возвращает

$this

С тех пор

3.8.0

См. также

\Cake\Validation\Validator::allowEmptyTime()

notEqualToField()source public

notEqualToField( string $field , string $secondField , string|null $message = null , string|callable|null $when = null )

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

Параметры

строка $field

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

строка $secondField

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

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

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

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

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

Возвращает

$this

См. также

\Cake\Validation\Validation::compareFields()

С тех пор

3.6.0

notEquals()source public

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

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

Параметры

строка $field

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

целое число|число с плавающей точкой $value

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

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

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

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

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

Возвращает

$this

См. также

\Cake\Validation\Validation::comparison()

notSameAs()source public

notSameAs( string $field , string $secondField , string|null $message = null , string|callable|null $when = null )

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

Параметры

строка $field

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

строка $secondField

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

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

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

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

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

Возвращает

$this

См. также

\Cake\Validation\Validation::compareFields()

С тех пор

3.6.0

numeric()source public

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

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

Параметры

строка $field

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

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

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

строка|callable|null $when необязательно 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 deprecated

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, если поле соответствует регулярному выражению.

Параметры

строка $field

Имя поля.

строка $regex

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

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

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

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

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

Возвращает

$this

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( string $field , string $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::compareFields()

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

sortMessageAndWhen()source protected

sortMessageAndWhen( mixed $first , mixed $second , string $method )

Вспомогательная функция совместимости для методов allowEmpty*, которая позволяет нам поддерживать как $when, $message синтаксис (устаревший), так и $message, $when формат, который предпочтительнее.

При использовании устаревшей формы будет выведено предупреждение об устаревании.

Параметры

смешанный $first

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

смешанный $second

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

строка $method

Вызванный метод

Возвращает

массив
Список [$message, $when]

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.

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

Параметры

строка $field

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

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

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

строка|вызываемый объект|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 имел протокол.

Параметры

строка $field

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

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

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

строка|вызываемый объект|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.

Параметры

строка $field

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

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

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

строка|вызываемый объект|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, которые необходимы для эмодзи.

Параметры

строка $field

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

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

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

строка|вызываемый объект|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.

Параметры

строка $field

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

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

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

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

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

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

$this

См. также

\Cake\Validation\Validation::uuid()

[]

[]

[]

[]

[]

[]

false