Unique

4.4 version

Maintained

4.4 5.2 current 5.3 dev

Unmaintained

4.3 5.0 5.1

edit this page

Unique
- Basic Usage
- Options

Unique¶

Validates that all the elements of the given collection are unique (none of them is present more than once). Elements are compared strictly, so '7' and 7 are considered different elements (a string and an integer, respectively).

Basic Usage¶

This constraint can be applied to any property of type array or \Traversable. In the following example, $contactEmails is an array of strings:

Annotations

// src/Entity/Person.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Person
{
    /**
     * @Assert\Unique
     */
    protected $contactEmails;
}

YAML

# config/validator/validation.yaml
App\Entity\Person:
    properties:
        contactEmails:
            - Unique: ~

XML

<!-- 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>

PHP

// 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)
    {
        $metadata->addPropertyConstraint('contactEmails', new Assert\Unique());
    }
}

Options¶

`groups`¶

type: array | string

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

message¶

type: string default: This collection should contain only unique elements.

This is the message that will be shown if at least one element is repeated in the collection.

You can use the following parameters in this message:

Parameter	Description
`{{ value }}`	The repeated 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.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.

Applies to	property or method
Options	groups message payload
Class	`Symfony\Component\Validator\Constraints\Unique`
Validator	`Symfony\Component\Validator\Constraints\UniqueValidator`