DivisibleBy

Дата оновлення перекладу 2022-12-16

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,
        ]));
    }
}
    

Опції

Дата оновлення перекладу 2022-12-20

`groups`

тип: array | string

Визначаэ групу або групи валідації обмеження. Прочитайте більше про групи валідації.

`message`

тип: string за замовчуванням: Це значення має бути кратним {{ compared_value }}.

Це повідомлення, яке буде відображено, якщо значення не можна поділити на значення порівняння.

Дата оновлення перекладу 2022-12-20

`payload`

тип: mixed за замовчуванням: null

Ця опція може бути використана, щоб додати довільні дані, специфічні для домену, до обмеження. Сконфігуроване корисне навантаження не використовується компонентом Validator, але його обробка повністю залежить від вас.

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

Дата оновлення перекладу 2022-12-20

`propertyPath`

тип: string

Визначає властивість обʼєкта, чиє значення використовується для проведенння порівняння.

Наприклад, якщо ви хочете порівняти властивість $endDate якихось обʼєктів із властивістю $startDate того ж обʼєкта, використайте propertyPath="startDate"
в обмеженні порівняння $endDate.

Tip

При використанні цієї опції, її значення доступне у повідомленнях помилки як заповнювач {{ compared_value_path }}. Хоча воно не призначено для відображення у повідомленнях помилок кінцевим користувачам, це корисно при використанні API для логіки мапування на клієнтській стороні.

Дата оновлення перекладу 2022-12-20

`value`

тип: mixed [опція за замовчуванням ]

Ця опція обовʼязкова. Вона визначає значення порівняння. Вона може бути рядком, числом або обʼєктом.

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