WARNING: You are browsing the documentation for Symfony 2.4 which is not maintained anymore. Consider upgrading your projects to Symfony 4.3.

All

2.4 version

Maintained

3.4 4.3 current 4.4 master

Unmaintained

2.0 2.1 2.2 2.3 2.5 2.6 2.7 2.8 3.0 3.1 3.2 3.3 4.0 4.1 4.2

All
- Basic Usage
- Options
  - constraints

All¶

When applied to an array (or Traversable object), this constraint allows you to apply a collection of constraints to each element of the array.

Applies to	property or method
Options	constraints
Class	`All`
Validator	`AllValidator`

Basic Usage¶

Suppose that you have an array of strings, and you want to validate each entry in that array:

YAML

# src/Acme/UserBundle/Resources/config/validation.yml
Acme\UserBundle\Entity\User:
    properties:
        favoriteColors:
            - All:
                - NotBlank:  ~
                - Length:
                    min: 5

Annotations

// src/Acme/UserBundle/Entity/User.php
namespace Acme\UserBundle\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class User
{
    /**
     * @Assert\All({
     *     @Assert\NotBlank,
     *     @Assert\Length(min = 5)
     * })
     */
     protected $favoriteColors = array();
}

XML

<!-- src/Acme/UserBundle/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\UserBundle\Entity\User">
        <property name="favoriteColors">
            <constraint name="All">
                <option name="constraints">
                    <constraint name="NotBlank" />
                    <constraint name="Length">
                        <option name="min">5</option>
                    </constraint>
                </option>
            </constraint>
        </property>
    </class>
</constraint-mapping>

PHP

// src/Acme/UserBundle/Entity/User.php
namespace Acme\UserBundle\Entity;

use Symfony\Component\Validator\Mapping\ClassMetadata;
use Symfony\Component\Validator\Constraints as Assert;

class User
{
    public static function loadValidatorMetadata(ClassMetadata $metadata)
    {
        $metadata->addPropertyConstraint('favoriteColors', new Assert\All(array(
            'constraints' => array(
                new Assert\NotBlank(),
                new Assert\Length(array('min' => 5)),
            ),
        )));
    }
}

Now, each entry in the favoriteColors array will be validated to not be blank and to be at least 5 characters long.

Options¶

constraints¶

type: array [default option]

This required option is the array of validation constraints that you want to apply to each element of the underlying array.

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