Valid
Edit this pageWarning: You are browsing the documentation for Symfony 2.2, which is no longer maintained.
Read the updated version of this page for Symfony 6.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 |
Options | |
Class | Type |
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/Acme/HelloBundle/Entity/Address.php
namespace Amce\HelloBundle\Entity;
class Address
{
protected $street;
protected $zipCode;
}
1 2 3 4 5 6 7 8 9
// src/Acme/HelloBundle/Entity/Author.php
namespace Amce\HelloBundle\Entity;
class Author
{
protected $firstName;
protected $lastName;
protected $address;
}
- YAML
- Annotations
- XML
- PHP
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
# src/Acme/HelloBundle/Resources/config/validation.yml
Acme\HelloBundle\Entity\Address:
properties:
street:
- NotBlank: ~
zipCode:
- NotBlank: ~
- Length:
max: 5
Acme\HelloBundle\Entity\Author:
properties:
firstName:
- NotBlank: ~
- Length:
min: 4
lastName:
- 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.
- YAML
- Annotations
- XML
- PHP
1 2 3 4 5
# src/Acme/HelloBundle/Resources/config/validation.yml
Acme\HelloBundle\Author:
properties:
address:
- Valid: ~
If you validate an author with an invalid address now, you can see that the
validation of the Address
fields failed.
AcmeHelloBundleAuthor.address.zipCode: This value is too long. It should have 5 characters or less