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(mixed $value, Constraint $constraint): void
{
$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(mixed $value, Constraint $constraint): void
{
$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
Adds a violation at the current node of the validation graph.
Returns a builder for adding a violation with extended information.
Returns the validator.
Returns the currently validated object.
Warning: Should not be called by user code, to be used by the validator engine only.
Warning: Should not be called by user code, to be used by the validator engine only.
Warning: Should not be called by user code, to be used by the validator engine only.
Warning: Should not be called by user code, to be used by the validator engine only.
Warning: Should not be called by user code, to be used by the validator engine only.
Warning: Should not be called by user code, to be used by the validator engine only.
Warning: Should not be called by user code, to be used by the validator engine only.
Warning: Should not be called by user code, to be used by the validator engine only.
Warning: Should not be called by user code, to be used by the validator engine only.
Returns the violations generated by the validator so far.
Returns the value at which validation was started in the object graph.
Returns the value that the validator is currently validating.
Returns the metadata for the currently validated value.
Returns the validation group that is currently being validated.
Returns the class name of the current node.
Returns the property name of the current node.
Returns the property path to the value that the validator is currently validating.
Details
void
addViolation(string$message,array$params =[])
Adds a violation at the current node of the validation graph.
ConstraintViolationBuilderInterface
buildViolation(string$message,array$parameters =[])
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();
ValidatorInterface
getValidator()
Returns the validator.
Useful if you want to validate additional constraints:
public function validate(mixed $value, Constraint $constraint): void
{
$validator = $this->context->getValidator();
$violations = $validator->validate($value, new Length(['min' => 3]));
if (count($violations) > 0) {
// ...
}
}
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 validating a property or getter constraint, the object that the property/getter belongs to is returned.
In other cases, null is returned.
void
setNode(mixed$value,object|null$object,MetadataInterface|null$metadata,string$propertyPath)
Warning: Should not be called by user code, to be used by the validator engine only.
void
setGroup(string|null$group)
Warning: Should not be called by user code, to be used by the validator engine only.
void
setConstraint(Constraint$constraint)
Warning: Should not be called by user code, to be used by the validator engine only.
void
markGroupAsValidated(string$cacheKey,string$groupHash)
Warning: Should not be called by user code, to be used by the validator engine only.
bool
isGroupValidated(string$cacheKey,string$groupHash)
Warning: Should not be called by user code, to be used by the validator engine only.
void
markConstraintAsValidated(string$cacheKey,string$constraintHash)
Warning: Should not be called by user code, to be used by the validator engine only.
bool
isConstraintValidated(string$cacheKey,string$constraintHash)
Warning: Should not be called by user code, to be used by the validator engine only.
void
markObjectAsInitialized(string$cacheKey)
Warning: Should not be called by user code, to be used by the validator engine only.
bool
isObjectInitialized(string$cacheKey)
Warning: Should not be called by user code, to be used by the validator engine only.
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.
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}.
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}.
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.
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.
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.
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".