custom/plugins/SwagCmsExtensions/src/Form/Validation/TechnicalNameValidator.php line 40

Open in your IDE?
  1. <?php declare(strict_types=1);
  2. /*
  3.  * (c) shopware AG <info@shopware.com>
  4.  * For the full copyright and license information, please view the LICENSE
  5.  * file that was distributed with this source code.
  6.  */
  8. namespace Swag\CmsExtensions\Form\Validation;
  10. use Doctrine\DBAL\Connection;
  11. use Doctrine\DBAL\Driver\ResultStatement;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\DeleteCommand;
  13. use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\InsertCommand;
  14. use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\UpdateCommand;
  15. use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\WriteCommand;
  16. use Shopware\Core\Framework\DataAbstractionLayer\Write\Validation\PreWriteValidationEvent;
  17. use Shopware\Core\Framework\Validation\WriteConstraintViolationException;
  18. use Swag\CmsExtensions\Form\FormDefinition;
  19. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  20. use Symfony\Component\Validator\ConstraintViolation;
  21. use Symfony\Component\Validator\ConstraintViolationList;
  22. use Symfony\Component\Validator\ConstraintViolationListInterface;
  24. class TechnicalNameValidator implements EventSubscriberInterface
  25. {
  26.     private Connection $connection;
  28.     public function __construct(Connection $connection)
  29.     {
  30.         $this->connection = $connection;
  31.     }
  33.     public static function getSubscribedEvents(): array
  34.     {
  35.         return [
  36.             PreWriteValidationEvent::class => 'preValidate',
  37.         ];
  38.     }
  40.     public function preValidate(PreWriteValidationEvent $event): void
  41.     {
  42.         $violationList = new ConstraintViolationList();
  43.         foreach ($event->getCommands() as $command) {
  44.             if (!($command instanceof InsertCommand || $command instanceof UpdateCommand)) {
  45.                 continue;
  46.             }
  48.             if ($command->getDefinition()->getClass() !== FormDefinition::class) {
  49.                 continue;
  50.             }
  52.             $violationList->addAll($this->validateTechnicalName($command, $event));
  53.         }
  55.         if ($violationList->count() > 0) {
  56.             $event->getExceptions()->add(new WriteConstraintViolationException($violationList));
  58.             return;
  59.         }
  60.     }
  62.     private function validateTechnicalName(WriteCommand $command, PreWriteValidationEvent $event): ConstraintViolationListInterface
  63.     {
  64.         $violationList = new ConstraintViolationList();
  65.         $payload = $command->getPayload();
  67.         if (!isset($payload['technical_name'])) {
  68.             return $violationList;
  69.         }
  71.         if ($this->isTechnicalNameUnique($command->getPrimaryKey()['id'], $payload['technical_name'], $event)) {
  72.             return $violationList;
  73.         }
  75.         $messageTemplate = 'The technical name (%value%) of this form is not unique or a form template with this name already exists.';
  76.         $parameters = ['%value%' => $payload['technical_name'] ?? 'NULL'];
  78.         $violationList->add(new ConstraintViolation(
  79.             \str_replace(\array_keys($parameters), $parameters, $messageTemplate),
  80.             $messageTemplate,
  81.             $parameters,
  82.             null,
  83.             \sprintf('%s/technicalName', $command->getPath()),
  84.             null
  85.         ));
  87.         return $violationList;
  88.     }
  90.     private function isTechnicalNameUnique(string $formId, string $technicalName, PreWriteValidationEvent $event): bool
  91.     {
  92.         $ignoredIds = [$formId];
  94.         foreach ($event->getCommands() as $formCommand) {
  95.             if ($formCommand->getDefinition()->getClass() !== FormDefinition::class) {
  96.                 continue;
  97.             }
  99.             $otherId = $formCommand->getPrimaryKey()['id'];
  100.             if ($formId === $otherId) {
  101.                 continue;
  102.             }
  104.             if ($formCommand instanceof DeleteCommand) {
  105.                 $ignoredIds[] = $formCommand->getPrimaryKey()['id'];
  107.                 continue;
  108.             }
  110.             $payload = $formCommand->getPayload();
  111.             if (isset($payload['technical_name']) && $payload['technical_name'] === $technicalName) {
  112.                 return false;
  113.             }
  114.         }
  116.         $query = $this->connection->createQueryBuilder()
  117.             ->select('technical_name')
  118.             ->from(FormDefinition::ENTITY_NAME)
  119.             ->where('technical_name = :technical_name')
  120.             ->andWhere('id NOT IN (:ids)')
  121.             ->setParameter('technical_name', $technicalName)
  122.             ->setParameter('ids', $ignoredIds, Connection::PARAM_STR_ARRAY)
  123.             ->setMaxResults(1)
  124.             ->execute();
  126.         if (!($query instanceof ResultStatement)) {
  127.             return true;
  128.         }
  130.         return !(bool) $query->fetchColumn();
  131.     }
  132. }