Spec-Zone.ru › CakePHP 4.4

Класс ValidationSet

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

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

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

  • $_allowEmpty protected
    callable|string|bool

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

  • $_rules protected
    arrayCake\Validation\ValidationRule>

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

  • $_validatePresent protected
    callable|string|bool

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

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

  • add()public

    Устанавливает правило валидации $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

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

Пример:

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

Параметры

string$name

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

Cake\Validation\ValidationRule|array$rule

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

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

$this$

allowEmpty() public

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

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

Параметры

callable|string|bool$allowEmpty

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

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

$this$

count() public

count(): int

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

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

int$

getIterator() public

getIterator(): Traversable<string,Cake\Validation\ValidationRule>

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

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

Traversable<string,Cake\Validation\ValidationRule>$

isEmptyAllowed() public

isEmptyAllowed(): callable|string|bool

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

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

callable|string|bool$

isPresenceRequired() public

isPresenceRequired(): callable|string|bool

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

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

callable|string|bool$

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(callable|string|bool $validatePresent): $this

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

Параметры

callable|string|bool$validatePresent

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

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

$this$

rule() public

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

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

Параметры

string$name

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

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

Cake\Validation\ValidationRule|null$

rules() public

rules(): arrayCake\Validation\ValidationRule>

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

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

arrayCake\Validation\ValidationRule>$

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

$_allowEmpty protected

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

Тип

callable|string|bool$

$_rules protected

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

Тип

arrayCake\Validation\ValidationRule>$

$_validatePresent protected

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

Тип

callable|string|bool$

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

Spec-Zone.ru

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