1. class
  2. Symfony
  3. \
  4. Component
  5. \
  6. Validator
  7. \
  8. Mapping
  9. \
  10. GetterMetadata

GetterMetadata

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

Methods

string[]
__sleep()

Returns the names of the properties that should be serialized.

from MemberMetadata
__clone()

Clones this object.

from GenericMetadata
$this
addConstraint(Constraint $constraint)

Adds a constraint.

from MemberMetadata
$this
addConstraints(array $constraints)

Adds an list of constraints.

from GenericMetadata
Constraint[]
getConstraints()

Returns all constraints of this element.

from GenericMetadata
bool
hasConstraints()

Returns whether this element has any constraints.

from GenericMetadata
Constraint[]
findConstraints(string $group)

Returns all constraints for a given validation group.

from GenericMetadata
int
getCascadingStrategy()

Returns the strategy for cascading objects.

from GenericMetadata
int
getTraversalStrategy()

Returns the strategy for traversing traversable objects.

from GenericMetadata
__construct(string $class, string $property, string $method = null)

No description

string
getName()

Returns the name of the member.

from MemberMetadata
getClassName()

{@inheritdoc}

from MemberMetadata
string
getPropertyName()

Returns the name of the property.

from MemberMetadata
bool
isPublic(object|string $objectOrClassName)

Returns whether this member is public.

from MemberMetadata
bool
isProtected(object|string $objectOrClassName)

Returns whether this member is protected.

from MemberMetadata
bool
isPrivate(object|string $objectOrClassName)

Returns whether this member is private.

from MemberMetadata
ReflectionMethod|ReflectionProperty
getReflectionMember(object|string $objectOrClassName)

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

from MemberMetadata
ReflectionMethod|ReflectionProperty
newReflectionMember(object|string $objectOrClassName)

Creates a new reflection instance for accessing the member's value.

mixed
getPropertyValue($object)

Extracts the value of the property from the given container.

Details

string[] __sleep()

Returns the names of the properties that should be serialized.

Return Value

string[]

__clone()

Clones this object.

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

Return Value

$this

Exceptions

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

$this addConstraints(array $constraints)

Adds an list of constraints.

Parameters

array $constraints The constraints to add

Return Value

$this

Constraint[] getConstraints()

Returns all constraints of this element.

Return Value

Constraint[] A list of Constraint instances

bool hasConstraints()

Returns whether this element has any constraints.

Return Value

bool

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

int getCascadingStrategy()

Returns the strategy for cascading objects.

Return Value

int The cascading strategy

int getTraversalStrategy()

Returns the strategy for traversing traversable objects.

Return Value

int The traversal strategy

__construct(string $class, string $property, string $method = null)

Parameters

string $class The name of the class this member is defined on
string $property The property the member belongs to
string $method The method that is called to retrieve the value being validated (null for auto-detection)

Exceptions

ValidatorException

string getName()

Returns the name of the member.

Return Value

string

getClassName()

{@inheritdoc}

string getPropertyName()

Returns the name of the property.

Return Value

string The property name

bool isPublic(object|string $objectOrClassName)

Returns whether this member is public.

Parameters

object|string $objectOrClassName The object or the class name

Return Value

bool

bool isProtected(object|string $objectOrClassName)

Returns whether this member is protected.

Parameters

object|string $objectOrClassName The object or the class name

Return Value

bool

bool isPrivate(object|string $objectOrClassName)

Returns whether this member is private.

Parameters

object|string $objectOrClassName The object or the class name

Return Value

bool

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

protected ReflectionMethod|ReflectionProperty newReflectionMember(object|string $objectOrClassName)

Creates a new reflection instance for accessing the member's value.

Must be implemented by subclasses.

Parameters

object|string $objectOrClassName The object or the class name

Return Value

ReflectionMethod|ReflectionProperty The reflection instance

mixed getPropertyValue($object)

Extracts the value of the property from the given container.

Parameters

$object

Return Value

mixed The value of the property