Unique
Edit this pageWarning: You are browsing the documentation for Symfony 4.4, which is no longer maintained.
Read the updated version of this page for Symfony 6.2 (the current stable version).
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).
See also
If you want to apply different validation constraints to the elements of a collection or want to make sure that certain collection keys are present, use the Collection constraint.
See also
If you want to validate that the value of an entity property is unique among all entities of the same type (e.g. the registration email of all users) use the UniqueEntity constraint.
| Applies to | property or method |
| Class | Unique |
| Validator | UniqueValidator |
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
- YAML
- XML
- PHP
1 2 3 4 5 6 7 8 9 10 11 12
// src/Entity/Person.php
namespace App\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Person
{
/**
* @Assert\Unique
*/
protected $contactEmails;
}Options
groups
type: array | string
It defines the validation group or groups of this constraint. 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 current (invalid) 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.
