- What is Symfony?
- Get started
- Documentation
- Community
- Services
-
News
Latest News
What happened last week in Symfony?
This week, after the successful launch of Symfony 2.3, the development activity focused on the upcoming Symfony 2.4 version. The most important change was the introduction of simpler customization options for the Security component. In addition, Symfony 2.3.1 was released to address some minor bugs.
Upcoming EventsThe Symfony Community organizes events all over the world on a regular basis. Here are the next ones.
Switzerland, Colab Zurich Zentralstrasse 37, Zürich — #5 Symfony UserGroup ZH
on June 19, 2013, from 19:00 to 22:15
Switzerland, Zurich — Symfony CMF workshop day
on June 21, 2013, from 09:00 to 18:00
Spain, Madrid — deSymfony 2013
from June 21, 2013 to June 23, 2013
Germany, Cologne — SymfonySummit
from July 04, 2013 to July 05, 2013 - About
Table of Contents
Questions & Feedback
Found a typo or an error?
Want to improve this document? Edit it.
Need support or have a technical question?
Post to the user mailing-list.
Master Symfony2 fundamentals
Symfony hosting done right
Discover the SensioLabs Support
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 | UniqueEntity |
| Validator | UniqueEntityValidator |
Basic Usage¶
Suppose you have an AcmeUserBundle 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:
- YAML
1 2 3 4 5 6 7
# src/Acme/UserBundle/Resources/config/validation.yml Acme\UserBundle\Entity\Author: constraints: - Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity: email properties: email: - Email: ~
- 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
// Acme/UserBundle/Entity/User.php namespace Acme\UserBundle\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; // ... }
- XML
1 2 3 4 5 6 7 8 9
<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>
- PHP
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
// Acme/UserBundle/Entity/User.php namespace Acme\UserBundle\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', 'message' => 'This email already exists.', ))); $metadata->addPropertyConstraint(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 where 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.
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 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.
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.
NEWS FROM THE BLOG
IN THE NEWS
is a trademark of Fabien Potencier. All rights reserved.