Return Value

at line 124

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 132

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 144

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 154

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 164

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 172

string
getGroup()

Returns the validation group that is currently being validated.

Return Value

string

The current validation group

at line 180

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 196

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

at line 209

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