ExecutionContextInterface
interface ExecutionContextInterface
The context of a validation run.
The context collects all violations generated during the validation. By default, validators execute all validations in a new context:
$violations = $validator->validate($object);
When you make another call to the validator, while the validation is in progress, the violations will be isolated from each other:
public function validate($value, Constraint $constraint)
{
$validator = $this->context->getValidator();
// The violations are not added to $this->context
$violations = $validator->validate($value);
}
However, if you want to add the violations to the current context, use the {@link ValidatorInterface::inContext()} method:
public function validate($value, Constraint $constraint)
{
$validator = $this->context->getValidator();
// The violations are added to $this->context
$validator
->inContext($this->context)
->validate($value)
;
}
Additionally, the context provides information about the current state of the validator, such as the currently validated class, the name of the currently validated property and more. These values change over time, so you cannot store a context and expect that the methods still return the same results later on.
Methods
addViolation(string $message, array $params = array()) Adds a violation at the current node of the validation graph. | ||
ConstraintViolationBuilderInterface | buildViolation(string $message, array $parameters = array()) Returns a builder for adding a violation with extended information. | |
ValidatorInterface | getValidator() Returns the validator. | |
object|null | getObject() Returns the currently validated object. | |
setNode(mixed $value, object|null $object, MetadataInterface $metadata = null, string $propertyPath) Sets the currently validated value. | ||
setGroup(string|null $group) Sets the currently validated group. | ||
setConstraint(Constraint $constraint) Sets the currently validated constraint. | ||
markGroupAsValidated(string $cacheKey, string $groupHash) Marks an object as validated in a specific validation group. | ||
bool | isGroupValidated(string $cacheKey, string $groupHash) Returns whether an object was validated in a specific validation group. | |
markConstraintAsValidated(string $cacheKey, string $constraintHash) Marks a constraint as validated for an object. | ||
bool | isConstraintValidated(string $cacheKey, string $constraintHash) Returns whether a constraint was validated for an object. | |
markObjectAsInitialized(string $cacheKey) Marks that an object was initialized. | ||
bool | isObjectInitialized(string $cacheKey) Returns whether an object was initialized. | |
ConstraintViolationListInterface | getViolations() Returns the violations generated by the validator so far. | |
mixed | getRoot() Returns the value at which validation was started in the object graph. | |
mixed | getValue() Returns the value that the validator is currently validating. | |
MetadataInterface|null | getMetadata() Returns the metadata for the currently validated value. | |
string | getGroup() Returns the validation group that is currently being validated. | |
string|null | getClassName() Returns the class name of the current node. | |
string|null | getPropertyName() Returns the property name of the current node. | |
string | getPropertyPath(string $subPath = '') Returns the property path to the value that the validator is currently validating. |
Details
addViolation(string $message, array $params = array())
Adds a violation at the current node of the validation graph.
Parameters
string | $message | The error message |
array | $params | The parameters substituted in the error message |
ConstraintViolationBuilderInterface buildViolation(string $message, array $parameters = array())
Returns a builder for adding a violation with extended information.
Call {@link ConstraintViolationBuilderInterface::addViolation()} to add the violation when you're done with the configuration:
$context->buildViolation('Please enter a number between %min% and %max%.')
->setParameter('%min%', 3)
->setParameter('%max%', 10)
->setTranslationDomain('number_validation')
->addViolation();
Parameters
string | $message | The error message |
array | $parameters | The parameters substituted in the error message |
Return Value
ConstraintViolationBuilderInterface | The violation builder |
ValidatorInterface getValidator()
Returns the validator.
Useful if you want to validate additional constraints:
public function validate($value, Constraint $constraint)
{
$validator = $this->context->getValidator();
$violations = $validator->validateValue($value, new Length(array('min' => 3)));
if (count($violations) > 0) {
// ...
}
}
Return Value
ValidatorInterface |
object|null getObject()
Returns the currently validated object.
If the validator is currently validating a class constraint, the object of that class is returned. If it is a validating a property or getter constraint, the object that the property/getter belongs to is returned.
In other cases, null is returned.
Return Value
object|null | The currently validated object or null |
setNode(mixed $value, object|null $object, MetadataInterface $metadata = null, string $propertyPath)
Sets the currently validated value.
Parameters
mixed | $value | The validated value |
object|null | $object | The currently validated object |
MetadataInterface | $metadata | The validation metadata |
string | $propertyPath | The property path to the current value |
setGroup(string|null $group)
Sets the currently validated group.
Parameters
string|null | $group | The validated group |
setConstraint(Constraint $constraint)
Sets the currently validated constraint.
Parameters
Constraint | $constraint | The validated constraint |
markGroupAsValidated(string $cacheKey, string $groupHash)
Marks an object as validated in a specific validation group.
Parameters
string | $cacheKey | The hash of the object |
string | $groupHash | The group's name or hash, if it is group sequence |
bool isGroupValidated(string $cacheKey, string $groupHash)
Returns whether an object was validated in a specific validation group.
Parameters
string | $cacheKey | The hash of the object |
string | $groupHash | The group's name or hash, if it is group sequence |
Return Value
bool | Whether the object was already validated for that group |
markConstraintAsValidated(string $cacheKey, string $constraintHash)
Marks a constraint as validated for an object.
Parameters
string | $cacheKey | The hash of the object |
string | $constraintHash | The hash of the constraint |
bool isConstraintValidated(string $cacheKey, string $constraintHash)
Returns whether a constraint was validated for an object.
Parameters
string | $cacheKey | The hash of the object |
string | $constraintHash | The hash of the constraint |
Return Value
bool | Whether the constraint was already validated |
markObjectAsInitialized(string $cacheKey)
Marks that an object was initialized.
Parameters
string | $cacheKey | The hash of the object |
See also
ObjectInitializerInterface |
bool isObjectInitialized(string $cacheKey)
Returns whether an object was initialized.
Parameters
string | $cacheKey | The hash of the object |
Return Value
bool | Whether the object was already initialized |
See also
ObjectInitializerInterface |
ConstraintViolationListInterface getViolations()
Returns the violations generated by the validator so far.
Return Value
ConstraintViolationListInterface | The constraint violation list |
mixed getRoot()
Returns the value at which validation was started in the object graph.
The validator, when given an object, traverses the properties and related objects and their properties. The root of the validation is the object from which the traversal started.
The current value is returned by {@link getValue}.
Return Value
mixed | The root value of the validation |
mixed getValue()
Returns the value that the validator is currently validating.
If you want to retrieve the object that was originally passed to the validator, use {@link getRoot}.
Return Value
mixed | The currently validated value |
MetadataInterface|null getMetadata()
Returns the metadata for the currently validated value.
With the core implementation, this method returns a {@link Mapping\ClassMetadataInterface} instance if the current value is an object, a {@link Mapping\PropertyMetadata} instance if the current value is the value of a property and a {@link Mapping\GetterMetadata} instance if the validated value is the result of a getter method.
If the validated value is neither of these, for example if the validator has been called with a plain value and constraint, this method returns null.
Return Value
MetadataInterface|null | the metadata of the currently validated value |
string getGroup()
Returns the validation group that is currently being validated.
Return Value
string | The current validation group |
string|null getClassName()
Returns the class name of the current node.
If the metadata of the current node does not implement {@link Mapping\ClassMetadataInterface} or if no metadata is available for the current node, this method returns null.
Return Value
string|null | The class name or null, if no class name could be found |
string|null getPropertyName()
Returns the property name of the current node.
If the metadata of the current node does not implement {@link PropertyMetadataInterface} or if no metadata is available for the current node, this method returns null.
Return Value
string|null | The property name or null, if no property name could be found |
string getPropertyPath(string $subPath = '')
Returns the property path to the value that the validator is currently validating.
For example, take the following object graph:
(Person)---($address: Address)---($street: string)
When the Person instance is passed to the validator, the property path is initially empty. When the $address property of that person is validated, the property path is "address". When the $street property of the related Address instance is validated, the property path is "address.street".
Properties of objects are prefixed with a dot in the property path. Indices of arrays or objects implementing the {@link \ArrayAccess} interface are enclosed in brackets. For example, if the property in the previous example is $addresses and contains an array of Address instance, the property path generated for the $street property of one of these addresses is for example "addresses[0].street".
Parameters
string | $subPath | Optional. The suffix appended to the current property path. |
Return Value
string | The current property path. The result may be an empty string if the validator is currently validating the root value of the validation graph. |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Validator/Context/ExecutionContextInterface.html