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. | 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 |
| __construct(string $class, string $name) Constructor. | ||
| 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 |
| 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.
__clone()
Clones this object.
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
GenericMetadata 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.
Constraint[] 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.
ReflectionMethod|ReflectionProperty 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.
Please login to continue.