The validator is stopped at the Person node, both the root and the
value (see {@link getValue}) of the context point to the Person
instance. The property path is empty at this point (see {@link getPropertyPath}).
The metadata of the context is the metadata of the Person node
(see {@link getMetadata}).

After advancing to the property $firstName of the Person
instance, the state of the context looks like this:

The validator is stopped at the property $firstName. The root still
points to the Person instance, because this is where the validation
started. The property path is now "firstName" and the current value is the
value of that property.

After advancing to the $address property and then to the
$street property of the Address instance, the context state
looks like this:

The validator is stopped at the property $street. The root still
points to the Person instance, but the property path is now
"address.street" and the validated value is the value of that property.

Apart from the root, the property path and the currently validated value,
the execution context also knows the metadata of the current node (see
{@link getMetadata}) which for example returns a {@link Mapping\PropertyMetadata}
or a {@link Mapping\ClassMetadata} object. he context also contains the
validation group that is currently being validated (see {@link getGroup}) and
the violations that happened up until now (see {@link getViolations}).

Apart from reading the execution context, you can also use
{@link addViolation} or {@link addViolationAt} to add new violations and
{@link validate} or {@link validateValue} to validate values that the
validator otherwise would not reach.

at line line 162

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.

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.

at line line 195

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":

Return Value

at line line 243

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

at line line 256

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.

string
getGroup()

Return Value

at line line 274

string|null
getClassName()

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

Return Value

string|null

The property name or null, if no property name could be found.

at line line 318

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.