class PropertyMetadata extends MemberMetadata

Stores all metadata needed for validating a class property.

The value of the property is obtained by directly accessing the property. The property will be accessed by reflection, so the access of private and protected properties is supported.

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. from GenericMetadata
string $class from MemberMetadata
string $name from MemberMetadata
string $property from MemberMetadata

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()

Returns the strategy for cascading objects.

int
getTraversalStrategy()

Returns the strategy for traversing traversable objects.

__construct(string $class, string $name)

Constructor.

string
getName()

Returns the name of the member.

getClassName()

{@inheritdoc}

string
getPropertyName()

Returns the name of the property.

bool
isPublic(object|string $objectOrClassName)

Returns whether this member is public.

bool
isProtected(object|string $objectOrClassName)

Returns whether this member is protected.

bool
isPrivate(object|string $objectOrClassName)

Returns whether this member is private.

getReflectionMember(object|string $objectOrClassName)

Returns the reflection instance for accessing the member's value.

mixed
getPropertyValue($object)

Extracts the value of the property from the given container.

Details

in MemberMetadata at line line 97
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.

in MemberMetadata at line line 80
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

in GenericMetadata at line line 204
int getCascadingStrategy()

Returns the strategy for cascading objects.

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 39
__construct(string $class, string $name)

Constructor.

Parameters

string $class The name of the class this member is defined on
string $name The name of the member

Exceptions

ValidatorException

in MemberMetadata at line line 111
string getName()

Returns the name of the member.

Return Value

string

in MemberMetadata at line line 119
getClassName()

{@inheritdoc}

in MemberMetadata at line line 127
string getPropertyName()

Returns the name of the property.

Return Value

string The property name

in MemberMetadata at line line 139
bool isPublic(object|string $objectOrClassName)

Returns whether this member is public.

Parameters

object|string $objectOrClassName The object or the class name

Return Value

bool

in MemberMetadata at line line 151
bool isProtected(object|string $objectOrClassName)

Returns whether this member is protected.

Parameters

object|string $objectOrClassName The object or the class name

Return Value

bool

in MemberMetadata at line line 163
bool isPrivate(object|string $objectOrClassName)

Returns whether this member is private.

Parameters

object|string $objectOrClassName The object or the class name

Return Value

bool

in MemberMetadata at line line 175
ReflectionMethod|ReflectionProperty getReflectionMember(object|string $objectOrClassName)

Returns the reflection instance for accessing the member's value.

Parameters

object|string $objectOrClassName The object or the class name

Return Value

ReflectionMethod|ReflectionProperty The reflection instance

at line line 51
mixed getPropertyValue($object)

Extracts the value of the property from the given container.

Parameters

$object

Return Value

mixed The value of the property