interface ValidationVisitorInterface

deprecated since version 2.5, to be removed in 3.0.

Validates values against constraints defined in {@link MetadataInterface} instances.

This interface is an implementation of the Visitor design pattern. A value is validated by first passing it to the {@link validate} method. That method will determine the matching {@link MetadataInterface} for validating the value. It then calls the {@link MetadataInterface::accept} method of that metadata. accept() does two things:

  1. It calls {@link visit} to validate the value against the constraints of the metadata.
  2. It calls accept() on all nested metadata instances with the corresponding values extracted from the current value. For example, if the current metadata represents a class and the current value is an object of that class, the metadata contains nested instances for each property of that class. It forwards the call to these nested metadata with the values of the corresponding properties in the original object.

Methods

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

Validates a value.

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

Validates a value against the constraints defined in some metadata.

Details

at line 68
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

Exceptions

NoSuchMetadataException if no metadata can be found for the given value

at line 81
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