W3cubDocs

Symfony\Component\Validator\Mapping\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
array	$constraintsByGroup
int	$cascadingStrategy	The strategy for cascading objects.
int	$traversalStrategy	The strategy for traversing traversable objects.
string	$class
string	$name
string	$property

Methods

string[]	__sleep() Returns the names of the properties that should be serialized.	from MemberMetadata
	__clone() Clones this object.	from GenericMetadata
GenericMetadata	addConstraint(Constraint $constraint) Adds a constraint.	from MemberMetadata
GenericMetadata	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
	accept(ValidationVisitorInterface $visitor, mixed $value, string\|string[] $group, string $propertyPath, $propagatedGroup = null) Exists for compatibility with the deprecated {@link Symfony\Component\Validator\MetadataInterface}.	from MemberMetadata
	__construct(string $class, string $property) Constructor.
string	getName() Returns the name of the member.	from MemberMetadata
string	getClassName() Returns the name of the backing PHP class.	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
bool	isCascaded() Returns whether objects stored in this member should be validated.	from MemberMetadata
bool	isCollectionCascaded() Returns whether arrays or traversable objects stored in this member should be traversed and validated in each entry.	from MemberMetadata
bool	isCollectionCascadedDeeply() Returns whether arrays or traversable objects stored in this member should be traversed recursively for inner arrays/traversable objects.	from MemberMetadata
ReflectionMethod\|ReflectionProperty	getReflectionMember(object\|string $objectOrClassName) Returns the reflection instance for accessing the member's value.	from MemberMetadata
mixed	getPropertyValue($object) Extracts the value of the property from the given container.

Details

public string[] __sleep()

Returns the names of the properties that should be serialized.

Return Value

string[]

public __clone()

Clones this object.

public 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

public GenericMetadata addConstraints(array $constraints)

Adds an list of constraints.

Parameters

array

$constraints

The constraints to add

Return Value

GenericMetadata

This object

public Constraint[] getConstraints()

Returns all constraints of this element.

Return Value

Constraint[]

A list of Constraint instances

public bool hasConstraints()

Returns whether this element has any constraints.

Return Value

bool

public 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

public int getCascadingStrategy()

Returns the strategy for cascading objects.

Return Value

int	The cascading strategy

public int getTraversalStrategy()

Returns the strategy for traversing traversable objects.

Return Value

int	The traversal strategy

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

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

public __construct(string $class, string $property)

Constructor.

Parameters

string	$class	The class the getter is defined on
string	$property	The property which the getter returns

Exceptions

ValidatorException

public string getName()

Returns the name of the member.

The object or the class name

Return Value

ReflectionMethod|ReflectionProperty

The reflection instance

public mixed getPropertyValue($object)

Extracts the value of the property from the given container.

Parameters

$object

Return Value

mixed

The value of the property.

© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Component/Validator/Mapping/GetterMetadata.html