class LegacyExecutionContext extends ExecutionContext
deprecated
An execution context that is compatible with the legacy API (< 2.5).
__construct(ValidatorInterface $validator, mixed $root, MetadataFactoryInterface $metadataFactory, TranslatorInterface $translator, string|null $translationDomain = null) Creates a new context. | ||
setNode(mixed $value, object|null $object, MetadataInterface $metadata = null, string $propertyPath) Sets the currently validated value. | from ExecutionContext | |
setGroup(string|null $group) Sets the currently validated group. | from ExecutionContext | |
setConstraint(Constraint $constraint) Sets the currently validated constraint. | from ExecutionContext | |
addViolation(string $message, array $parameters = array(), mixed $invalidValue = null, int|null $plural = null, int|null $code = null) Adds a violation at the current node of the validation graph. | from ExecutionContext | |
ConstraintViolationBuilderInterface | buildViolation(string $message, array $parameters = array()) Returns a builder for adding a violation with extended information. | from ExecutionContext |
ConstraintViolationListInterface | getViolations() Returns the violations generated by the validator so far. | from ExecutionContext |
ValidatorInterface | getValidator() Returns the validator. | from ExecutionContext |
mixed | getRoot() Returns the value at which validation was started in the object graph. | from ExecutionContext |
mixed | getValue() Returns the value that the validator is currently validating. | from ExecutionContext |
object|null | getObject() Returns the currently validated object. | from ExecutionContext |
MetadataInterface|null | getMetadata() Returns the metadata for the currently validated value. | from ExecutionContext |
string | getGroup() Returns the validation group that is currently being validated. | from ExecutionContext |
string|null | getClassName() Returns the class name of the current node. | from ExecutionContext |
string|null | getPropertyName() Returns the property name of the current node. | from ExecutionContext |
string | getPropertyPath(string $subPath = '') Returns the property path to the value that the validator is currently validating. | from ExecutionContext |
addViolationAt(string $subPath, string $message, array $parameters = array(), mixed $invalidValue = null, int|null $plural = null, int|null $code = null) Adds a violation at the validation graph node with the given property path relative to the current property path. | from ExecutionContext | |
validate(mixed $value, string $subPath = '', null|string|string[] $groups = null, bool $traverse = false, bool $deep = false) Validates the given value within the scope of the current validation. | from ExecutionContext | |
validateValue(mixed $value, Constraint|Constraint[] $constraints, string $subPath = '', null|string|string[] $groups = null) Validates a value against a constraint. | from ExecutionContext | |
MetadataFactoryInterface | getMetadataFactory() Returns the used metadata factory. | from ExecutionContext |
markGroupAsValidated(string $cacheKey, string $groupHash) Marks an object as validated in a specific validation group. | from ExecutionContext | |
bool | isGroupValidated(string $cacheKey, string $groupHash) Returns whether an object was validated in a specific validation group. | from ExecutionContext |
markConstraintAsValidated(string $cacheKey, string $constraintHash) Marks a constraint as validated for an object. | from ExecutionContext | |
bool | isConstraintValidated(string $cacheKey, string $constraintHash) Returns whether a constraint was validated for an object. | from ExecutionContext |
markObjectAsInitialized(string $cacheKey) Marks that an object was initialized. | from ExecutionContext | |
bool | isObjectInitialized(string $cacheKey) Returns whether an object was initialized. | from ExecutionContext |
Creates a new context.
ValidatorInterface | $validator | The validator |
mixed | $root | The root value of the validated object graph |
MetadataFactoryInterface | $metadataFactory | |
TranslatorInterface | $translator | The translator |
string|null | $translationDomain | The translation domain to use for translating violation messages |
ExecutionContext::__construct() |
Sets the currently validated value.
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 |
Sets the currently validated group.
string|null | $group | The validated group |
Sets the currently validated constraint.
Constraint | $constraint | The validated constraint |
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.
string | $message | The error message |
array | $parameters | |
mixed | $invalidValue | The invalid, validated value |
int|null | $plural | The number to use to pluralize of the message |
int|null | $code | The violation code |
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();
string | $message | The error message |
array | $parameters | The parameters substituted in the error message |
ConstraintViolationBuilderInterface | The violation builder |
Returns the violations generated by the validator so far.
ConstraintViolationListInterface | The constraint violation list. |
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) {
// ...
}
}
ValidatorInterface |
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 | The root value of the validation. |
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}.
mixed | The currently validated value. |
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.
object|null | The currently validated object or null. |
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.
MetadataInterface|null | The metadata of the currently validated value. |
Returns the validation group that is currently being validated.
string | The current validation group. |
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.
string|null | The class name or null, if no class name could be found. |
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|null | The property name or null, if no property name could be found. |
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".
string | $subPath | Optional. The suffix appended to the current property path. |
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. |
Adds a violation at the validation graph node with the given property path relative to the current property path.
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 |
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}.
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. |
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. |
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');
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. |
Returns the used metadata factory.
MetadataFactoryInterface | The metadata factory. |
Marks an object as validated in a specific validation group.
string | $cacheKey | The hash of the object |
string | $groupHash | The group's name or hash, if it is group sequence |
Returns whether an object was validated in a specific validation group.
string | $cacheKey | The hash of the object |
string | $groupHash | The group's name or hash, if it is group sequence |
bool | Whether the object was already validated for that group |
Marks a constraint as validated for an object.
string | $cacheKey | The hash of the object |
string | $constraintHash | The hash of the constraint |
Returns whether a constraint was validated for an object.
string | $cacheKey | The hash of the object |
string | $constraintHash | The hash of the constraint |
bool | Whether the constraint was already validated |
Marks that an object was initialized.
string | $cacheKey | The hash of the object |
Returns whether an object was initialized.
string | $cacheKey | The hash of the object |
bool | Whether the object was already initialized |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Validator/Context/LegacyExecutionContext.html