ContextualValidatorInterface
ContextualValidatorInterface
interface ContextualValidatorInterface
A validator in a specific execution context.
Methods
$this | atPath(string $path) Appends the given path to the property path of the context. | |
$this | validate(mixed $value, Constraint|Constraint[] $constraints = null, array|null $groups = null) Validates a value against a constraint or a list of constraints. | |
$this | validateProperty(object $object, string $propertyName, array|null $groups = null) Validates a property of an object against the constraints specified for this property. | |
$this | validatePropertyValue(object|string $objectOrClass, string $propertyName, mixed $value, array|null $groups = null) Validates a value against the constraints specified for an object's property. | |
ConstraintViolationListInterface | getViolations() Returns the violations that have been generated so far in the context of the validator. |
Details
$this atPath(string $path)
Appends the given path to the property path of the context.
If called multiple times, the path will always be reset to the context's original path with the given path appended to it.
Parameters
string | $path | The path to append |
Return Value
$this |
$this 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
$this |
$this 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
$this |
$this 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
$this |
ConstraintViolationListInterface getViolations()
Returns the violations that have been generated so far in the context of the validator.
Return Value
ConstraintViolationListInterface | The constraint violations |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/Validator/Validator/ContextualValidatorInterface.html