Spec-Zone.ru › CakePHP 3.3

Трейт ValidatorAwareTrait

Трейт, предоставляющий методы для создания и взаимодействия с валидаторами.

Этот трейт полезен при создании функций типа ORM, где реализующий класс хочет создавать и настраивать различные экземпляры валидаторов.

Этот трейт ожидает, что классы, включающие его, определят две константы:

  • DEFAULT_VALIDATOR - Имя валидатора по умолчанию.
  • VALIDATOR_PROVIDER_NAME - Имя провайдера, присвоенного реализующему классу в валидаторах.

Если реализующий класс также реализует события, то событие Model.buildValidator будет срабатывать при создании валидаторов.

Непосредственные пользователи

  • Cake\ORM\Table
Пространство имен: Cake\Validation
Расположение: Validation/ValidatorAwareTrait.php

Резюме свойств

  • $_validatorClass protected
    string
    Класс валидатора.
  • $_validators protected
    array
    Список объектов валидации, индексированных по имени

Резюме методов

  • validationDefault() public

    Возвращает объект валидатора по умолчанию. Подклассы могут переопределить эту функцию, чтобы добавить набор правил валидации по умолчанию к объекту валидатора.

  • validator() public

    Возвращает правила валидации, помеченные тегом $name. Можно иметь несколько наборов валидации с разными именами, это полезно, когда необходимо использовать разные правила при сохранении из разных процедур в вашей системе.

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

validationDefault()source public

validationDefault( Cake\Validation\Validator $validator )

Возвращает объект валидатора по умолчанию. Подклассы могут переопределить эту функцию, чтобы добавить набор правил валидации по умолчанию к объекту валидатора.

Параметры

Cake\Validation\Validator $validator

Валидатор, который можно изменить, чтобы добавить к нему некоторые правила.

Возвращает

Cake\Validation\Validator

validator()source public

validator( string|null $name null , Cake\Validation\Validator $validator null )

Возвращает правила валидации, помеченные тегом $name. Можно иметь несколько наборов валидации с разными именами, это полезно, когда необходимо использовать разные правила при сохранении из разных процедур в вашей системе.

Существует два способа создания и именования наборов валидации: создание нового метода в собственном подклассе Table или построение объекта валидатора самостоятельно и сохранение его с помощью этого метода.

Например, если вы хотите создать набор валидации под названием 'forSubscription', вам нужно создать метод в подклассе Table следующим образом:

public function validationForSubscription($validator)
{
 return $validator
 ->add('email', 'valid-email', ['rule' => 'email'])
 ->add('password', 'valid', ['rule' => 'notBlank'])
 ->requirePresence('username');
}

В противном случае, вы можете самостоятельно построить объект и сохранить его в объекте Table:

$validator = new \Cake\Validation\Validator($table);
$validator
 ->add('email', 'valid-email', ['rule' => 'email'])
 ->add('password', 'valid', ['rule' => 'notBlank'])
 ->allowEmpty('bio');
$table->validator('forSubscription', $validator);

Вы можете реализовать метод в validationDefault в подклассе Table, если хотите иметь набор валидации, который применяется в случаях, когда не указан другой набор.

Параметры

string|null $name необязательно null
имя набора валидации для возврата
Cake\Validation\Validator $validator необязательно null

Экземпляр валидатора для сохранения, используйте null для получения валидатора.

Возвращает

Cake\Validation\Validator

Исключения

RuntimeException

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

$_validatorClasssource

protected string

Класс валидатора.

'\Cake\Validation\Validator'

$_validatorssource

protected array

Список объектов валидации, индексированных по имени

[]

© 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.3/class-Cake.Validation.ValidatorAwareTrait.html

Spec-Zone.ru

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