ExecutionContext
class ExecutionContext implements ExecutionContextInterface
Контекст, используемый и создаваемый {@link ExecutionContextFactory}.
Methods
| __construct(ValidatorInterface $validator, mixed $root, TranslatorInterface $translator, string $translationDomain = null) Создаёт новый контекст выполнения. | ||
| setNode(mixed $value, object|null $object, MetadataInterface $metadata = null, string $propertyPath) Устанавливает значение, в данный момент валидируемое. | ||
| setGroup(string|null $group) Устанавливает текущую группу валидации. | ||
| setConstraint(Constraint $constraint) Устанавливает текущее ограничение валидации. | ||
| addViolation(string $message, array $parameters = array()) Добавляет нарушение в текущем узле графа валидации. | ||
| ConstraintViolationBuilderInterface | buildViolation(string $message, array $parameters = array()) Возвращает билдер для добавления нарушения с расширенной информацией. | |
| ConstraintViolationListInterface | getViolations() Возвращает нарушения, сгенерированные валидатором до сих пор. | |
| ValidatorInterface | getValidator() Возвращает валидатор. | |
| mixed | getRoot() Возвращает значение, в котором началась валидация в графе объекта. | |
| mixed | getValue() Возвращает значение, которое в данный момент валидирует валидатор. | |
| object|null | getObject() Возвращает текущий валидируемый объект. | |
| MetadataInterface|null | getMetadata() Возвращает метаданные для текущего валидируемого значения. | |
| string | getGroup() Возвращает группу валидации, которая в данный момент валидируется. | |
| getConstraint() | ||
| string|null | getClassName() Возвращает имя класса текущего узла. | |
| string|null | getPropertyName() Возвращает имя свойства текущего узла. | |
| string | getPropertyPath(string $subPath = '') Возвращает путь к свойству значения, которое в данный момент валидирует валидатор. | |
| 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) Возвращает, был ли объект инициализирован. |
Details
__construct(ValidatorInterface $validator, mixed $root, TranslatorInterface $translator, string $translationDomain = null)
Создаёт новый контекст выполнения.
Параметры
| ValidatorInterface | $validator | Валидатор |
| mixed | $root | Корневое значение графа валидируемого объекта |
| TranslatorInterface | $translator | Переводчик |
| string | $translationDomain | Домен перевода для использования при переводе сообщений об ошибках |
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 | Валидируемое ограничение |
addViolation(string $message, array $parameters = array())
Добавляет нарушение в текущем узле графа валидации.
Параметры
| string | $message | Сообщение об ошибке |
| array | $parameters |
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 | Билдер нарушения |
ConstraintViolationListInterface getViolations()
Возвращает нарушения, сгенерированные валидатором до сих пор.
Возвращаемое значение
| ConstraintViolationListInterface | Список нарушений ограничений |
ValidatorInterface getValidator()
Возвращает валидатор.
Полезно, если нужно валидировать дополнительные ограничения:
public function validate($value, Constraint $constraint)
{
$validator = $this->context->getValidator();
$violations = $validator->validate($value, new Length(array('min' => 3)));
if (count($violations) > 0) {
// ...
}
}
Возвращаемое значение
| ValidatorInterface |
mixed getRoot()
Возвращает значение, в котором началась валидация в графе объектов.
Валидатор, когда получает объект, просматривает свойства и связанные объекты, а также их свойства. Корень валидации — это объект, с которого начался обход.
Текущее значение возвращается методом {@link getValue}.
Возвращаемое значение
| mixed | Корневое значение валидации |
mixed getValue()
Возвращает значение, которое валидатор в настоящее время валидирует.
Если нужно получить объект, который изначально был передан валидатору, используйте {@link getRoot}.
Возвращаемое значение
| mixed | В настоящее время валидируемое значение |
object|null getObject()
Возвращает текущий валидируемый объект.
Если валидатор в настоящее время валидирует ограничение класса, возвращается объект этого класса. Если он валидирует свойство или ограничение геттера, возвращается объект, к которому принадлежит свойство/геттер.
В других случаях возвращается null.
Возвращаемое значение
| object|null | Текущий валидируемый объект или null |
MetadataInterface|null getMetadata()
Возвращает метаданные для текущего валидируемого значения.
В реализации по умолчанию этот метод возвращает экземпляр {@link Mapping\ClassMetadataInterface}, если текущее значение является объектом, экземпляр {@link Mapping\PropertyMetadata}, если текущее значение является значением свойства, и экземпляр {@link Mapping\GetterMetadata}, если валидируемое значение является результатом метода геттера.
Если валидируемое значение не относится ни к одному из этих типов, например, если валидатор был вызван со значениями и ограничениями без объекта, этот метод возвращает null.
Возвращаемое значение
| MetadataInterface|null | метаданные текущего валидируемого значения |
string getGroup()
Возвращает группу валидации, которая в настоящее время валидируется.
Возвращаемое значение
| string | Текущая группа валидации |
getConstraint()
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 | Текущий путь к свойству. Результат может быть пустой строкой, если валидатор в настоящее время валидирует корневое значение графа валидации. |
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 | Хэш объекта |
bool isObjectInitialized(string $cacheKey)
Возвращает, был ли объект инициализирован.
Параметры
| string | $cacheKey | Хэш объекта |
Значение возврата
| bool | Был ли объект уже инициализирован |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Validator/Context/ExecutionContext.html