UniqueEntity
UniqueEntity¶
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.
Applies to | class |
Options | |
Class | Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity |
Validator | Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntityValidator |
Basic Usage¶
Suppose you have an AppBundle bundle with a User
entity that has
an email
field. You can use the UniqueEntity
constraint to guarantee
that the email
field remains unique between all of the constraints in
your user table:
- Annotations
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
// src/AppBundle/Entity/Author.php namespace AppBundle\Entity; 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
1 2 3 4 5 6 7
# src/AppBundle/Resources/config/validation.yml AppBundle\Entity\Author: constraints: - Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity: email properties: email: - Email: ~
- XML
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
<!-- src/AppBundle/Resources/config/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 http://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd"> <class name="AppBundle\Entity\Author"> <constraint name="Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity"> <option name="fields">email</option> </constraint> <property name="email"> <constraint name="Email" /> </property> </class> </constraint-mapping>
- PHP
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
// src/AppBundle/Entity/User.php namespace AppBundle\Entity; use Symfony\Component\Validator\Constraints as Assert; // DON'T forget this use statement!!! use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity; class Author { public static function loadValidatorMetadata(ClassMetadata $metadata) { $metadata->addConstraint(new UniqueEntity(array( 'fields' => 'email', ))); $metadata->addPropertyConstraint('email', new Assert\Email()); } }
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, if you specified both the email
and name
field in a single UniqueEntity
constraint, then it would enforce that
the combination value is unique (e.g. two users could have the same email,
as long as they don’t have the same name also).
If you need to require two fields to be individually unique (e.g. a unique
email
and a unique username
), you use two UniqueEntity
entries,
each with a single field.
message¶
type: string
default: This value is already used.
The message that’s displayed when this constraint fails. This message is always mapped to the first field causing the violation, even when using multiple fields in the constraint.
New in version 3.1: The ability to include the invalid value into the message was introduced in Symfony 3.1.
Messages can include the {{ value }}
placeholder to display a string
representation of the invalid entity. If the entity doesn’t define the
__toString()
method, the following generic value will be used: “Object of
class __CLASS__ identified by <comma separated IDs>”
em¶
type: string
The name of the entity manager to use for making the query to determine the uniqueness. If it’s left blank, the correct entity manager will be determined for this class. For that reason, this option should probably not need to be used.
repositoryMethod¶
type: string
default: findBy()
The name of the repository method to use for making the query to determine
the uniqueness. If it’s left blank, the findBy()
method will be used.
This method should return a countable result.
errorPath¶
type: string
default: The name of the first field in fields
If the entity violates the constraint the error message is bound to the first field in fields. If there is more than one field, you may want to map the error message to another field.
Consider this example:
- Annotations
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
// src/AppBundle/Entity/Service.php namespace AppBundle\Entity; use Doctrine\ORM\Mapping as ORM; use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity; /** * @ORM\Entity * @UniqueEntity( * fields={"host", "port"}, * errorPath="port", * message="This port is already in use on that host." * ) */ class Service { /** * @ORM\ManyToOne(targetEntity="Host") */ public $host; /** * @ORM\Column(type="integer") */ public $port; }
- YAML
1 2 3 4 5 6 7
# src/AppBundle/Resources/config/validation.yml AppBundle\Entity\Service: constraints: - Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity: fields: [host, port] errorPath: port message: 'This port is already in use on that host.'
- XML
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
<!-- src/AppBundle/Resources/config/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 http://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd"> <class name="AppBundle\Entity\Service"> <constraint name="Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity"> <option name="fields"> <value>host</value> <value>port</value> </option> <option name="errorPath">port</option> <option name="message">This port is already in use on that host.</option> </constraint> </class> </constraint-mapping>
- PHP
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
// src/AppBundle/Entity/Service.php namespace AppBundle\Entity; use Symfony\Component\Validator\Mapping\ClassMetadata; use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity; class Service { public $host; public $port; public static function loadValidatorMetadata(ClassMetadata $metadata) { $metadata->addConstraint(new UniqueEntity(array( 'fields' => array('host', 'port'), 'errorPath' => 'port', 'message' => 'This port is already in use on that host.', ))); } }
Now, the message would be bound to the port
field with this configuration.
ignoreNull¶
type: boolean
default: true
If this option is set to true
, then the constraint will allow multiple
entities to have a null
value for a field without failing validation.
If set to false
, only one null
value is allowed - if a second entity
also has a null
value, validation would fail.
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.