Spec-Zone.ru › CakePHP 3.1

Класс ValidationSet

Объект ValidationSet. Содержит все правила валидации для поля и предоставляет методы для динамического добавления или удаления правил валидации

Cake\Validation\ValidationSet реализует ArrayAccess, IteratorAggregate, Countable
Пространство имён: Cake\Validation
Расположение: Validation/ValidationSet.php

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

addsource public

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

Устанавливает правило валидации $rule с именем $name

Пример:

$set
    ->add('notBlank', ['rule' => 'notBlank'])
    ->add('inRange', ['rule' => ['between', 4, 10])

Параметры

строка $name
Имя, под которым должно быть установлено правило
Cake\Validation\ValidationRule|массив $rule
Правило валидации, которое нужно установить

Возвращает

mixed
$this

countsource public

count( )

Возвращает количество правил в этом наборе

Возвращает

integer
int

Реализация

Countable::count()

getIteratorsource public

getIterator( )

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

Возвращает

ArrayIterator
\ArrayIterator

Реализация

IteratorAggregate::getIterator()

isEmptyAllowedsource public

isEmptyAllowed( boolean|string|callable|null $allowEmpty null )

Устанавливает, разрешено ли значение поля быть пустым

Если аргумент не передан, будет возвращено текущее значение allowEmpty.

Параметры

boolean|string|callable|null $allowEmpty необязательно null
Допустимые значения: true, false, 'create', 'update'

Возвращает

boolean|string|callable
bool|string|callable

isPresenceRequiredsource public

isPresenceRequired( boolean|string|null $validatePresent null )

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

Если аргумент не передан, будет возвращено текущее значение validatePresent.

Параметры

boolean|string|null $validatePresent необязательно null
Допустимые значения: true, false, 'create', 'update'

Возвращает

boolean|string
bool|string

offsetExistssource public

offsetExists( string $index )

Возвращает, существует ли индекс в наборе правил

Параметры

строка $index
имя правила

Возвращает

boolean
bool

Реализация

ArrayAccess::offsetExists()

offsetGetsource public

offsetGet( string $index )

Возвращает объект правила по его индексу

Параметры

строка $index
имя правила

Возвращает

Cake\Validation\ValidationRule
\Cake\Validation\ValidationRule

Реализация

ArrayAccess::offsetGet()

offsetSetsource public

offsetSet( string $index , Cake\Validation\ValidationRule|array $rule )

Устанавливает или заменяет правило валидации

Параметры

строка $index
имя правила
Cake\Validation\ValidationRule|массив $rule
Правило для добавления в $index

Реализация

ArrayAccess::offsetSet()

offsetUnsetsource public

offsetUnset( string $index )

Удаляет правило валидации

Параметры

строка $index
имя правила

Реализация

ArrayAccess::offsetUnset()

removesource public

remove( string $name )

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

Пример:

$set
    ->remove('notBlank')
    ->remove('inRange')

Параметры

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

Возвращает

mixed
$this

rulesource public

rule( string $name )

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

Параметры

строка $name
Имя, под которым установлено правило.

Возвращает

Cake\Validation\ValidationRule
\Cake\Validation\ValidationRule

rulessource public

rules( )

Возвращает все правила для этого набора валидации

Возвращает

array
массив

Краткое описание свойств

$_allowEmptysource

protected boolean|string|callable

Указывает, разрешено ли поле быть пустым

false

$_rulessource

protected массив

Хранит объекты ValidationRule

[]

$_validatePresentsource

protected boolean|string

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

false

© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/3.1/class-Cake.Validation.ValidationSet.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API