Unique

Дата обновления перевода 2024-07-25

Unique

Валидирует, что все элементы заданной коллекции являются уникальными (ни один из них не присутствует больше, чем единожды). По умолчанию, элементы сравниваются строго, поэтому '7' и 7 считаются разными элементами (строка и цифра, соответственно). Если вы хотите применить другую логику сравнения, используйте опцию normalizer.

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

Это ограничение может быть применено к любому свойству типа array или \Traversable. В следующем примере, $contactEmails является массивом строк:

        1
2
3
4
5
6
7
8
9
10
        // src/Entity/Person.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Person
{
    #[Assert\Unique]
    protected array $contactEmails;
}
    

        1
2
3
4
5
        # config/validator/validation.yaml
App\Entity\Person:
    properties:
        contactEmails:
            - Unique: ~
    

        1
2
3
4
5
6
7
8
9
10
11
12
        <!-- 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\Person">
        <property name="contactEmails">
            <constraint name="Unique"/>
        </property>
    </class>
</constraint-mapping>
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
        // src/Entity/Person.php
namespace App\Entity;

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

class Person
{
    // ...

    public static function loadValidatorMetadata(ClassMetadata $metadata): void
    {
        $metadata->addPropertyConstraint('contactEmails', new Assert\Unique());
    }
}
    

Опции

`fields`

тип: array | string

Это определяет ключ или ключи в коллекции, которые надо проверить на уникальность. По умолчанию, все ключи коллекции проверяются на уникальность.

Например, представьте, что у вас есть коллекция объектов, которые содержат поля latitude, longitude и label. По умолчанию, вы можете иметь дублированные координаты, если ярлыки отличаются. Установив опцию fields, вы можете заставитьь долготу+широту быть уникальными в коллекции:

        1
2
3
4
5
6
7
8
9
10
        // src/Entity/PointOfInterest.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class PointOfInterest
{
    #[Assert\Unique(fields: ['latitude', 'longitude'])]
    protected array $coordinates;
}
    

        1
2
3
4
5
6
        # config/validator/validation.yaml
App\Entity\PointOfInterest:
    properties:
        coordinates:
            - Unique:
                  fields: [latitude, longitude]
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
        <!-- 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\PointOfInterest">
        <property name="coordinates">
            <constraint name="Unique">
                <option name="fields">
                    <value>latitude</value>
                    <value>longitude</value>
                </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/PointOfInterest.php
namespace App\Entity;

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

class PointOfInterest
{
    // ...

    public static function loadValidatorMetadata(ClassMetadata $metadata): void
    {
        $metadata->addPropertyConstraint('coordinates', new Assert\Unique([
            'fields' => ['latitude', 'longitude'],
        ]));
    }
}
    

`groups`

type: array | string default: null

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

`message`

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

Это сообщение будет отображено, если хотя бы один элемент в коллекции будет повторяться.

Вы можете использовать следующие параметры в сообщении:

????????	????????
`{{ value }}`	??????? ???????? (invalid)

`normalizer`

тип: PHP-вызываемое по умолчанию: null

Эта опция определяет PHP-вызываемое, применимое к каждому элементу заданной коллекции, до проверки валидности коллекции.

Например, вы можете передать строку 'trim', чтобы применить PHP-функцию trim к каждому элементу коллекции, для того, чтобы игнорировать пробелы в начале и конце во время валидации.

Дата обновления перевода 2024-07-25

payload

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

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

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

??????????? ?	???????? ??? ??????
?????	Unique
?????????	UniqueValidator