ExecutionContext ^deprecated

__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

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