Spec-Zone.ru › Symfony 3.2

ExecutionContext deprecated

class ExecutionContext implements ExecutionContextInterface

deprecated

since version 2.5, to be removed in 3.0. Use {@link Context\ExecutionContext} instead.

Стандартная реализация {@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');

Параметры

mixed $value Значение для проверки.
Constraint|Constraint[] $constraints Ограничение(ия) для проверки.
string $subPath Путь, который нужно добавить к пути свойства контекста.
null|string|string[] $groups Группы для проверки. Если вы не передадите группы, будет использована текущая группа контекста.

MetadataFactoryInterface getMetadataFactory()

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

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

MetadataFactoryInterface Фабрика метаданных.

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

Spec-Zone.ru

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