PropertyMetadataInterface
interface PropertyMetadataInterface implements MetadataInterface, PropertyMetadataInterface, ClassBasedInterface
Stores all metadata needed for validating the value of a class property.
Most importantly, the metadata stores the constraints against which the property's value should be validated.
Additionally, the metadata stores whether objects stored in the property should be validated against their class' metadata and whether traversable objects should be traversed or not.
Methods
| accept(ValidationVisitorInterface $visitor, mixed $value, string|string[] $group, string $propertyPath) deprecated Implementation of the Visitor design pattern. | from MetadataInterface | |
| Constraint[] | findConstraints(string $group) Returns all constraints for a given validation group. | from MetadataInterface |
| int | getCascadingStrategy() Returns the strategy for cascading objects. | from MetadataInterface |
| int | getTraversalStrategy() Returns the strategy for traversing traversable objects. | from MetadataInterface |
| Constraint[] | getConstraints() Returns all constraints of this element. | from MetadataInterface |
| string | getPropertyName() Returns the name of the property. | from PropertyMetadataInterface |
| mixed | getPropertyValue(mixed $containingValue) Extracts the value of the property from the given container. | from PropertyMetadataInterface |
| string | getClassName() Returns the name of the backing PHP class. | from ClassBasedInterface |
Details
accept(ValidationVisitorInterface $visitor, mixed $value, string|string[] $group, string $propertyPath) deprecated
deprecated
Implementation of the Visitor design pattern.
Calls {@link ValidationVisitorInterface::visit} and then forwards the accept()-call to all property metadata instances.
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 |
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 |
See also
| CascadingStrategy |
int getTraversalStrategy()
Returns the strategy for traversing traversable objects.
Return Value
| int | The traversal strategy |
See also
| TraversalStrategy |
Constraint[] getConstraints()
Returns all constraints of this element.
Return Value
| Constraint[] | A list of Constraint instances |
string getPropertyName()
Returns the name of the property.
Return Value
| string | The property name |
mixed getPropertyValue(mixed $containingValue)
Extracts the value of the property from the given container.
Parameters
| mixed | $containingValue | The container to extract the property value from |
Return Value
| mixed | The value of the property |
string getClassName()
Returns the name of the backing PHP class.
Return Value
| string | The name of the backing class |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Component/Validator/Mapping/PropertyMetadataInterface.html