Valid
Warning: You are browsing the documentation for Symfony 6.0, which is no longer maintained.
Read the updated version of this page for Symfony 7.1 (the current stable version).
Valid
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 |
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/Entity/Address.php
namespace App\Entity;
class Address
{
protected $street;
protected $zipCode;
}
1 2 3 4 5 6 7 8 9
// src/Entity/Author.php
namespace App\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
// src/Entity/Address.php
namespace App\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Address
{
#[Assert\NotBlank]
protected $street;
#[Assert\NotBlank]
#[Assert\Length(max: 5)]
protected $zipCode;
}
// src/Entity/Author.php
namespace App\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
#[Assert\NotBlank]
#[Assert\Length(min: 4)]
protected $firstName;
#[Assert\NotBlank]
protected $lastName;
protected $address;
}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
# config/validator/validation.yaml
App\Entity\Address:
properties:
street:
- NotBlank: ~
zipCode:
- NotBlank: ~
- Length:
max: 5
App\Entity\Author:
properties:
firstName:
- NotBlank: ~
- Length:
min: 4
lastName:
- NotBlank: ~
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
<!-- config/validator/validation.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping https://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">
<class name="App\Entity\Address">
<property name="street">
<constraint name="NotBlank"/>
</property>
<property name="zipCode">
<constraint name="NotBlank"/>
<constraint name="Length">
<option name="max">5</option>
</constraint>
</property>
</class>
<class name="App\Entity\Author">
<property name="firstName">
<constraint name="NotBlank"/>
<constraint name="Length">
<option name="min">4</option>
</constraint>
</property>
<property name="lastName">
<constraint name="NotBlank"/>
</property>
</class>
</constraint-mapping>
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
// src/Entity/Address.php
namespace App\Entity;
use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Component\Validator\Mapping\ClassMetadata;
class Address
{
public static function loadValidatorMetadata(ClassMetadata $metadata)
{
$metadata->addPropertyConstraint('street', new Assert\NotBlank());
$metadata->addPropertyConstraint('zipCode', new Assert\NotBlank());
$metadata->addPropertyConstraint('zipCode', new Assert\Length(['max' => 5]));
}
}
// src/Entity/Author.php
namespace App\Entity;
use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Component\Validator\Mapping\ClassMetadata;
class Author
{
public static function loadValidatorMetadata(ClassMetadata $metadata)
{
$metadata->addPropertyConstraint('firstName', new Assert\NotBlank());
$metadata->addPropertyConstraint('firstName', new Assert\Length(['min' => 4]));
$metadata->addPropertyConstraint('lastName', new Assert\NotBlank());
}
}
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
// src/Entity/Author.php
namespace App\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
#[Assert\Valid]
protected $address;
}
1 2 3 4 5
# config/validator/validation.yaml
App\Entity\Author:
properties:
address:
- Valid: ~
1 2 3 4 5 6 7 8 9 10 11 12
<!-- config/validator/validation.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping https://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">
<class name="App\Entity\Author">
<property name="address">
<constraint name="Valid"/>
</property>
</class>
</constraint-mapping>
1 2 3 4 5 6 7 8 9 10 11 12 13
// src/Entity/Author.php
namespace App\Entity;
use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Component\Validator\Mapping\ClassMetadata;
class Author
{
public static function loadValidatorMetadata(ClassMetadata $metadata)
{
$metadata->addPropertyConstraint('address', new Assert\Valid());
}
}
If you validate an author with an invalid address now, you can see that
the validation of the Address
fields failed.
1 2
App\Entity\Author.address.zipCode:
This value is too long. It should have 5 characters or less.
Tip
If you also want to validate that the address
property is an instance of
the App\Entity\Address
class, add the Type constraint.
Options
groups
type: array
| string
It defines the validation group or groups of this constraint. Read more about validation groups.
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.
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.