DivisibleBy

Дата обновления перевода 2023-01-14

DivisibleBy

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

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

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

weight в Item предоставлена с шагом 0.25
quantity в Item должна быть делимой на 5

Attributes
YAML
XML
PHP

        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;
}
    

        1
2
3
4
5
6
7
8
        # config/validator/validation.yaml
App\Entity\Item:
    properties:
        weight:
            - DivisibleBy: 0.25
        quantity:
            - DivisibleBy:
                value: 5
    

        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>
    

        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 of this constraint. Read more about validation groups.

`message`

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

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

payload

тип: mixed по умолчанию: null

Эта опция может быть использована, чтобы добавить к ограничению произвольные данные, относящиеся к домену. Сконфигурированная нагрузка не используется компонентом Валидатор, но его обработка полностью зависит от вас.

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

propertyPath

тип: string

Определяет свойство объекта, значение которого используется, чтобы провести сравнение.

Например, если вы хотите сравнить свойство $endDate некоторого объекта касательно свойства $startDate того же объекта, используйте propertyPath="startDate" в ограничении сравнения $endDate.

value

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

Эта опция обязательна. Она определяет значеие для сравнения. Это может быть строка, число или объект.

??????????? ?	???????? ??? ??????
?????	DivisibleBy
?????????	DivisibleByValidator