UniqueEntity

Validates that a particular field (or fields) in a Doctrine entity 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.

Applies to	class
Options	fields message em
Class	Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity
Validator	Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity\Validator

Basic Usage

Suppose you have an AcmeUserBundle with a User entity that has an email field. You can use the Unique constraint to guarantee that the email field remains unique between all of the constrains in your user table:

• Annotations

  // Acme/UserBundle/Entity/User.php
  use Symfony\Component\Validator\Constraints as Assert;
  use Doctrine\ORM\Mapping as ORM;
  
  // DON'T forget this use statement!!!
  use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
  
  /**
   * @ORM\Entity
   * @UniqueEntity("email")
   */
  class Author
  {
      /**
       * @var string $email
       *
       * @ORM\Column(name="email", type="string", length=255, unique=true)
       * @Assert\Email()
       */
      protected $email;
  
      // ...
  }
  

• YAML

  # src/Acme/UserBundle/Resources/config/validation.yml
  Acme\UserBundle\Entity\Author:
      constraints:
          - Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity: email
      properties:
          email:
              - Email: ~
  

• XML

  <class name="Acme\UserBundle\Entity\Author">
      <constraint name="Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity">
          <option name="fields">email</option>
          <option name="message">This email already exists.</option>
      </constraint>
       <property name="email">
          <constraint name="Email" />
      </property>
  </class>
  

Options

fields

type: array``|``string [default option]

This required option is the field (or list of fields) on which this entity should be unique. For example, you could specify that both the email and name fields in the User example above should be unique.

message

type: string default: This value is already used.

The message that’s displayed with this constraint fails.

em

type: string

The name of the entity manager to use for making the query to determine the uniqueness. If left blank, the correct entity manager will determined for this class. For that reason, this option should probably not need to be used.