interface ClassMetadataInterface implementsMetadataInterface

Stores all metadata needed for validating objects of specific class.

Most importantly, the metadata stores the constraints against which an object and its properties should be validated.

Additionally, the metadata stores whether the "Default" group is overridden by a group sequence for that class and whether instances of that class should be traversed or not.

Methods

int
getCascadingStrategy()

Returns the strategy for cascading objects.

int
getTraversalStrategy()

Returns the strategy for traversing traversable objects.

array
getConstraints()

Returns all constraints of this element.

array
findConstraints(string$group)

Returns all constraints for a given validation group.

array
getConstrainedProperties()

Returns the names of all constrained properties.

bool
hasGroupSequence()

Returns whether the "Default" group is overridden by a group sequence.

GroupSequence|null
getGroupSequence()

Returns the group sequence that overrides the "Default" group for this class.

bool
isGroupSequenceProvider()

Returns whether the "Default" group is overridden by a dynamic group sequence obtained by the validated objects.

bool
hasPropertyMetadata(string$property)

Check if there's any metadata attached to the given named property.

array
getPropertyMetadata(string$property)

Returns all metadata instances for the given named property.

string
getClassName()

Returns the name of the backing PHP class.

string|null
getGroupProvider()

No description

Details

int getCascadingStrategy()

Returns the strategy for cascading objects.

Return Value

int

See also

CascadingStrategy

int getTraversalStrategy()

Returns the strategy for traversing traversable objects.

Return Value

int

See also

TraversalStrategy

array getConstraints()

Returns all constraints of this element.

Return Value

array

array findConstraints(string$group)

Returns all constraints for a given validation group.

Parameters

string $group The validation group

Return Value

array

array getConstrainedProperties()

Returns the names of all constrained properties.

Return Value

array

bool hasGroupSequence()

Returns whether the "Default" group is overridden by a group sequence.

If it is, you can access the group sequence with {@link getGroupSequence()}.

Return Value

bool

GroupSequence|null getGroupSequence()

Returns the group sequence that overrides the "Default" group for this class.

Return Value

GroupSequence|null

bool isGroupSequenceProvider()

Returns whether the "Default" group is overridden by a dynamic group sequence obtained by the validated objects.

If this method returns true, the class must implement {@link GroupSequenceProviderInterface}. This interface will be used to obtain the group sequence when an object of this class is validated.

Return Value

bool

bool hasPropertyMetadata(string$property)

Check if there's any metadata attached to the given named property.

Parameters

string $property The property name

Return Value

bool

array getPropertyMetadata(string$property)

Returns all metadata instances for the given named property.

If your implementation does not support properties, throw an exception in this method (for example a BadMethodCallException).

Parameters

string $property The property name

Return Value

array

string getClassName()

Returns the name of the backing PHP class.

Return Value

string

string|null getGroupProvider()

Return Value

string|null