Skip to content

Documented the new Unique constraint #11247

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions reference/constraints/Collection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ constraint.
This constraint can also make sure that certain collection keys are present
and that extra keys are not present.

.. seealso::

If you want to validate that all the elements of the collection are unique
(none of them is present more than once) use the
:doc:`Unique constraint </reference/constraints/Unique>`.

========== ===================================================================
Applies to :ref:`property or method <validation-property-target>`
Options - `allowExtraFields`_
Expand Down
113 changes: 113 additions & 0 deletions reference/constraints/Unique.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
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).

.. seealso::

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 :doc:`Collection constraint </reference/constraints/Collection>`.

.. seealso::

If you want to validate that a given entity property is unique among all
entities (e.g. the user email) use the
:doc:`UniqueEntity constraint </reference/constraints/UniqueEntity>`.

========== ===================================================================
Applies to :ref:`property or method <validation-property-target>`
Options - `groups`_
- `message`_
- `payload`_
Class :class:`Symfony\\Component\\Validator\\Constraints\\Unique`
Validator :class:`Symfony\\Component\\Validator\\Constraints\\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:

.. configuration-block::

.. code-block:: php-annotations

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

use Symfony\Component\Validator\Constraints as Assert;

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

.. code-block:: yaml

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

.. code-block:: 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>

.. code-block:: php

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

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

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

Options
-------

.. include:: /reference/constraints/_groups-option.rst.inc

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

.. include:: /reference/constraints/_payload-option.rst.inc
6 changes: 6 additions & 0 deletions reference/constraints/UniqueEntity.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ Validates that a particular field (or fields) in a Doctrine entity is (are)
unique. This is commonly used, for example, to prevent a new user to register
using an email address that already exists in the system.

.. seealso::

If you want to validate that all the elements of the collection are unique
(none of them is present more than once) use the
:doc:`Unique constraint </reference/constraints/Unique>`.

========== ===================================================================
Applies to :ref:`class <validation-class-target>`
Options - `em`_
Expand Down
1 change: 1 addition & 0 deletions reference/constraints/map.rst.inc
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ Comparison Constraints
* :doc:`GreaterThanOrEqual </reference/constraints/GreaterThanOrEqual>`
* :doc:`Range </reference/constraints/Range>`
* :doc:`DivisibleBy </reference/constraints/DivisibleBy>`
* :doc:`Unique </reference/constraints/Unique>`

Date Constraints
~~~~~~~~~~~~~~~~
Expand Down