ExecutionContext
class ExecutionContext implements ExecutionContextInterface
The context used and created by {@link ExecutionContextFactory}.
Methods
Creates a new execution context.
Sets the currently validated value.
Sets the currently validated group.
Adds a violation at the current node of the validation graph.
Returns a builder for adding a violation with extended information.
Returns the violations generated by the validator so far.
Returns the validator.
Returns the value at which validation was started in the object graph.
Returns the value that the validator is currently validating.
Returns the currently validated object.
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.
Marks an object as validated in a specific validation group.
Returns whether an object was validated in a specific validation group.
Marks a constraint as validated for an object.
Returns whether a constraint was validated for an object.
Marks that an object was initialized.
Returns whether an object was initialized.
Details
at line line 146
__construct(ValidatorInterface $validator, mixed $root, TranslatorInterface $translator, string|null $translationDomain = null)
Creates a new execution context.
at line line 158
setNode(mixed $value, object|null $object, MetadataInterface $metadata = null, string $propertyPath)
Sets the currently validated value.
at line line 169
setGroup(string|null $group)
Sets the currently validated group.
at line line 177
setConstraint(Constraint $constraint)
Sets the currently validated constraint.
at line line 185
addViolation(string $message, array $parameters = array())
Adds a violation at the current node of the validation graph.
at line line 203
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();
at line line 221
ConstraintViolationListInterface
getViolations()
Returns the violations generated by the validator so far.
at line line 229
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) {
// ...
}
}
at line line 237
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}.
at line line 245
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}.
at line line 253
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.
at line line 261
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.
at line line 269
string
getGroup()
Returns the validation group that is currently being validated.
at line line 277
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.
at line line 285
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.
at line line 293
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".
at line line 301
markGroupAsValidated(string $cacheKey, string $groupHash)
Marks an object as validated in a specific validation group.
at line line 313
bool
isGroupValidated(string $cacheKey, string $groupHash)
Returns whether an object was validated in a specific validation group.
at line line 321
markConstraintAsValidated(string $cacheKey, string $constraintHash)
Marks a constraint as validated for an object.
at line line 329
bool
isConstraintValidated(string $cacheKey, string $constraintHash)
Returns whether a constraint was validated for an object.
at line line 337
markObjectAsInitialized(string $cacheKey)
Marks that an object was initialized.
at line line 345
bool
isObjectInitialized(string $cacheKey)
Returns whether an object was initialized.