ClassMetadataInterface
interface ClassMetadataInterface implements MetadataInterface
Stores all metadata needed for validating objects of specific class.
Most importantly, the metadata stores the constraints against which an object and its properties should be validated.
Additionally, the metadata stores whether the "Default" group is overridden by a group sequence for that class and whether instances of that class should be traversed or not.
Methods
| 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 |
| Constraint[] | findConstraints(string $group) Returns all constraints for a given validation group. | from MetadataInterface |
| string[] | getConstrainedProperties() Returns the names of all constrained properties. | |
| bool | hasGroupSequence() Returns whether the "Default" group is overridden by a group sequence. | |
| GroupSequence|null | getGroupSequence() Returns the group sequence that overrides the "Default" group for this class. | |
| bool | isGroupSequenceProvider() Returns whether the "Default" group is overridden by a dynamic group sequence obtained by the validated objects. | |
| bool | hasPropertyMetadata(string $property) Check if there's any metadata attached to the given named property. | |
| PropertyMetadataInterface[] | getPropertyMetadata(string $property) Returns all metadata instances for the given named property. | |
| string | getClassName() Returns the name of the backing PHP class. |
Details
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 |
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 |
string[] getConstrainedProperties()
Returns the names of all constrained properties.
Return Value
| string[] | A list of property names |
bool hasGroupSequence()
Returns whether the "Default" group is overridden by a group sequence.
If it is, you can access the group sequence with {@link getGroupSequence()}.
Return Value
| bool | Returns true if the "Default" group is overridden |
See also
| \Symfony\Component\Validator\Constraints\GroupSequence |
GroupSequence|null getGroupSequence()
Returns the group sequence that overrides the "Default" group for this class.
Return Value
| GroupSequence|null | The group sequence or null |
See also
| \Symfony\Component\Validator\Constraints\GroupSequence |
bool isGroupSequenceProvider()
Returns whether the "Default" group is overridden by a dynamic group sequence obtained by the validated objects.
If this method returns true, the class must implement {@link \Symfony\Component\Validator\GroupSequenceProviderInterface}. This interface will be used to obtain the group sequence when an object of this class is validated.
Return Value
| bool | Returns true if the "Default" group is overridden by a dynamic group sequence |
See also
| \Symfony\Component\Validator\GroupSequenceProviderInterface |
bool hasPropertyMetadata(string $property)
Check if there's any metadata attached to the given named property.
Parameters
| string | $property | The property name |
Return Value
| bool |
PropertyMetadataInterface[] getPropertyMetadata(string $property)
Returns all metadata instances for the given named property.
If your implementation does not support properties, simply throw an exception in this method (for example a BadMethodCallException).
Parameters
| string | $property | The property name |
Return Value
| PropertyMetadataInterface[] | A list of metadata instances. Empty if no metadata exists for 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/4.0/Symfony/Component/Validator/Mapping/ClassMetadataInterface.html