Spec-Zone.ru › Symfony 3.4

ExecutionContextInterface

интерфейс ExecutionContextInterface

Контекст выполнения валидации.

Контекст собирает все нарушения, сгенерированные во время валидации. По умолчанию, валидаторы выполняют все валидации в новом контексте:

$violations = $validator->validate($object);

Когда вы вызываете валидатор повторно, пока валидация ещё в процессе, нарушения будут изолированы друг от друга:

public function validate($value, Constraint $constraint)
{
    $validator = $this->context->getValidator();

    // The violations are not added to $this->context
    $violations = $validator->validate($value);
}

Однако, если вы хотите добавить нарушения в текущий контекст, используйте метод {@link ValidatorInterface::inContext()}:

public function validate($value, Constraint $constraint)
{
    $validator = $this->context->getValidator();

    // The violations are added to $this->context
    $validator
        ->inContext($this->context)
        ->validate($value)
    ;
}

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

Методы

addViolation(string $message, array $params = array())

Добавляет нарушение в текущем узле графа валидации.

ConstraintViolationBuilderInterface buildViolation(string $message, array $parameters = array())

Возвращает билдер для добавления нарушения с расширенной информацией.

ValidatorInterface getValidator()

Возвращает валидатор.

object|null getObject()

Возвращает текущий проверяемый объект.

setNode(mixed $value, object|null $object, MetadataInterface $metadata = null, string $propertyPath)

Устанавливает текущее проверяемое значение.

setGroup(string|null $group)

Устанавливает текущую группу валидации.

setConstraint(Constraint $constraint)

Устанавливает текущее проверяемое ограничение.

markGroupAsValidated(string $cacheKey, string $groupHash)

Помечает объект как проверенный в определённой группе валидации.

bool isGroupValidated(string $cacheKey, string $groupHash)

Возвращает, был ли объект проверен в определённой группе валидации.

markConstraintAsValidated(string $cacheKey, string $constraintHash)

Помечает ограничение как проверенное для объекта.

bool isConstraintValidated(string $cacheKey, string $constraintHash)

Возвращает, было ли ограничение проверено для объекта.

markObjectAsInitialized(string $cacheKey)

Помечает, что объект был инициализирован.

bool isObjectInitialized(string $cacheKey)

Возвращает, был ли объект инициализирован.

ConstraintViolationListInterface getViolations()

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

mixed getRoot()

Возвращает значение, с которого началась валидация в графе объекта.

mixed getValue()

Возвращает значение, которое в данный момент проверяет валидатор.

MetadataInterface|null getMetadata()

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

string getGroup()

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

string|null getClassName()

Возвращает имя класса текущего узла.

string|null getPropertyName()

Возвращает имя свойства текущего узла.

string getPropertyPath(string $subPath = '')

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

Подробности

addViolation(string $message, array $params = array())

Добавляет нарушение в текущем узле графа валидации.

Параметры

string $message Текст сообщения об ошибке
array $params Параметры, подставляемые в сообщение об ошибке

ConstraintViolationBuilderInterface buildViolation(string $message, array $parameters = array())

Возвращает конструктор для добавления нарушения с дополнительной информацией.

Вызовите {@link ConstraintViolationBuilderInterface::addViolation()} для добавления нарушения после завершения настройки:

$context->buildViolation('Please enter a number between %min% and %max%.')
    ->setParameter('%min%', 3)
    ->setParameter('%max%', 10)
    ->setTranslationDomain('number_validation')
    ->addViolation();

Параметры

string $message Текст сообщения об ошибке
array $parameters Параметры, подставляемые в сообщение об ошибке

Значение возврата

ConstraintViolationBuilderInterface Конструктор нарушения

ValidatorInterface getValidator()

Возвращает валидатор.

Полезно, если нужно валидировать дополнительные ограничения:

public function validate($value, Constraint $constraint)
{
    $validator = $this->context->getValidator();

    $violations = $validator->validateValue($value, new Length(array('min' => 3)));

    if (count($violations) > 0) {
        // ...
    }
}

Значение возврата

ValidatorInterface

object|null getObject()

Возвращает текущий валидируемый объект.

Если валидатор в настоящее время валидирует ограничение класса, возвращается объект этого класса. Если валидируется ограничение свойства или геттера, возвращается объект, к которому принадлежит свойство/геттер.

В других случаях возвращается null.

Значение возврата

object|null Текущий валидируемый объект или null

setNode(mixed $value, object|null $object, MetadataInterface $metadata = null, string $propertyPath)

Устанавливает текущее значение для валидации.

