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 $pluralization = null, integer|null $code = null)
Adds a violation at the current node of the validation graph. |
||
|
addViolationAt(string $subPath, string $message, array $params = array(), mixed $invalidValue = null, integer|null $pluralization = 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 72
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.
at line 90
public
addViolation(string $message, array $params = array(), mixed $invalidValue = null, integer|null $pluralization = null, integer|null $code = null)
Adds a violation at the current node of the validation graph.
at line 118
public
addViolationAt(string $subPath, string $message, array $params = array(), mixed $invalidValue = null, integer|null $pluralization = null, integer|null $code = null)
Adds a violation at the validation graph node with the given property path relative to the current property path.
at line 138
public ConstraintViolationListInterface
getViolations()
Returns the violations generated by the validator so far.
at line 146
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}.
at line 154
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:
<pre>
(Person)---($address: Address)---($street: string)
</pre>
When the <tt>Person</tt> instance is passed to the validator, the
property path is initially empty. When the <tt>$address</tt> property
of that person is validated, the property path is "address". When
the <tt>$street</tt> property of the related <tt>Address</tt> 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 <tt>$addresses</tt> and contains an array
of <tt>Address</tt> instance, the property path generated for the
<tt>$street</tt> property of one of these addresses is for example
"addresses[0].street".
at line 166
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.
at line 178
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.
at line 190
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}.
at line 198
public string
getGroup()
Returns the validation group that is currently being validated.
at line 206
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.
at line 214
public
getMetadataFor($value)
{@inheritdoc}
at line 222
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:
<pre>
(Person)---($address: Address)---($phoneNumber: PhoneNumber)
^
</pre>
When the execution context stops at the <tt>Person</tt> instance, the
property path is "address". When you validate the <tt>PhoneNumber</tt>
instance now, pass "phoneNumber" as sub path to correct the property path
to "address.phoneNumber":
<pre>
$context->validate($address->phoneNumber, 'phoneNumber');
</pre>
Any violations generated during the validation will be added to the
violation list that you can access with {@link getViolations}.
at line 234
public
validateValue(mixed $value, Constraint|Constraint[] $constraints, string $subPath = '', null|string|string[] $groups = null)
Validates a value against a constraint.
Use the parameter <tt>$subPath</tt> to adapt the property path for the
validated value. For example, take the following object graph:
<pre>
(Person)---($address: Address)---($street: string)
^
</pre>
When the validator validates the <tt>Address</tt> instance, the
property path stored in the execution context is "address". When you
manually validate the property <tt>$street</tt> now, pass the sub path
"street" to adapt the full property path to "address.street":
<pre>
$context->validate($address->street, new NotNull(), 'street');
</pre>
at line 260
public MetadataFactoryInterface
getMetadataFactory()
Returns the used metadata factory.