class ClassMetadata extends GenericMetadata implements ClassMetadataInterface

Default implementation of {@link ClassMetadataInterface}.

This class supports serialization and cloning.

Properties

Constraint[] $constraints from GenericMetadata
array $constraintsByGroup from GenericMetadata
int $cascadingStrategy The strategy for cascading objects. from GenericMetadata
int $traversalStrategy The strategy for traversing traversable objects.
string $name
string $defaultGroup
MemberMetadata[] $members
PropertyMetadata[] $properties
GetterMetadata[] $getters
array $groupSequence
bool $groupSequenceProvider

Methods

string[]
__sleep()

Returns the names of the properties that should be serialized.

__clone()

Clones this object.

addConstraint(Constraint $constraint)

Adds a constraint.

addConstraints(array $constraints)

Adds an list of constraints.

getConstraints()

Returns all constraints of this element.

bool
hasConstraints()

Returns whether this element has any constraints.

findConstraints(string $group)

Returns all constraints for a given validation group.

int
getCascadingStrategy()

Class nodes are never cascaded.

int
getTraversalStrategy()

Returns the strategy for traversing traversable objects.

__construct(string $class)

Constructs a metadata for the given class.

string
getClassName()

Returns the name of the backing PHP class.

string
getDefaultGroup()

Returns the name of the default group for this class.

addPropertyConstraint(string $property, Constraint $constraint)

Adds a constraint to the given property.

addPropertyConstraints(string $property, array $constraints)

No description

addGetterConstraint(string $property, Constraint $constraint)

Adds a constraint to the getter of the given property.

addGetterConstraints(string $property, array $constraints)

No description

mergeConstraints(ClassMetadata $source)

Merges the constraints of the given metadata into this object.

bool
hasPropertyMetadata(string $property)

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

getPropertyMetadata(string $property)

Returns all metadata instances for the given named property.

string[]
getConstrainedProperties()

Returns the names of all constrained properties.

setGroupSequence(array $groupSequence)

Sets the default group sequence for this class.

bool
hasGroupSequence()

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

getGroupSequence()

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

getReflectionClass()

Returns a ReflectionClass instance for this class.

setGroupSequenceProvider(bool $active)

Sets whether a group sequence provider should be used.

bool
isGroupSequenceProvider()

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

Details

at line line 131
string[] __sleep()

Returns the names of the properties that should be serialized.

Return Value

string[]

in GenericMetadata at line line 94
__clone()

Clones this object.

at line line 180
GenericMetadata addConstraint(Constraint $constraint)

Adds a constraint.

If the constraint {@link Valid} is added, the cascading strategy will be changed to {@link CascadingStrategy::CASCADE}. Depending on the $traverse property of that constraint, the traversal strategy will be set to one of the following:

  • {@link TraversalStrategy::IMPLICIT} if $traverse is enabled
  • {@link TraversalStrategy::NONE} if $traverse is disabled

Parameters

Constraint $constraint The constraint to add

Return Value

GenericMetadata This object

Exceptions

ConstraintDefinitionException When trying to add the {@link Traverse} constraint

in GenericMetadata at line line 162
GenericMetadata addConstraints(array $constraints)

Adds an list of constraints.

Parameters

array $constraints The constraints to add

Return Value

GenericMetadata This object

in GenericMetadata at line line 174
Constraint[] getConstraints()

Returns all constraints of this element.

Return Value

Constraint[] A list of Constraint instances

in GenericMetadata at line line 184
bool hasConstraints()

Returns whether this element has any constraints.

Return Value

bool

in GenericMetadata at line line 194
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

at line line 453
int getCascadingStrategy()

Class nodes are never cascaded.

{@inheritdoc}

Return Value

int The cascading strategy

in GenericMetadata at line line 212
int getTraversalStrategy()

Returns the strategy for traversing traversable objects.

Return Value

int The traversal strategy

at line line 117
__construct(string $class)

Constructs a metadata for the given class.

Parameters

string $class

at line line 152
string getClassName()

Returns the name of the backing PHP class.

Return Value

string The name of the backing class

at line line 172
string getDefaultGroup()

Returns the name of the default group for this class.

For each class, the group "Default" is an alias for the group "", where is the non-namespaced name of the class. All constraints implicitly or explicitly assigned to group "Default" belong to both of these groups, unless the class defines a group sequence.

If a class defines a group sequence, validating the class in "Default" will validate the group sequence. The constraints assigned to "Default" can still be validated by validating the class in "".

Return Value

string The name of the default group

at line line 224
ClassMetadata addPropertyConstraint(string $property, Constraint $constraint)

Adds a constraint to the given property.

Parameters

string $property The name of the property
Constraint $constraint The constraint

Return Value

ClassMetadata This object

at line line 245
ClassMetadata addPropertyConstraints(string $property, array $constraints)

Parameters

string $property
array $constraints

Return Value

ClassMetadata

at line line 265
ClassMetadata addGetterConstraint(string $property, Constraint $constraint)

Adds a constraint to the getter of the given property.

The name of the getter is assumed to be the name of the property with an uppercased first letter and either the prefix "get" or "is".

Parameters

string $property The name of the property
Constraint $constraint The constraint

Return Value

ClassMetadata This object

at line line 286
ClassMetadata addGetterConstraints(string $property, array $constraints)

Parameters

string $property
array $constraints

Return Value

ClassMetadata

at line line 300
mergeConstraints(ClassMetadata $source)

Merges the constraints of the given metadata into this object.

Parameters

ClassMetadata $source The source metadata

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

at line line 341
PropertyMetadataInterface[] getPropertyMetadata(string $property)

Returns all metadata instances for the given named property.

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

Parameters

string $property The property name

Return Value

PropertyMetadataInterface[] A list of metadata instances. Empty if no metadata exists for the property.

at line line 353
string[] getConstrainedProperties()

Returns the names of all constrained properties.

Return Value

string[] A list of property names

at line line 367
ClassMetadata setGroupSequence(array $groupSequence)

Sets the default group sequence for this class.

Parameters

array $groupSequence An array of group names

Return Value

ClassMetadata

Exceptions

GroupDefinitionException

at line line 393
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 Returns true if the "Default" group is overridden

at line line 401
GroupSequence|null getGroupSequence()

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

Return Value

GroupSequence|null The group sequence or null

at line line 411
ReflectionClass getReflectionClass()

Returns a ReflectionClass instance for this class.

Return Value

ReflectionClass

at line line 427
setGroupSequenceProvider(bool $active)

Sets whether a group sequence provider should be used.

Parameters

bool $active

Exceptions

GroupDefinitionException

at line line 443
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 \Symfony\Component\Validator\GroupSequenceProviderInterface}. This interface will be used to obtain the group sequence when an object of this class is validated.

Return Value

bool Returns true if the "Default" group is overridden by a dynamic group sequence