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

DivisibleBy

Валидирует, что значение делимо на другое значение, определенное в опциях.

See also

Если вам нужно валидировать, что количество элементов в коллекции делимо на определенное число, используйте ограничение Count с опцией divisibleBy.

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

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

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

  • weight в Item предоставлена с шагом 0.25
  • quantity в Item должна быть делимой на 5
  • Annotations
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    // src/Entity/Item.php
    namespace App\Entity;
    
    use Symfony\Component\Validator\Constraints as Assert;
    
    class Item
    {
        /**
         * @Assert\DivisibleBy(0.25)
         */
        protected $weight;
    
        /**
         * @Assert\DivisibleBy(
         *     value = 5
         * )
         */
        protected $quantity;
    }
    
  • Attributes
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    // src/Entity/Item.php
    namespace App\Entity;
    
    use Symfony\Component\Validator\Constraints as Assert;
    
    class Item
    {
        #[Assert\DivisibleBy(0.25)]
        protected $weight;
    
        #[Assert\DivisibleBy(
            value: 5,
        )]
        protected $quantity;
    }
    
  • YAML
    1
    2
    3
    4
    5
    6
    7
    8
    # config/validator/validation.yaml
    App\Entity\Item:
        properties:
            weight:
                - DivisibleBy: 0.25
            quantity:
                - DivisibleBy:
                    value: 5
    
  • XML
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    <!-- 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\Item">
            <property name="weight">
                <constraint name="DivisibleBy">
                    <value>0.25</value>
                </constraint>
            </property>
            <property name="quantity">
                <constraint name="DivisibleBy">
                    <option name="value">5</option>
                </constraint>
            </property>
        </class>
    </constraint-mapping>
    
  • PHP
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    // src/Entity/Item.php
    namespace App\Entity;
    
    use Symfony\Component\Validator\Constraints as Assert;
    use Symfony\Component\Validator\Mapping\ClassMetadata;
    
    class Item
    {
        public static function loadValidatorMetadata(ClassMetadata $metadata)
        {
            $metadata->addPropertyConstraint('weight', new Assert\DivisibleBy(0.25));
    
            $metadata->addPropertyConstraint('quantity', new Assert\DivisibleBy([
                'value' => 5,
            ]));
        }
    }
    

Опции

groups

type: array | string

It defines the validation group or groups this constraint belongs to. Read more about validation groups.

message

тип: string по умолчанию: Это значение должно быть множеством {{ compared_value }}.

Это сообщение будет отображено, если значение не делимо на сравнительное значение.

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.

propertyPath

type: string

It defines the object property whose value is used to make the comparison.

For example, if you want to compare the $endDate property of some object with regard to the $startDate property of the same object, use propertyPath="startDate" in the comparison constraint of $endDate.

Tip

When using this option, its value is available in error messages as the {{ compared_value_path }} placeholder. Although it’s not intended to include it in the error messages displayed to end users, it’s useful when using APIs for doing any mapping logic on client-side.

value

type: mixed [default option]

This option is required. It defines the value to compare to. It can be a string, number or object.

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