Valid
Warning: You are browsing the documentation for Symfony 3.x, which is no longer maintained.
Read the updated version of this page for Symfony 7.2 (the current stable version).
This constraint is used to enable validation on objects that are embedded as properties on an object being validated. This allows you to validate an object and all sub-objects associated with it.
Applies to | property or method |
Options | |
Class | Valid |
Tip
By default, the error_bubbling
option is enabled for the
collection Field Type,
which passes the errors to the parent form. If you want to attach
the errors to the locations where they actually occur you have to
set error_bubbling
to false
.
Basic Usage
In the following example, create two classes Author
and Address
that both have constraints on their properties. Furthermore, Author
stores an Address
instance in the $address
property:
1 2 3 4 5 6 7 8
// src/AppBundle/Entity/Address.php
namespace AppBundle\Entity;
class Address
{
protected $street;
protected $zipCode;
}
1 2 3 4 5 6 7 8 9
// src/AppBundle/Entity/Author.php
namespace AppBundle\Entity;
class Author
{
protected $firstName;
protected $lastName;
protected $address;
}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
// src/AppBundle/Entity/Address.php
namespace AppBundle\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Address
{
/**
* @Assert\NotBlank
*/
protected $street;
/**
* @Assert\NotBlank
* @Assert\Length(max=5)
*/
protected $zipCode;
}
// src/AppBundle/Entity/Author.php
namespace AppBundle\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
/**
* @Assert\NotBlank
* @Assert\Length(min=4)
*/
protected $firstName;
/**
* @Assert\NotBlank
*/
protected $lastName;
protected $address;
}
With this mapping, it is possible to successfully validate an author with
an invalid address. To prevent that, add the Valid
constraint to the
$address
property.
1 2 3 4 5 6 7 8 9 10 11 12
// src/AppBundle/Entity/Author.php
namespace AppBundle\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
/**
* @Assert\Valid
*/
protected $address;
}
If you validate an author with an invalid address now, you can see that
the validation of the Address
fields failed.
1 2
AppBundle\\Author.address.zipCode:
This value is too long. It should have 5 characters or less.
Options
traverse
type: boolean
default: true
If this constraint is applied to a \Traversable
, then all containing values
will be validated if this option is set to true
. This option is ignored on
arrays: Arrays are traversed in either case. Keys are not validated.
payload
type: mixed
default: null
This option can be used to attach arbitrary domain-specific data to a constraint. The configured payload is not used by the Validator component, but its processing is completely up to you.
For example, you may want to use several error levels to present failed constraints differently in the front-end depending on the severity of the error.
groups
type: array
| string
It defines the validation group or groups this constraint belongs to. Read more about validation groups.