ExecutionContext deprecated
class ExecutionContext implements ExecutionContextInterface
deprecated
Стандартная реализация {@link ExecutionContextInterface}.
Этот класс неизменяемый по своей конструкции.
Методы
| __construct(GlobalExecutionContextInterface $globalContext, TranslatorInterface $translator, null|string $translationDomain = null, MetadataInterface $metadata = null, mixed $value = null, string $group = null, string $propertyPath = '') Создаёт новый контекст выполнения. | ||
| addViolation(string $message, array $params = array(), mixed $invalidValue = null, int|null $plural = null, int|null $code = null) Добавляет нарушение в текущем узле графа валидации. | ||
| addViolationAt(string $subPath, string $message, array $parameters = array(), mixed $invalidValue = null, int|null $plural = null, int|null $code = null) Добавляет нарушение в узле графа валидации с заданным путём свойства относительно текущего пути свойства. | ||
| ConstraintViolationListInterface | getViolations() Возвращает нарушения, сгенерированные валидатором до настоящего момента. | |
| mixed | getRoot() Возвращает значение, с которого началась валидация в графе объекта. | |
| string | getPropertyPath(string $subPath = '') Возвращает путь свойства к значению, которое валидатор в настоящее время проверяет. | |
| string|null | getClassName() Возвращает имя класса текущего узла. | |
| string|null | getPropertyName() Возвращает имя свойства текущего узла. | |
| mixed | getValue() Возвращает значение, которое валидатор в настоящее время проверяет. | |
| string | getGroup() Возвращает группу валидации, которая в настоящее время проверяется. | |
| MetadataInterface|null | getMetadata() Возвращает метаданные для текущего проверяемого значения. | |
| getMetadataFor($value) {@inheritdoc} | ||
| validate(mixed $value, string $subPath = '', null|string|string[] $groups = null, bool $traverse = false, bool $deep = false) Проверяет заданное значение в рамках текущей валидации. | ||
| validateValue(mixed $value, Constraint|Constraint[] $constraints, string $subPath = '', null|string|string[] $groups = null) Проверяет значение по ограничению. | ||
| MetadataFactoryInterface | getMetadataFactory() Возвращает используемую фабрику метаданных. |
Подробности
__construct(GlobalExecutionContextInterface $globalContext, TranslatorInterface $translator, null|string $translationDomain = null, MetadataInterface $metadata = null, mixed $value = null, string $group = null, string $propertyPath = '')
Создаёт новый контекст выполнения.
Параметры
| GlobalExecutionContextInterface | $globalContext | Глобальный контекст, хранящий состояние, не зависящее от узлов. |
| TranslatorInterface | $translator | Переводчик для перевода сообщений о нарушениях. |
| null|string | $translationDomain | Домен сообщений валидации. |
| MetadataInterface | $metadata | Метаданные проверяемого узла. |
| mixed | $value | Значение проверяемого узла. |
| string | $group | Текущая группа валидации. |
| string | $propertyPath | Путь к свойству текущего узла. |
addViolation(string $message, array $params = array(), mixed $invalidValue = null, int|null $plural = null, int|null $code = null)
Добавляет нарушение в текущем узле графа валидации.
Примечание: параметры $invalidValue, $plural и $code устарели начиная с версии 2.5 и будут удалены в версии 3.0.
Параметры
| string | $message | Сообщение об ошибке |
| array | $params | Параметры, подставляемые в сообщение об ошибке |
| mixed | $invalidValue | Неверное, проверенное значение |
| int|null | $plural | Число для множественного числа сообщения |
| int|null | $code | Код нарушения |
addViolationAt(string $subPath, string $message, array $parameters = array(), mixed $invalidValue = null, int|null $plural = null, int|null $code = null)
Добавляет нарушение в узле графа валидации по заданному пути свойства относительно текущего пути свойства.
Параметры
| string | $subPath | Относительный путь к свойству для нарушения |
| string | $message | Сообщение об ошибке |
| array | $parameters | Параметры, подставляемые в сообщение об ошибке |
| mixed | $invalidValue | Неверное, проверенное значение |
| int|null | $plural | Число для множественного числа сообщения |
| int|null | $code | Код нарушения |
ConstraintViolationListInterface getViolations()
Возвращает нарушения, сгенерированные валидатором до настоящего момента.
Значение, возвращаемое функцией
| ConstraintViolationListInterface | Список нарушений. |
mixed getRoot()
Возвращает значение, с которого началась валидация в объектной графе.
Валидатор, получив объект, проходит по свойствам и связанным объектам и их свойствам. Корень валидации — это объект, с которого начался обход.
Текущее значение возвращается методом {@link getValue}.
Значение, возвращаемое функцией
| mixed | Корневое значение валидации. |
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 | Текущий путь к свойству. Результатом может быть пустая строка, если валидатор в данный момент проверяет корневое значение графа валидации. |
string|null getClassName()
Возвращает имя класса текущего узла.
Если метаданные текущего узла не реализуют {@link ClassBasedInterface} или если метаданные недоступны для текущего узла, этот метод возвращает null.
Значение, возвращаемое функцией
| string|null | Имя класса или null, если имя класса найти не удалось. |
string|null getPropertyName()
Возвращает имя свойства текущего узла.
Если метаданные текущего узла не реализуют {@link PropertyMetadataInterface} или если метаданные недоступны для текущего узла, этот метод возвращает null.
Значение, возвращаемое функцией
| string|null | Имя свойства или null, если имя свойства найти не удалось. |
mixed getValue()
Возвращает значение, которое в данный момент проверяет валидатор.
Если вы хотите получить объект, который изначально был передан валидатору, используйте {@link getRoot}.
Значение, возвращаемое функцией
| mixed | Текущее проверяемое значение. |
string getGroup()
Возвращает группу валидации, которая в данный момент проверяется.
Значение, возвращаемое функцией
| string | Текущая группа валидации. |
MetadataInterface|null getMetadata()
Возвращает метаданные для текущего проверяемого значения.
В реализации по умолчанию этот метод возвращает экземпляр {@link Mapping\ClassMetadata}, если текущее значение — объект, экземпляр {@link Mapping\PropertyMetadata}, если текущее значение — значение свойства, и экземпляр {@link Mapping\GetterMetadata}, если проверяемое значение — результат вызова метода-геттера.
Если проверяемое значение не относится ни к одному из этих типов, например, если валидатор был вызван со значением и ограничением, этот метод возвращает null.
Значение, возвращаемое функцией
| MetadataInterface|null | Метаданные текущего проверяемого значения. |
getMetadataFor($value)
{@inheritdoc}
Параметры
| $value |
validate(mixed $value, string $subPath = '', null|string|string[] $groups = null, bool $traverse = false, bool $deep = false)
Проверяет заданное значение в рамках текущей валидации.
Значение может быть любым значением, распознаваемым фабрикой метаданных (см. {@link MetadataFactoryInterface::getMetadata}), или массивом или итерируемым объектом таких значений.
Обычно вы проверяете значение, которое не является текущим узлом контекста выполнения. В этом случае вы можете передать аргумент {@link $subPath}, который добавляется к текущему пути к свойству при создании нарушения. Например, рассмотрим следующую объектную графу:
(Person)---($address: Address)---($phoneNumber: PhoneNumber)
^
Когда контекст выполнения останавливается на экземпляре Person, путь к свойству — "address". Теперь при проверке экземпляра PhoneNumber передайте "phoneNumber" в качестве подпути, чтобы исправить путь к свойству на "address.phoneNumber":
$context->validate($address->phoneNumber, 'phoneNumber');
Любые нарушения, сгенерированные во время проверки, будут добавлены в список нарушений, к которому вы можете получить доступ с помощью {@link getViolations}.
Параметры
| mixed | $value | Значение для проверки. |
| string | $subPath | Путь для добавления к пути свойства контекста. |
| null|string|string[] | $groups | Группы для проверки. Если вы не передаёте никаких групп, будет использоваться текущая группа контекста. |
| bool | $traverse | Итерировать значение, если это массив или экземпляр \Traversable. |
| bool | $deep | Итерировать значение рекурсивно, если это коллекция коллекций. |
validateValue(mixed $value, Constraint|Constraint[] $constraints, string $subPath = '', null|string|string[] $groups = null)
Проверяет значение по ограничению.
Используйте параметр $subPath для адаптации пути к свойству для проверяемого значения. Например, рассмотрим следующую объектную графу:
(Person)---($address: Address)---($street: string)
^
Когда валидатор проверяет экземпляр Address, путь к свойству, хранящийся в контексте выполнения, — "address". Когда вы вручную проверяете свойство $street сейчас, передайте подпуть "street", чтобы адаптировать полный путь к свойству до "address.street":
$context->validate($address->street, new NotNull(), 'street');
Параметры
| смешанный тип | $value | Значение для проверки. |
| Constraint|Constraint[] | $constraints | Ограничения для проверки. |
| строка | $subPath | Путь для добавления к пути свойства контекста. |
| null|строка|массив строк | $groups | Группы для проверки. Если вы не передадите группы, будет использоваться текущая группа контекста. |
MetadataFactoryInterface getMetadataFactory()
Возвращает используемую фабрику метаданных.
Возвращаемое значение
| MetadataFactoryInterface | Фабрика метаданных. |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.4/Symfony/Component/Validator/ExecutionContext.html