class GetterMetadata extends MemberMetadata

Stores all metadata needed for validating a class property via its getter method.

A property getter is any method that is equal to the property's name, prefixed with either "get" or "is". That method will be used to access the property's value.

The getter will be invoked by reflection, so the access of private and protected getters 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.

Constraint[]
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.

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

Exists for compatibility with the deprecated {@link Symfony\Component\Validator\MetadataInterface}.

__construct(string $class, string $property)

Constructor.

string
getName()

Returns the name of the member.

string
getClassName()

Returns the name of the backing PHP class.

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.

bool
isCascaded() deprecated

Returns whether objects stored in this member should be validated.

bool
isCollectionCascaded() deprecated

Returns whether arrays or traversable objects stored in this member should be traversed and validated in each entry.

bool
isCollectionCascadedDeeply() deprecated

Returns whether arrays or traversable objects stored in this member should be traversed recursively for inner arrays/traversable objects.

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 112
string[] __sleep()

Returns the names of the properties that should be serialized.

Return Value

string[]

in GenericMetadata at line line 97
__clone()

Clones this object.

in MemberMetadata at line line 95
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 properties $traverse and $deep of that constraint, the traversal strategy will be set to one of the following:

  • {@link TraversalStrategy::IMPLICIT} if $traverse is enabled and $deep is enabled
  • {@link TraversalStrategy::IMPLICIT} | {@link TraversalStrategy::STOP_RECURSION} if $traverse is enabled, but $deep is disabled
  • {@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 173
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 185
Constraint[] getConstraints()

Returns all constraints of this element.

Return Value

Constraint[] A list of Constraint instances

in GenericMetadata at line line 195
bool hasConstraints()

Returns whether this element has any constraints.

Return Value

bool

in GenericMetadata at line line 205
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 215
int getCascadingStrategy()

Returns the strategy for cascading objects.

Return Value

int The cascading strategy

in GenericMetadata at line line 223
int getTraversalStrategy()

Returns the strategy for traversing traversable objects.

Return Value

int The traversal strategy

in MemberMetadata at line line 83
accept(ValidationVisitorInterface $visitor, mixed $value, string|string[] $group, string $propertyPath, $propagatedGroup = null) deprecated

deprecated Deprecated since version 2.5, to be removed in Symfony 3.0.

Exists for compatibility with the deprecated {@link Symfony\Component\Validator\MetadataInterface}.

Should not be used.

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
$propagatedGroup

Exceptions

BadMethodCallException

at line line 43
__construct(string $class, string $property)

Constructor.

Parameters

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

Exceptions

ValidatorException

in MemberMetadata at line line 126
string getName()

Returns the name of the member.

Return Value

string

in MemberMetadata at line line 134
string getClassName()

Returns the name of the backing PHP class.

Return Value

string The name of the backing class.

in MemberMetadata at line line 142
string getPropertyName()

Returns the name of the property.

Return Value

string The property name.

in MemberMetadata at line line 154
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 166
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 178
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 191
bool isCascaded() deprecated

deprecated Deprecated since version 2.5, to be removed in Symfony 3.0. Use {@link getCascadingStrategy()} instead.

Returns whether objects stored in this member should be validated.

Return Value

bool

in MemberMetadata at line line 205
bool isCollectionCascaded() deprecated

deprecated Deprecated since version 2.5, to be removed in Symfony 3.0. Use {@link getTraversalStrategy()} instead.

Returns whether arrays or traversable objects stored in this member should be traversed and validated in each entry.

Return Value

bool

in MemberMetadata at line line 219
bool isCollectionCascadedDeeply() deprecated

deprecated Deprecated since version 2.5, to be removed in Symfony 3.0. Use {@link getTraversalStrategy()} instead.

Returns whether arrays or traversable objects stored in this member should be traversed recursively for inner arrays/traversable objects.

Return Value

bool

in MemberMetadata at line line 231
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 65
mixed getPropertyValue($object)

Extracts the value of the property from the given container.

Parameters

$object

Return Value

mixed The value of the property.