webbertakken/DtoUniqueEntity.php

Example usage:

fieldMapping should hold a property from the DTO as key and a property from the Entity as value.

<?php

namespace App\Form\DataTransferObject;

use App\Validator\Constraints\DtoUniqueEntity;
use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Validator\Constraints as Assert;

/**
 * @DtoUniqueEntity(
 *     entityClass="App\Entity\User",
 *     fieldMapping={"emailAddress": "emailAddress"}
 * )
 */
class UserRegistrationData implements DataTransferObjectInterface
{
    /**
     * @var string
     * @Assert\NotBlank()
     * @Assert\Email()
     * @ORM\Column(type="string")
     */
    public $emailAddress;

    /**
     * @var string
     * @Assert\NotBlank()
     * @Assert\Length(
     *     min="10",
     *     minMessage="Strong passwords have a minimum of 10 characters.",
     *     max="2048",
     *     maxMessage="Did you type all this?"
     * )
     */
    public $password;

    /**
     * @var bool
     * @Assert\IsTrue(message="You must accept these to create an account.")
     */
    public $termsAccepted;
}

@webbertakken, first of all, thank you for sharing your solution.

I need your help :) How would your solution work with Embeddables?

I got an entity (User) which has an Embedded (EmailAddress):

/**
 * @ORM\Embedded(class="EmailAddress")
 */
private $email;

On userRepository I use it like this:

$queryBuilder->expr()->eq('u.email.address', ':email');

But this does not work:

/**
 * @DtoUniqueEntity(entityClass="App\Entity\User", fieldMapping={"email": "email.address"}, message="Email already taken")
 * @DtoUniqueEntity(entityClass="App\Entity\User", fieldMapping={"username": "username"}, message="Username already taken")
 */

Because of this:

// Entity Property (value) should exist in the Entity Class
if (!property_exists($this->constraint->entityClass, $entityField)) {
	throw new ConstraintDefinitionException(sprintf(
		'Property for fieldMapping key "%s" does not exist in given EntityClass.',
		$objectField
	));
}

(property email.address does not really exist on entity User because it's an Embedded Object Value mapped to property email)

I have also tried with Embedded without column prefix (columnPrefix=false), but then it passes the property_exists check but fails on Doctrine Query parser, because there it should be 'address' (or whatever property the Embeddable has on its own class).

Thank you in advance <3

Nvm, thank you anyways.
I've just removed the extra check of:

-// Entity Property (value) should exist in the Entity Class
-if (!property_exists($this->constraint->entityClass, $entityField)) {
-	throw new ConstraintDefinitionException(sprintf(
-		'Property for fieldMapping key "%s" does not exist in given EntityClass.',
-		$objectField
-	));
-}

Because after that there is this one:

if (!$this->entityMeta->hasField($entityField) && !$this->entityMeta->hasAssociation($entityField)) {
	throw new ConstraintDefinitionException(sprintf(
		'The field "%s" is not mapped by Doctrine, so it cannot be validated for uniqueness.',
		$entityField
	));
}

When the field exists on ClassMetadata->fieldMappings (which it does when it's Embedded too) this will pass & if it doesn't pass it's because the property does not exist o it's not mapped by Doctrine.

Right now in SF 5.1.x UniqueConstraintViolationException requires a second argument: \Doctrine\DBAL\Driver\DriverException
What should I put there in this example? (line 163)

@sabat24 I could update the example if you provide me with a proposed diff.

I mentioned about it because I use Doctrine DBAL v.2.1.0 (lately v 3.x was released but I didn't check if problem still appears there) and your dependencies allow that. Which leads to a problem that you use following code to throw an exception: throw new UniqueConstraintViolationException('Unique value can not be NULL');

The UniqueConstraintViolationException extends finally Doctrine\DBAL\Exception\DriverException which has got following constructor

    /**
     * @param string                                $message         The exception message.
     * @param \Doctrine\DBAL\Driver\DriverException $driverException The DBAL driver exception to chain.
     */
    public function __construct($message, \Doctrine\DBAL\Driver\DriverException $driverException)

So there is a missing second parameter in your code.

I'm going to call this deprecated in favour of the 7.1 branch of Symfony core.

@fabpot closed symfony/symfony#22592 (comment) as completed in symfony/symfony@5bc490c 1 hour ago