Дата обновления перевода 2021-09-29

AtLeastOneOf

Это ограничение проверяте, чтобы значение удовлетворяло хотя бы одно из заданных ограничений. Валидация прекращается, как только одно ограничение удовлетворено.

New in version 5.1: Ограничение AtLeastOneOf было представлено в Symfony 5.1.

Применяется свойство или метод
к опциям
Класс AtLeastOneOf
Валидатор AtLeastOneOfValidator

Базовое использование

Следущие ограничения гарантируют, что:

  • password в Student содержит #, либо имеет хотя бы 10 символов;
  • grades в Student - это массив, содержащий хотя бы 3 элемента, или что каждый элемент более чем, или равен 5.
  • 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
    // src/Entity/Student.php
    namespace App\Entity;
    
    use Symfony\Component\Validator\Constraints as Assert;
    
    class Student
    {
        /**
         * @Assert\AtLeastOneOf({
         *     @Assert\Regex("/#/"),
         *     @Assert\Length(min=10)
         * })
         */
        protected $password;
    
        /**
         * @Assert\AtLeastOneOf({
         *     @Assert\Count(min=3),
         *     @Assert\All(
         *         @Assert\GreaterThanOrEqual(5)
         *     )
         * })
         */
        protected $grades;
    }
    
  • YAML
     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
    
  • 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
    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>
    
  • 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
    // 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),
                        ],
                    ]),
                ],
            ]));
        }
    }
    

Опции

constraints

тип: array [опция по умолчанию]

Эта обязательная опция - массив ограничений валидации, из которых хотя бы одно должно быть удовлетворено, чтобы валидация была успешной.

includeInternalMessages

тип: boolean по умолчанию: true

Если установлена, как true, сообщение, отображаемое при неудачной валидации, будет включать в себя список сообщений для внутренних ограничений. См. опцию message, чтобы увидеть пример.

message

тип: string по умолчанию: Это значение должно удовлетворять хотя бы одно из следующих ограничений:

Это начало сообщения, которое будет отображено при неудачной валидации. По умолчанию, за этим будет следовать список сообщений для внутренних ограничений (конфигурируемый опцией includeInternalMessages). Например, если вышеописанное свойство grades не пройдет валидацию, сообщение будет таким: Это значение должно удовлетворять хотя бы одно из следующих ограничений: [1] Данная коллекция должна содержать 3 или более элементов. [2] Кадлый элемент данной коллекции должен удовлетворять собственный набор ограничений.

messageCollection

тип: string по умолчанию: Каждый элемент данной коллекции должен удовлетворять собственный набор ограничений.

Это сообщение будет отображаться при неудачной валидации и если внутреннее ограничение либо All, либо Collection. См. оцпию message, чтобы увидеть пример.

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.

Эта документация является переводом официальной документации Symfony и предоставляется по свободной лицензии CC BY-SA 3.0.