interface PropertyMetadataInterface implements MetadataInterface, PropertyMetadataInterface, ClassBasedInterface

Stores all metadata needed for validating the value of a class property.

Most importantly, the metadata stores the constraints against which the property's value should be validated.

Additionally, the metadata stores whether objects stored in the property should be validated against their class' metadata and whether traversable objects should be traversed or not.

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.

int
getCascadingStrategy()

Returns the strategy for cascading objects.

int
getTraversalStrategy()

Returns the strategy for traversing traversable objects.

getConstraints()

Returns all constraints of this element.

string
getPropertyName()

Returns the name of the property.

mixed
getPropertyValue(mixed $containingValue)

Extracts the value of the property from the given container.

string
getClassName()

Returns the name of the backing PHP class.

Details

in MetadataInterface 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

in MetadataInterface 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

in MetadataInterface at line 41
int getCascadingStrategy()

Returns the strategy for cascading objects.

Return Value

int The cascading strategy

See also

CascadingStrategy

in MetadataInterface at line 50
int getTraversalStrategy()

Returns the strategy for traversing traversable objects.

Return Value

int The traversal strategy

See also

TraversalStrategy

in MetadataInterface at line 57
Constraint[] getConstraints()

Returns all constraints of this element.

Return Value

Constraint[] A list of Constraint instances

string getPropertyName()

Returns the name of the property.

Return Value

string The property name

mixed getPropertyValue(mixed $containingValue)

Extracts the value of the property from the given container.

Parameters

mixed $containingValue The container to extract the property value from

Return Value

mixed The value of the property

in ClassBasedInterface at line 29
string getClassName()

Returns the name of the backing PHP class.

Return Value

string The name of the backing class