interface MetadataInterface

deprecated since version 2.5, to be removed in 3.0. Use {@link Mapping\MetadataInterface} instead.

A container for validation metadata.

The container contains constraints that may belong to different validation groups. Constraints for a specific group can be fetched by calling {@link findConstraints}.

Implement this interface to add validation metadata to your own metadata layer. Each metadata may have named properties. Each property can be represented by one or more {@link PropertyMetadataInterface} instances that are returned by {@link getPropertyMetadata}. Since PropertyMetadataInterface inherits from MetadataInterface, each property may be divided into further properties.

The {@link accept} method of each metadata implements the Visitor pattern. The method should forward the call to the visitor's {@link ValidationVisitorInterface::visit} method and additionally call accept() on all structurally related metadata instances.

For example, to store constraints for PHP classes and their properties, create a class ClassMetadata (implementing MetadataInterface) and a class PropertyMetadata (implementing PropertyMetadataInterface). ClassMetadata::getPropertyMetadata($property) returns all PropertyMetadata instances for a property of that class. Its accept()-method simply forwards to ValidationVisitorInterface::visit() and calls accept() on all contained PropertyMetadata instances, which themselves call ValidationVisitorInterface::visit() again.

Methods

accept(ValidationVisitorInterface $visitor, mixed $value, string|string[] $group, string $propertyPath) deprecated

Implementation of the Visitor design pattern.

findConstraints(string $group)

Returns all constraints for a given validation group.

Details

at line 63
accept(ValidationVisitorInterface $visitor, mixed $value, string|string[] $group, string $propertyPath) deprecated

deprecated since version 2.5, to be removed in 3.0.

Implementation of the Visitor design pattern.

Calls {@link ValidationVisitorInterface::visit} and then forwards the accept()-call to all property metadata instances.

Parameters

ValidationVisitorInterface $visitor The visitor implementing the validation logic
mixed $value The value to validate
string|string[] $group The validation group to validate in
string $propertyPath The current property path in the validation graph

at line 72
Constraint[] findConstraints(string $group)

Returns all constraints for a given validation group.

Parameters

string $group The validation group

Return Value

Constraint[] A list of constraint instances