Spec-Zone.ru › CakePHP 4.2

Класс ValidationSet

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

Пространство имён: Cake\Validation

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

  • $_allowEmpty protected
    bool|string|callable

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

  • $_rules protected
    Cake\Validation\ValidationRule[]

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

  • $_validatePresent protected
    bool|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() public 

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

Устанавливает ValidationRule $rule с $name

Пример:

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

Параметры

string $name

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

Cake\Validation\ValidationRule|array $rule

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

Возвращает

$this

allowEmpty() public 

allowEmpty(bool|string|callable $allowEmpty): $this

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

Параметры

bool|string|callable $allowEmpty

Допустимые значения: true, false, 'create', 'update' или вызываемая функция.

Возвращает

$this

count() public 

count(): int

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

Возвращает

int

getIterator() public 

getIterator(): Cake\Validation\ValidationRule[]

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

Возвращает

Cake\Validation\ValidationRule[]

isEmptyAllowed() public 

isEmptyAllowed(): bool|string|callable

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

Возвращает

bool|string|callable

isPresenceRequired() public 

isPresenceRequired(): bool|string|callable

Возвращает, обязательно ли присутствие поля.

Возвращает

bool|string|callable

offsetExists() public 

offsetExists(string $index): bool

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

Параметры

string $index

имя правила

Возвращает

bool

offsetGet() public 

offsetGet(string $index): Cake\Validation\ValidationRule

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

Параметры

string $index

имя правила

Возвращает

Cake\Validation\ValidationRule

offsetSet() public 

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

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

Параметры

string $index

имя правила

Cake\Validation\ValidationRule|array $rule

Правило для добавления в $index

Возвращает

void

offsetUnset() public 

offsetUnset(string $index): void

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

Параметры

string $index

имя правила

Возвращает

void

remove() public 

remove(string $name): $this

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

Пример:

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

Параметры

string $name

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

Возвращает

$this

requirePresence() public 

requirePresence(bool|string|callable $validatePresent): $this

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

Параметры

bool|string|callable $validatePresent

Допустимые значения: true, false, 'create', 'update' или вызываемая функция.

Возвращает

$this

rule() public 

rule(string $name): Cake\Validation\ValidationRule|null

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

Параметры

string $name

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

Возвращает

Cake\Validation\ValidationRule|null

rules() public 

rules(): Cake\Validation\ValidationRule[]

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

Возвращает

Cake\Validation\ValidationRule[]

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

$_allowEmpty protected

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

Тип

bool|string|callable

$_rules protected

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

Тип

Cake\Validation\ValidationRule[]

$_validatePresent protected

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

Тип

bool|string|callable

© 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/4.2/class-Cake.Validation.ValidationSet.html

Spec-Zone.ru

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