vendor/symfony/doctrine-bridge/Validator/Constraints/UniqueEntity.php line 50

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Bridge\Doctrine\Validator\Constraints;
  14. use Symfony\Component\Validator\Constraint;
  16. /**
  17.  * Constraint for the Unique Entity validator.
  18.  *
  19.  * @Annotation
  20.  * @Target({"CLASS", "ANNOTATION"})
  21.  *
  22.  * @author Benjamin Eberlei <kontakt@beberlei.de>
  23.  */
  24. #[\Attribute(\Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
  25. class UniqueEntity extends Constraint
  26. {
  27.     public const NOT_UNIQUE_ERROR = '23bd9dbf-6b9b-41cd-a99e-4844bcf3077f';
  29.     protected const ERROR_NAMES = [
  30.         self::NOT_UNIQUE_ERROR => 'NOT_UNIQUE_ERROR',
  31.     ];
  33.     public $message = 'This value is already used.';
  34.     public $service = 'doctrine.orm.validator.unique';
  35.     public $em = null;
  36.     public $entityClass = null;
  37.     public $repositoryMethod = 'findBy';
  38.     public $fields = [];
  39.     public $errorPath = null;
  40.     public $ignoreNull = true;
  42.     /**
  43.      * @deprecated since Symfony 6.1, use const ERROR_NAMES instead
  44.      */
  45.     protected static $errorNames = self::ERROR_NAMES;
  47.     /**
  48.      * @param array|string $fields the combination of fields that must contain unique values or a set of options
  49.      */
  50.     public function __construct(
  51.         $fields,
  52.         string $message = null,
  53.         string $service = null,
  54.         string $em = null,
  55.         string $entityClass = null,
  56.         string $repositoryMethod = null,
  57.         string $errorPath = null,
  58.         bool $ignoreNull = null,
  59.         array $groups = null,
  60.         $payload = null,
  61.         array $options = []
  62.     ) {
  63.         if (\is_array($fields) && \is_string(key($fields))) {
  64.             $options = array_merge($fields, $options);
  65.         } elseif (null !== $fields) {
  66.             $options['fields'] = $fields;
  67.         }
  69.         parent::__construct($options, $groups, $payload);
  71.         $this->message = $message ?? $this->message;
  72.         $this->service = $service ?? $this->service;
  73.         $this->em = $em ?? $this->em;
  74.         $this->entityClass = $entityClass ?? $this->entityClass;
  75.         $this->repositoryMethod = $repositoryMethod ?? $this->repositoryMethod;
  76.         $this->errorPath = $errorPath ?? $this->errorPath;
  77.         $this->ignoreNull = $ignoreNull ?? $this->ignoreNull;
  78.     }
  80.     public function getRequiredOptions(): array
  81.     {
  82.         return ['fields'];
  83.     }
  85.     /**
  86.      * The validator must be defined as a service with this name.
  87.      */
  88.     public function validatedBy(): string
  89.     {
  90.         return $this->service;
  91.     }
  93.     public function getTargets(): string|array
  94.     {
  95.         return self::CLASS_CONSTRAINT;
  96.     }
  98.     public function getDefaultOption(): ?string
  99.     {
  100.         return 'fields';
  101.     }
  102. }