Class

Symfony\Component\Validator\ExecutionContext

class ExecutionContext implements ExecutionContextInterface

Default implementation of {@link ExecutionContextInterface}.

This class is immutable by design.

Methods

__construct(GlobalExecutionContextInterface $globalContext, TranslatorInterface $translator, null|string $translationDomain = null, MetadataInterface $metadata = null, mixed $value = null, string $group = null, string $propertyPath = '')

Creates a new execution context.

addViolation(string $message, array $params = array(), mixed $invalidValue = null, integer|null $plural = null, integer|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, integer|null $plural = null, integer|null $code = null)

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

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.

string getPropertyPath(string $subPath = '')

Returns the property path to the value that the validator is currently validating.

string|null getClassName()

Returns the class name of the current node.

string|null getPropertyName()

Returns the property name of the current node.

mixed getValue()

Returns the value that the validator is currently validating.

string getGroup()

Returns the validation group that is currently being validated.

MetadataInterface|null getMetadata()

Returns the metadata for the currently validated value.

getMetadataFor($value)

{@inheritdoc}

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

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

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

Validates a value against a constraint.

MetadataFactoryInterface getMetadataFactory()

Returns the used metadata factory.

Details

at line 75
public __construct(GlobalExecutionContextInterface $globalContext, TranslatorInterface $translator, null|string $translationDomain = null, MetadataInterface $metadata = null, mixed $value = null, string $group = null, string $propertyPath = '')

Creates a new execution context.

Parameters

GlobalExecutionContextInterface $globalContext The global context storing node-independent state.
TranslatorInterface $translator The translator for translating violation messages.
null|string $translationDomain The domain of the validation messages.
MetadataInterface $metadata The metadata of the validated node.
mixed $value The value of the validated node.
string $group The current validation group.
string $propertyPath The property path to the current node.

at line 93
public addViolation(string $message, array $params = array(), mixed $invalidValue = null, integer|null $plural = null, integer|null $code = null)

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
mixed $invalidValue The invalid, validated value
integer|null $plural The number to use to pluralize of the message
integer|null $code The violation code

at line 121
public addViolationAt(string $subPath, string $message, array $parameters = array(), mixed $invalidValue = null, integer|null $plural = null, integer|null $code = null)

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
integer|null $plural The number to use to pluralize of the message
integer|null $code The violation code

at line 141
public ConstraintViolationListInterface getViolations()

Returns the violations generated by the validator so far.

Return Value

ConstraintViolationListInterface The constraint violation list.

at line 149
public 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.

at line 157
public 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 169
public 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.

at line 181
public 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.

at line 193
public 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.

at line 201
public string getGroup()

Returns the validation group that is currently being validated.

Return Value

string The current validation group.

at line 209
public 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.

at line 217
public getMetadataFor($value)

{@inheritdoc}

Parameters

$value

at line 225
public validate(mixed $value, string $subPath = '', null|string|string[] $groups = null, Boolean $traverse = false, Boolean $deep = false)

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.
null|string|string[] $groups The groups to validate in. If you don't pass any groups here, the current group of the context will be used.
Boolean $traverse Whether to traverse the value if it is an array or an instance of \Traversable.
Boolean $deep Whether to traverse the value recursively if it is a collection of collections.

at line 237
public validateValue(mixed $value, Constraint|Constraint[] $constraints, string $subPath = '', null|string|string[] $groups = null)

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.
null|string|string[] $groups The groups to validate in. If you don't pass any groups here, the current group of the context will be used.

at line 263
public MetadataFactoryInterface getMetadataFactory()

Returns the used metadata factory.

Return Value

MetadataFactoryInterface The metadata factory.