Класс ValidationSet
Объект ValidationSet. Содержит все правила валидации для поля и предоставляет методы для динамического добавления или удаления правил валидации
- Cake\Validation\ValidationSet реализует ArrayAccess, IteratorAggregate, Countable
Краткое описание свойств
-
$_allowEmptyprotectedУказывает, разрешено ли поле быть пустымboolean|string|callable - Содержит объекты ValidationRule
$_rulesprotected -
$_validatePresentprotectedУказывает, должно ли быть присутствовать ключ fieldname в массиве данныхboolean|string|callable
Краткое описание методов
- add() publicУстанавливает ValidationRule $rule с именем $name
- allowEmpty() publicУстанавливает, разрешено ли значение поля быть пустым.
- count() publicВозвращает количество правил в этом наборе
- getIterator() publicВозвращает итератор для каждого из правил, которые должны быть применены
- isEmptyAllowed() publicУстанавливает, разрешено ли значение поля быть пустым.
- isPresenceRequired() publicУстанавливает, требуется ли присутствие поля в массиве данных.
- offsetExists() publicВозвращает, существует ли индекс в наборе правил
- offsetGet() publicВозвращает объект правила по его индексу
- offsetSet() publicУстанавливает или заменяет правило валидации
- offsetUnset() publicУдаляет правило валидации
- remove() publicУдаляет правило валидации из набора
- requirePresence() publicУстанавливает, требуется ли присутствие поля в массиве данных.
- rule() publicПолучает правило для данного имени, если оно существует
- rules() publicВозвращает все правила для этого набора валидации
Подробное описание методов
add()source public
add( string $name , Cake\Validation\ValidationRule|array $rule )
Устанавливает ValidationRule $rule с именем $name
Пример:
$set
->add('notBlank', ['rule' => 'notBlank'])
->add('inRange', ['rule' => ['between', 4, 10]) Параметры
- строка
$name - Имя, под которым должно быть установлено правило
-
Cake\Validation\ValidationRule|массив$rule - Правило валидации, которое должно быть установлено
Возвращает
$this
allowEmpty()source public
allowEmpty( boolean|string|callable $allowEmpty )
Устанавливает, разрешено ли значение поля быть пустым.
Параметры
- boolean|string|callable
$allowEmpty Допустимые значения — true, false, 'create', 'update' или вызываемая функция.
Возвращает
$this
count()source public
count( )
Возвращает количество правил в этом наборе
Возвращает
целое числоРеализация
Countable::count() getIterator()source public
getIterator( )
Возвращает итератор для каждого из правил, которые должны быть применены
Возвращает
ArrayIteratorРеализация
IteratorAggregate::getIterator() isEmptyAllowed()source public
isEmptyAllowed( boolean|string|callable|null $allowEmpty = null )
Устанавливает, разрешено ли значение поля быть пустым.
Если аргумент не передан, будет возвращено текущее установленное значение allowEmpty.
Параметры
- boolean|string|callable|null
$allowEmptyнеобязательно null Устарело начиная с версии 3.6.0 ValidationSet::isEmptyAllowed() устарело как установщик. Используйте ValidationSet::allowEmpty() вместо него.
Возвращает
boolean|string|callableisPresenceRequired()source public
isPresenceRequired( boolean|string|callable|null $validatePresent = null )
Устанавливает, требуется ли присутствие поля в массиве данных.
Если аргумент не передан, будет возвращено текущее установленное значение validatePresent.
Параметры
- boolean|string|callable|null
$validatePresentнеобязательно null Устарело начиная с версии 3.6.0 ValidationSet::isPresenceRequired() устарело как установщик. Используйте ValidationSet::requirePresence() вместо него.
Возвращает
boolean|string|callableoffsetExists()source public
offsetExists( string $index )
Возвращает, существует ли индекс в наборе правил
Параметры
- строка
$index - имя правила
Возвращает
booleanРеализация
ArrayAccess::offsetExists() offsetGet()source public
offsetGet( string $index )
Возвращает объект правила по его индексу
Параметры
- строка
$index - имя правила
Возвращает
Cake\Validation\ValidationRuleРеализация
ArrayAccess::offsetGet() offsetSet()source public
offsetSet( string $index , Cake\Validation\ValidationRule|array $rule )
Устанавливает или заменяет правило валидации
Параметры
- строка
$index - имя правила
-
Cake\Validation\ValidationRule|массив$rule - Правило для добавления в $index
Реализация
ArrayAccess::offsetSet() offsetUnset()source public
offsetUnset( string $index )
Удаляет правило валидации
Параметры
- строка
$index - имя правила
Реализация
ArrayAccess::offsetUnset() remove()source public
remove( string $name )
Удаляет правило валидации из набора
Пример:
$set
->remove('notBlank')
->remove('inRange') Параметры
- строка
$name - Имя, под которым правило должно быть удалено
Возвращает
$this
requirePresence()source public
requirePresence( boolean|string|callable $validatePresent )
Устанавливает, требуется ли присутствие поля в массиве данных.
Параметры
- boolean|string|callable
$validatePresent - Допустимые значения — true, false, 'create', 'update' или вызываемая функция.
Возвращает
$this
rule()source public
rule( string $name )
Получает правило по заданному имени, если оно существует
Параметры
- строка
$name - Имя, под которым установлено правило.
Возвращает
Cake\Validation\ValidationRule|nullrules()source public
rules( )
Возвращает все правила для этого набора валидации
Возвращает
Cake\Validation\ValidationRule[]Подробности свойств
$_validatePresentsource
protected boolean|string|callable
Указывает, должно ли имя поля быть присутствующим в массиве данных
false
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.6/class-Cake.Validation.ValidationSet.html