RecursiveValidator
class RecursiveValidator implements ValidatorInterface
Recursive implementation of {@link ValidatorInterface}.
Methods
| __construct(ExecutionContextFactoryInterface $contextFactory, MetadataFactoryInterface $metadataFactory, ConstraintValidatorFactoryInterface $validatorFactory, array $objectInitializers = array()) Creates a new validator. | ||
| ContextualValidatorInterface | startContext($root = null) Starts a new validation context and returns a validator for that context. | |
| ContextualValidatorInterface | inContext(ExecutionContextInterface $context) Returns a validator in the given execution context. | |
| MetadataInterface | getMetadataFor($object) Returns the metadata for the given value. | |
| bool | hasMetadataFor($object) Returns whether the class is able to return metadata for the given value. | |
| ConstraintViolationListInterface | validate(mixed $value, Constraint|Constraint[] $constraints = null, array|null $groups = null) Validates a value against a constraint or a list of constraints. | |
| ConstraintViolationListInterface | validateProperty(object $object, string $propertyName, array|null $groups = null) Validates a property of an object against the constraints specified for this property. | |
| ConstraintViolationListInterface | validatePropertyValue(object|string $objectOrClass, string $propertyName, mixed $value, array|null $groups = null) Validates a value against the constraints specified for an object's property. |
Details
__construct(ExecutionContextFactoryInterface $contextFactory, MetadataFactoryInterface $metadataFactory, ConstraintValidatorFactoryInterface $validatorFactory, array $objectInitializers = array())
Creates a new validator.
Parameters
| ExecutionContextFactoryInterface | $contextFactory | The factory for creating new contexts |
| MetadataFactoryInterface | $metadataFactory | The factory for fetching the metadata of validated objects |
| ConstraintValidatorFactoryInterface | $validatorFactory | The factory for creating constraint validators |
| array | $objectInitializers | The object initializers |
ContextualValidatorInterface startContext($root = null)
Starts a new validation context and returns a validator for that context.
The returned validator collects all violations generated within its context. You can access these violations with the {@link ContextualValidatorInterface::getViolations()} method.
Parameters
| $root |
Return Value
| ContextualValidatorInterface | The validator for the new context |
ContextualValidatorInterface inContext(ExecutionContextInterface $context)
Returns a validator in the given execution context.
The returned validator adds all generated violations to the given context.
Parameters
| ExecutionContextInterface | $context |
Return Value
| ContextualValidatorInterface | The validator for that context |
MetadataInterface getMetadataFor($object)
Returns the metadata for the given value.
Parameters
| $object |
Return Value
| MetadataInterface | The metadata for the value |
Exceptions
| NoSuchMetadataException | If no metadata exists for the given value |
bool hasMetadataFor($object)
Returns whether the class is able to return metadata for the given value.
Parameters
| $object |
Return Value
| bool | Whether metadata can be returned for that value |
ConstraintViolationListInterface validate(mixed $value, Constraint|Constraint[] $constraints = null, array|null $groups = null)
Validates a value against a constraint or a list of constraints.
If no constraint is passed, the constraint {@link \Symfony\Component\Validator\Constraints\Valid} is assumed.
Parameters
| mixed | $value | The value to validate |
| Constraint|Constraint[] | $constraints | The constraint(s) to validate against |
| array|null | $groups | The validation groups to validate. If none is given, "Default" is assumed |
Return Value
| ConstraintViolationListInterface | A list of constraint violations If the list is empty, validation succeeded |
ConstraintViolationListInterface validateProperty(object $object, string $propertyName, array|null $groups = null)
Validates a property of an object against the constraints specified for this property.
Parameters
| object | $object | The object |
| string | $propertyName | The name of the validated property |
| array|null | $groups | The validation groups to validate. If none is given, "Default" is assumed |
Return Value
| ConstraintViolationListInterface | A list of constraint violations If the list is empty, validation succeeded |
ConstraintViolationListInterface validatePropertyValue(object|string $objectOrClass, string $propertyName, mixed $value, array|null $groups = null)
Validates a value against the constraints specified for an object's property.
Parameters
| object|string | $objectOrClass | The object or its class name |
| string | $propertyName | The name of the property |
| mixed | $value | The value to validate against the property's constraints |
| array|null | $groups | The validation groups to validate. If none is given, "Default" is assumed |
Return Value
| ConstraintViolationListInterface | A list of constraint violations If the list is empty, validation succeeded |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Validator/Validator/RecursiveValidator.html