Параметры

mixed $value Валидируемое значение
object|null $object Текущий валидируемый объект
MetadataInterface $metadata Данные метаданных валидации
string $propertyPath Путь к свойству текущего значения

setGroup(string|null $group)

Устанавливает текущую группу валидации.

Параметры

string|null $group Валидируемая группа

setConstraint(Constraint $constraint)

Устанавливает текущее ограничение для валидации.

Параметры

Constraint $constraint Валидируемое ограничение

markGroupAsValidated(string $cacheKey, string $groupHash)

Помечает объект как проверенный в определенной группе валидации.

Параметры

string $cacheKey Хеш объекта
string $groupHash Имя или хеш группы, если это последовательность групп

bool isGroupValidated(string $cacheKey, string $groupHash)

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

Параметры

string $cacheKey Хеш объекта
string $groupHash Имя или хеш группы, если это последовательность групп

Значение возврата

bool Был ли объект уже проверен для этой группы

markConstraintAsValidated(string $cacheKey, string $constraintHash)

Помечает ограничение как проверенное для объекта.

Параметры

string $cacheKey Хеш объекта
string $constraintHash Хеш ограничения

bool isConstraintValidated(string $cacheKey, string $constraintHash)

Возвращает, было ли ограничение проверено для объекта.

Параметры

string $cacheKey Хеш объекта
string $constraintHash Хеш ограничения

Значение возврата

bool Было ли ограничение уже проверено

markObjectAsInitialized(string $cacheKey)

Помечает, что объект был инициализирован.

Параметры

string $cacheKey Хеш объекта

См. также

ObjectInitializerInterface

bool isObjectInitialized(string $cacheKey)

Возвращает, был ли объект инициализирован.

Параметры

string $cacheKey Хеш объекта

Значение возврата

bool Был ли объект уже инициализирован

См. также

ObjectInitializerInterface

ConstraintViolationListInterface getViolations()

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

Значение возврата

ConstraintViolationListInterface Список нарушений ограничений

mixed getRoot()

Возвращает значение, с которого началась валидация в графе объекта.

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

Текущее значение возвращается методом {@link getValue}.

Значение возврата

mixed Корневое значение валидации

mixed getValue()

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

Если нужно получить объект, который был первоначально передан валидатору, используйте {@link getRoot}.

Значение возврата

mixed Валидируемое значение

MetadataInterface|null getMetadata()

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

В реализации по умолчанию этот метод возвращает экземпляр {@link Mapping\ClassMetadataInterface}, если текущее значение является объектом, экземпляр {@link Mapping\PropertyMetadata}, если текущее значение — значение свойства, и экземпляр {@link Mapping\GetterMetadata}, если валидируемое значение является результатом метода-геттера.

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

Значение возврата

MetadataInterface|null метаданные текущего валидируемого значения

string getGroup()

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

Значение возврата

string Текущая группа валидации

string|null getClassName()

Возвращает имя класса текущего узла.

Если метаданные текущего узла не реализуют {@link Mapping\ClassMetadataInterface} или если метаданные недоступны для текущего узла, этот метод возвращает null.

Значение возврата

string|null Имя класса или null, если имя класса не найдено

string|null getPropertyName()

Возвращает имя свойства текущего узла.

Если метаданные текущего узла не реализуют {@link PropertyMetadataInterface} или если метаданные недоступны для текущего узла, этот метод возвращает null.

Значение возврата

string|null Имя свойства или null, если имя свойства не найдено

string getPropertyPath(string $subPath = '')

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

Например, рассмотрим следующую схему объекта:

(Person)---($address: Address)---($street: string)

Когда экземпляр Person передаётся валидатору, путь к свойству изначально пустой. Когда свойство $address этого человека валидируется, путь к свойству становится "address". Когда свойство $street связанного экземпляра Address валидируется, путь к свойству становится "address.street".

Свойства объектов имеют префикс точки в пути к свойству. Индексы массивов или объектов, реализующих интерфейс {@link \ArrayAccess}, заключены в квадратные скобки. Например, если свойство в предыдущем примере — $addresses и содержит массив экземпляров Address, путь к свойству $street одного из этих адресов будет, например, "addresses[0].street".

Параметры

string $subPath Необязательно. Приставка, добавляемая к текущему пути к свойству.

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

string Текущий путь к свойству. Результат может быть пустой строкой, если валидатор в данный момент проверяет корневое значение графа валидации.

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.4/Symfony/Component/Validator/Context/ExecutionContextInterface.html

Spec-Zone.ru

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