You are browsing the documentation for Symfony 2.4 which is not maintained anymore.
Consider upgrading your projects to Symfony 5.2.
Valid
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 | Symfony\Component\Validator\Constraints\Type |
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/Acme/HelloBundle/Entity/Address.php
namespace Acme\HelloBundle\Entity;
class Address
{
protected $street;
protected $zipCode;
}
|
1 2 3 4 5 6 7 8 9 | // src/Acme/HelloBundle/Entity/Author.php
namespace Acme\HelloBundle\Entity;
class Author
{
protected $firstName;
protected $lastName;
protected $address;
}
|
- YAML
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: ~
- Annotations
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/Acme/HelloBundle/Entity/Address.php namespace Acme\HelloBundle\Entity; use Symfony\Component\Validator\Constraints as Assert; class Address { /** * @Assert\NotBlank() */ protected $street; /** * @Assert\NotBlank * @Assert\Length(max = 5) */ protected $zipCode; } // src/Acme/HelloBundle/Entity/Author.php namespace Acme\HelloBundle\Entity; use Symfony\Component\Validator\Constraints as Assert; class Author { /** * @Assert\NotBlank * @Assert\Length(min = 4) */ protected $firstName; /** * @Assert\NotBlank */ protected $lastName; protected $address; }
- XML
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
<!-- src/Acme/HelloBundle/Resources/config/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 http://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd"> <class name="Acme\HelloBundle\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="Acme\HelloBundle\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>
- PHP
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
// src/Acme/HelloBundle/Entity/Address.php namespace Acme\HelloBundle\Entity; use Symfony\Component\Validator\Mapping\ClassMetadata; use Symfony\Component\Validator\Constraints as Assert; class Address { protected $street; protected $zipCode; public static function loadValidatorMetadata(ClassMetadata $metadata) { $metadata->addPropertyConstraint('street', new Assert\NotBlank()); $metadata->addPropertyConstraint('zipCode', new Assert\NotBlank()); $metadata->addPropertyConstraint('zipCode', new Assert\Length(array("max" => 5))); } } // src/Acme/HelloBundle/Entity/Author.php namespace Acme\HelloBundle\Entity; use Symfony\Component\Validator\Mapping\ClassMetadata; use Symfony\Component\Validator\Constraints as Assert; class Author { protected $firstName; protected $lastName; protected $address; public static function loadValidatorMetadata(ClassMetadata $metadata) { $metadata->addPropertyConstraint('firstName', new Assert\NotBlank()); $metadata->addPropertyConstraint('firstName', new Assert\Length(array("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.
- YAML
1 2 3 4 5
# src/Acme/HelloBundle/Resources/config/validation.yml Acme\HelloBundle\Entity\Author: properties: address: - Valid: ~
- Annotations
1 2 3 4 5 6 7 8 9 10 11 12
// src/Acme/HelloBundle/Entity/Author.php namespace Acme\HelloBundle\Entity; use Symfony\Component\Validator\Constraints as Assert; class Author { /** * @Assert\Valid */ protected $address; }
- XML
1 2 3 4 5 6 7 8 9 10 11 12
<!-- src/Acme/HelloBundle/Resources/config/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 http://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd"> <class name="Acme\HelloBundle\Entity\Author"> <property name="address"> <constraint name="Valid" /> </property> </class> </constraint-mapping>
- PHP
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
// src/Acme/HelloBundle/Entity/Author.php namespace Acme\HelloBundle\Entity; use Symfony\Component\Validator\Mapping\ClassMetadata; use Symfony\Component\Validator\Constraints as Assert; class Author { protected $address; 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 | Acme\\HelloBundle\\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 property that holds an array of objects,
then each object in that array will be validated only if this option is set
to true
.
message¶
type: string
default: This value should be true.
This is the message that will be shown if the value is false.
This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.