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 toproperty or method
Options
ClassSymfony\Component\Validator\Constraints\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. // src/Entity/Address.php
  2. namespace App\Entity;
  4. class Address
  5. {
  6.     protected $street;
  7.     protected $zipCode;
  8. }
  1. // src/Entity/Author.php
  2. namespace App\Entity;
  4. class Author
  5. {
  6.     protected $firstName;
  7.     protected $lastName;
  8.     protected $address;
  9. }

  • Annotations

    1. // src/Entity/Address.php
    2. namespace App\Entity;
    4. use Symfony\Component\Validator\Constraints as Assert;
    6. class Address
    7. {
    8.     /**
    9.      * @Assert\NotBlank
    10.      */
    11.     protected $street;
    13.     /**
    14.      * @Assert\NotBlank
    15.      * @Assert\Length(max=5)
    16.      */
    17.     protected $zipCode;
    18. }
    20. // src/Entity/Author.php
    21. namespace App\Entity;
    23. use Symfony\Component\Validator\Constraints as Assert;
    25. class Author
    26. {
    27.     /**
    28.      * @Assert\NotBlank
    29.      * @Assert\Length(min=4)
    30.      */
    31.     protected $firstName;
    33.     /**
    34.      * @Assert\NotBlank
    35.      */
    36.     protected $lastName;
    38.     protected $address;
    39. }

  • YAML

    1. # config/validator/validation.yaml
    2. App\Entity\Address:
    3.     properties:
    4.         street:
    5.             - NotBlank: ~
    6.         zipCode:
    7.             - NotBlank: ~
    8.             - Length:
    9.                 max: 5
    11. App\Entity\Author:
    12.     properties:
    13.         firstName:
    14.             - NotBlank: ~
    15.             - Length:
    16.                 min: 4
    17.         lastName:
    18.             - NotBlank: ~

  • XML

    1. <!-- config/validator/validation.xml -->
    2. <?xml version="1.0" encoding="UTF-8" ?>
    3. <constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping"
    4.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    5.     xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping https://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">
    7.     <class name="App\Entity\Address">
    8.         <property name="street">
    9.             <constraint name="NotBlank"/>
    10.         </property>
    11.         <property name="zipCode">
    12.             <constraint name="NotBlank"/>
    13.             <constraint name="Length">
    14.                 <option name="max">5</option>
    15.             </constraint>
    16.         </property>
    17.     </class>
    19.     <class name="App\Entity\Author">
    20.         <property name="firstName">
    21.             <constraint name="NotBlank"/>
    22.             <constraint name="Length">
    23.                 <option name="min">4</option>
    24.             </constraint>
    25.         </property>
    26.         <property name="lastName">
    27.             <constraint name="NotBlank"/>
    28.         </property>
    29.     </class>
    30. </constraint-mapping>

  • PHP

    1. // src/Entity/Address.php
    2. namespace App\Entity;
    4. use Symfony\Component\Validator\Constraints as Assert;
    5. use Symfony\Component\Validator\Mapping\ClassMetadata;
    7. class Address
    8. {
    9.     public static function loadValidatorMetadata(ClassMetadata $metadata)
    10.     {
    11.         $metadata->addPropertyConstraint('street', new Assert\NotBlank());
    12.         $metadata->addPropertyConstraint('zipCode', new Assert\NotBlank());
    13.         $metadata->addPropertyConstraint('zipCode', new Assert\Length(['max' => 5]));
    14.     }
    15. }
    17. // src/Entity/Author.php
    18. namespace App\Entity;
    20. use Symfony\Component\Validator\Constraints as Assert;
    21. use Symfony\Component\Validator\Mapping\ClassMetadata;
    23. class Author
    24. {
    25.     public static function loadValidatorMetadata(ClassMetadata $metadata)
    26.     {
    27.         $metadata->addPropertyConstraint('firstName', new Assert\NotBlank());
    28.         $metadata->addPropertyConstraint('firstName', new Assert\Length(['min' => 4]));
    29.         $metadata->addPropertyConstraint('lastName', new Assert\NotBlank());
    30.     }
    31. }

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.

  • Annotations

    1. // src/Entity/Author.php
    2. namespace App\Entity;
    4. use Symfony\Component\Validator\Constraints as Assert;
    6. class Author
    7. {
    8.     /**
    9.      * @Assert\Valid
    10.      */
    11.     protected $address;
    12. }

  • YAML

    1. # config/validator/validation.yaml
    2. App\Entity\Author:
    3.     properties:
    4.         address:
    5.             - Valid: ~

  • XML

    1. <!-- config/validator/validation.xml -->
    2. <?xml version="1.0" encoding="UTF-8" ?>
    3. <constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping"
    4.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    5.     xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping https://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">
    7.     <class name="App\Entity\Author">
    8.         <property name="address">
    9.             <constraint name="Valid"/>
    10.         </property>
    11.     </class>
    12. </constraint-mapping>

  • PHP

    1. // src/Entity/Author.php
    2. namespace App\Entity;
    4. use Symfony\Component\Validator\Constraints as Assert;
    5. use Symfony\Component\Validator\Mapping\ClassMetadata;
    7. class Author
    8. {
    9.     public static function loadValidatorMetadata(ClassMetadata $metadata)
    10.     {
    11.         $metadata->addPropertyConstraint('address', new Assert\Valid());
    12.     }
    13. }

If you validate an author with an invalid address now, you can see that the validation of the Address fields failed.

  1. App\Entity\Author.address.zipCode:
  2.     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 this constraint belongs to. 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.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.