ValidationVisitor deprecated

class ValidationVisitor implements ValidationVisitorInterface, GlobalExecutionContextInterface

^deprecated

since version 2.5, to be removed in 3.0.

Default implementation of {@link ValidationVisitorInterface} and {@link GlobalExecutionContextInterface}.

Methods

	__construct(mixed $root, MetadataFactoryInterface $metadataFactory, ConstraintValidatorFactoryInterface $validatorFactory, TranslatorInterface $translator, string\|null $translationDomain = null, array $objectInitializers = array()) Creates a new validation visitor.
	visit(MetadataInterface $metadata, mixed $value, string $group, string $propertyPath) Validates a value against the constraints defined in some metadata.
	validate(mixed $value, string $group, string $propertyPath, bool $traverse = false, bool $deep = false) Validates a value.
ConstraintViolationListInterface	getViolations() Returns the violations generated by the validator so far.
mixed	getRoot() Returns the value at which validation was started in the object graph.
ValidationVisitorInterface	getVisitor() Returns the visitor instance used to validate the object graph nodes.
ConstraintValidatorFactoryInterface	getValidatorFactory() Returns the factory for constraint validators.
MetadataFactoryInterface	getMetadataFactory() Returns the factory for validation metadata objects.

Details

__construct(mixed $root, MetadataFactoryInterface $metadataFactory, ConstraintValidatorFactoryInterface $validatorFactory, TranslatorInterface $translator, string|null $translationDomain = null, array $objectInitializers = array())

Creates a new validation visitor.

Parameters

mixed	$root	The value passed to the validator.
MetadataFactoryInterface	$metadataFactory	The factory for obtaining metadata instances.
ConstraintValidatorFactoryInterface	$validatorFactory	The factory for creating constraint validators.
TranslatorInterface	$translator	The translator for translating violation messages.
string\|null	$translationDomain	The domain of the translation messages.
array	$objectInitializers	The initializers for preparing objects before validation.

Exceptions

UnexpectedTypeException

If any of the object initializers is not an instance of ObjectInitializerInterface

visit(MetadataInterface $metadata, mixed $value, string $group, string $propertyPath)

Validates a value against the constraints defined in some metadata.

This method implements the Visitor design pattern. See also {@link ValidationVisitorInterface}.

Parameters

MetadataInterface	$metadata	The metadata holding the constraints.
mixed	$value	The value to validate.
string	$group	The validation group to validate.
string	$propertyPath	The current property path in the validation graph.

validate(mixed $value, string $group, string $propertyPath, bool $traverse = false, bool $deep = false)

Validates a value.

If the value is an array or a traversable object, you can set the parameter $traverse to true in order to run through the collection and validate each element. If these elements can be collections again and you want to traverse them recursively, set the parameter $deep to true as well.

If you set $traversable to true, the visitor will nevertheless try to find metadata for the collection and validate its constraints. If no such metadata is found, the visitor ignores that and only iterates the collection.

If you don't set $traversable to true and the visitor does not find metadata for the given value, it will fail with an exception.

Parameters

mixed	$value	The value to validate.
string	$group	The validation group to validate.
string	$propertyPath	The current property path in the validation graph.
bool	$traverse	Whether to traverse the value if it is traversable.
bool	$deep	Whether to traverse nested traversable values recursively.