interface ExecutionContextInterface implements 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(), mixed $invalidValue = null, int|null $plural = null, int|null $code = null)

Adds a violation at the current node of the validation graph.

addViolationAt(string $subPath, string $message, array $parameters = array(), mixed $invalidValue = null, int|null $plural = null, int|null $code = null) deprecated

Adds a violation at the validation graph node with the given property path relative to the current property path.

validate(mixed $value, string $subPath = '', string|string[]|null $groups = null, bool $traverse = false, bool $deep = false) deprecated

Validates the given value within the scope of the current validation.

validateValue(mixed $value, Constraint|Constraint[] $constraints, string $subPath = '', string|string[]|null $groups = null) deprecated

Validates a value against a constraint.

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.

getMetadata()

Returns the metadata for the currently validated value.

getMetadataFactory() deprecated

Returns the used metadata factory.

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.

buildViolation(string $message, array $parameters = array())

Returns a builder for adding a violation with extended information.

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.

Details

addViolation(string $message, array $params = array(), mixed $invalidValue = null, int|null $plural = null, int|null $code = null)

Adds a violation at the current node of the validation graph.

Note: the parameters $invalidValue, $plural and $code are deprecated since version 2.5 and will be removed in 3.0.

Parameters

string $message The error message
array $params The parameters substituted in the error message
mixed $invalidValue The invalid, validated value
int|null $plural The number to use to pluralize of the message
int|null $code The violation code

addViolationAt(string $subPath, string $message, array $parameters = array(), mixed $invalidValue = null, int|null $plural = null, int|null $code = null) deprecated

deprecated since version 2.5, to be removed in 3.0. Use {@link Context\ExecutionContextInterface::buildViolation()} instead.

Adds a violation at the validation graph node with the given property path relative to the current property path.

Parameters

string $subPath The relative property path for the violation
string $message The error message
array $parameters The parameters substituted in the error message
mixed $invalidValue The invalid, validated value
int|null $plural The number to use to pluralize of the message
int|null $code The violation code

validate(mixed $value, string $subPath = '', string|string[]|null $groups = null, bool $traverse = false, bool $deep = false) deprecated

deprecated since version 2.5, to be removed in 3.0. Use {@link Context\ExecutionContextInterface::getValidator()} instead.

Validates the given value within the scope of the current validation.

The value may be any value recognized by the used metadata factory (see {@link MetadataFactoryInterface::getMetadata}), or an array or a traversable object of such values.

Usually you validate a value that is not the current node of the execution context. For this case, you can pass the {@link $subPath} argument which is appended to the current property path when a violation is created. For example, take the following object graph:

(Person)---($address: Address)---($phoneNumber: PhoneNumber)

When the execution context stops at the Person instance, the property path is "address". When you validate the PhoneNumber instance now, pass "phoneNumber" as sub path to correct the property path to "address.phoneNumber":

$context->validate($address->phoneNumber, 'phoneNumber');

Any violations generated during the validation will be added to the violation list that you can access with {@link getViolations}.

Parameters

mixed $value The value to validate
string $subPath The path to append to the context's property path
string|string[]|null $groups The groups to validate in. If you don't pass any groups here, the current group of the context will be used.
bool $traverse Whether to traverse the value if it is an array or an instance of \Traversable
bool $deep Whether to traverse the value recursively if it is a collection of collections

validateValue(mixed $value, Constraint|Constraint[] $constraints, string $subPath = '', string|string[]|null $groups = null) deprecated

deprecated since version 2.5, to be removed in 3.0. Use {@link Context\ExecutionContextInterface::getValidator()} instead.

Validates a value against a constraint.

Use the parameter $subPath to adapt the property path for the validated value. For example, take the following object graph:

(Person)---($address: Address)---($street: string)

When the validator validates the Address instance, the property path stored in the execution context is "address". When you manually validate the property $street now, pass the sub path "street" to adapt the full property path to "address.street":

$context->validate($address->street, new NotNull(), 'street');

Parameters

mixed $value The value to validate
Constraint|Constraint[] $constraints The constraint(s) to validate against
string $subPath The path to append to the context's property path
string|string[]|null $groups The groups to validate in. If you don't pass any groups here, the current group of the context will be used.

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\ClassMetadata} 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

MetadataFactoryInterface getMetadataFactory() deprecated

deprecated since version 2.5, to be removed in 3.0. Use {@link Context\ExecutionContextInterface::getValidator()} instead and call {@link Validator\ValidatorInterface::getMetadataFor()} or {@link Validator\ValidatorInterface::hasMetadataFor()} there.

Returns the used metadata factory.

Return Value

MetadataFactoryInterface The metadata factory

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 ClassBasedInterface} 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.

at line 80
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

at line 100
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->validate($value, new Length(array('min' => 3)));

    if (count($violations) > 0) {
        // ...
    }
}

Return Value

ValidatorInterface

at line 114
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

at line 127
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

at line 137
setGroup(string|null $group)

Sets the currently validated group.

Parameters

string|null $group The validated group

at line 147
setConstraint(Constraint $constraint)

Sets the currently validated constraint.

Parameters

Constraint $constraint The validated constraint

at line 159
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

at line 174
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

at line 185
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

at line 198
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

at line 210
markObjectAsInitialized(string $cacheKey)

Marks that an object was initialized.

Parameters

string $cacheKey The hash of the object

See also

ObjectInitializerInterface

at line 224
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