Spec-Zone.ru › CakePHP 3.4

Класс ValidationSet

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

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

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

  • $_allowEmpty protected
    boolean|string|callable
    Указывает, разрешено ли поле быть пустым
  • $_rules protected
    Cake\Validation\ValidationRule[]
    Содержит объекты ValidationRule
  • $_validatePresent protected
    boolean|string
    Указывает, должно ли быть присутствовать поле с именем в массиве данных

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

  • add() public
    Устанавливает ValidationRule $rule с именем $name
  • count() public
    Возвращает количество правил в этом наборе
  • getIterator() public
    Возвращает итератор для каждого из правил, которые необходимо применить
  • isEmptyAllowed() public
    Устанавливает, разрешено ли значение поля быть пустым
  • isPresenceRequired() public
    Устанавливает, обязательно ли присутствие поля в массиве данных.
  • offsetExists() public
    Возвращает, существует ли индекс в наборе правил
  • offsetGet() public
    Возвращает объект правила по его индексу
  • offsetSet() public
    Устанавливает или заменяет правило валидации
  • offsetUnset() public
    Удаляет правило валидации
  • remove() 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

count()source public

count( )

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

Возвращает

целое число

Реализация

Countable::count()

getIterator()source public

getIterator( )

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

Возвращает

ArrayIterator

Реализация

IteratorAggregate::getIterator()

isEmptyAllowed()source public

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

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

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

Параметры

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

Допустимые значения — true, false, 'create', 'update'

Возвращает

булево|строка|вызов

isPresenceRequired()source public

isPresenceRequired( boolean|string|null $validatePresent null )

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

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

Параметры

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

Возвращает

булево|строка

offsetExists()source public

offsetExists( string $index )

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

Параметры

строка $index
название правила

Возвращает

булево

Реализация

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

rule()source public

rule( string $name )

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

Параметры

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

Возвращает

Cake\Validation\ValidationRule

rules()source public

rules( )

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

Возвращает

Cake\Validation\ValidationRule[]

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

$_allowEmptysource

protected булево|строка|вызов

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

false

$_rulessource

protected Cake\Validation\ValidationRule[]

Содержит объекты ValidationRule

[]
END_OF_DOCUMENT_MARKER

$_validatePresentsource

protected boolean|string

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

false

© 2005–2017 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.4/class-Cake.Validation.ValidationSet.html

Spec-Zone.ru

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