AtLeastOneOf

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).

AtLeastOneOf

This constraint checks that the value satisfies at least one of the given constraints. The validation stops as soon as one constraint is satisfied.

Applies to	property or method
Class	AtLeastOneOf
Validator	AtLeastOneOfValidator

Basic Usage

The following constraints ensure that:

the password of a Student either contains # or is at least 10 characters long;
the grades of a Student is an array which contains at least 3 elements or that each element is greater than or equal to 5.

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
        // src/Entity/Student.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;

// IMPORTANT: nested attributes requires PHP 8.1 or higher
class Student
{
    #[Assert\AtLeastOneOf([
        new Assert\Regex('/#/'),
        new Assert\Length(min: 10),
    ])]
    protected $plainPassword;

    #[Assert\AtLeastOneOf([
        new Assert\Count(min: 3),
        new Assert\All(
            new Assert\GreaterThanOrEqual(5)
        ),
    ])]
    protected $grades;
}
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
        # config/validator/validation.yaml
App\Entity\Student:
    properties:
        password:
            - AtLeastOneOf:
                - Regex: '/#/'
                - Length:
                    min: 10
        grades:
            - AtLeastOneOf:
                - Count:
                    min: 3
                - All:
                    - GreaterThanOrEqual: 5
    

        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
        <!-- 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\Student">
        <property name="password">
            <constraint name="AtLeastOneOf">
                <option name="constraints">
                    <constraint name="Regex">
                        <option name="pattern">/#/</option>
                    </constraint>
                    <constraint name="Length">
                        <option name="min">10</option>
                    </constraint>
                </option>
            </constraint>
        </property>
        <property name="grades">
            <constraint name="AtLeastOneOf">
                <option name="constraints">
                    <constraint name="Count">
                        <option name="min">3</option>
                    </constraint>
                    <constraint name="All">
                        <option name="constraints">
                            <constraint name="GreaterThanOrEqual">
                                5
                            </constraint>
                        </option>
                    </constraint>
                </option>
            </constraint>
        </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
        // src/Entity/Student.php
namespace App\Entity;

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

class Student
{
    public static function loadValidatorMetadata(ClassMetadata $metadata)
    {
        $metadata->addPropertyConstraint('password', new Assert\AtLeastOneOf([
            'constraints' => [
                new Assert\Regex(['pattern' => '/#/']),
                new Assert\Length(['min' => 10]),
            ],
        ]));

        $metadata->addPropertyConstraint('grades', new Assert\AtLeastOneOf([
            'constraints' => [
                new Assert\Count(['min' => 3]),
                new Assert\All([
                    'constraints' => [
                        new Assert\GreaterThanOrEqual(5),
                    ],
                ]),
            ],
        ]));
    }
}
    

Options

constraints

type: array [default option]

This required option is the array of validation constraints from which at least one of has to be satisfied in order for the validation to succeed.

includeInternalMessages

type: boolean default: true

If set to true, the message that is shown if the validation fails, will include the list of messages for the internal constraints. See option message for an example.

message

type: string default: This value should satisfy at least one of the following constraints:

This is the intro of the message that will be shown if the validation fails. By default, it will be followed by the list of messages for the internal constraints (configurable by includeInternalMessages option) . For example, if the above grades property fails to validate, the message will be This value should satisfy at least one of the following constraints: [1] This collection should contain 3 elements or more. [2] Each element of this collection should satisfy its own set of constraints.

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.

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

TOC

Version

AtLeastOneOf

AtLeastOneOf

Basic Usage

Options

constraints

includeInternalMessages

message

messageCollection

`groups`

`payload`

Become a Symfony contributor