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

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.     /**
  27.      * @var Connection
  28.      */
  29.     private $connection;
  31.     public function __construct(Connection $connection)
  32.     {
  33.         $this->connection = $connection;
  34.     }
  36.     public static function getSubscribedEvents(): array
  37.     {
  38.         return [
  39.             PreWriteValidationEvent::class => 'preValidate',
  40.         ];
  41.     }
  43.     public function preValidate(PreWriteValidationEvent $event): void
  44.     {
  45.         $violationList = new ConstraintViolationList();
  46.         foreach ($event->getCommands() as $command) {
  47.             if (!($command instanceof InsertCommand || $command instanceof UpdateCommand)) {
  48.                 continue;
  49.             }
  51.             if ($command->getDefinition()->getClass() !== FormDefinition::class) {
  52.                 continue;
  53.             }
  55.             $violationList->addAll($this->validateTechnicalName($command, $event));
  56.         }
  58.         if ($violationList->count() > 0) {
  59.             $event->getExceptions()->add(new WriteConstraintViolationException($violationList));
  61.             return;
  62.         }
  63.     }
  65.     private function validateTechnicalName(WriteCommand $command, PreWriteValidationEvent $event): ConstraintViolationListInterface
  66.     {
  67.         $violationList = new ConstraintViolationList();
  68.         $payload = $command->getPayload();
  70.         if (!isset($payload['technical_name'])) {
  71.             return $violationList;
  72.         }
  74.         if ($this->isTechnicalNameUnique($command->getPrimaryKey()['id'], $payload['technical_name'], $event)) {
  75.             return $violationList;
  76.         }
  78.         $messageTemplate = 'The technical name (%value%) of this form is not unique or a form template with this name already exists.';
  79.         $parameters = ['%value%' => $payload['technical_name'] ?? 'NULL'];
  81.         $violationList->add(new ConstraintViolation(
  82.             \str_replace(\array_keys($parameters), $parameters, $messageTemplate),
  83.             $messageTemplate,
  84.             $parameters,
  85.             null,
  86.             \sprintf('%s/technicalName', $command->getPath()),
  87.             null
  88.         ));
  90.         return $violationList;
  91.     }
  93.     private function isTechnicalNameUnique(string $formId, string $technicalName, PreWriteValidationEvent $event): bool
  94.     {
  95.         $ignoredIds = [$formId];
  97.         foreach ($event->getCommands() as $formCommand) {
  98.             if ($formCommand->getDefinition()->getClass() !== FormDefinition::class) {
  99.                 continue;
  100.             }
  102.             $otherId = $formCommand->getPrimaryKey()['id'];
  103.             if ($formId === $otherId) {
  104.                 continue;
  105.             }
  107.             if ($formCommand instanceof DeleteCommand) {
  108.                 $ignoredIds[] = $formCommand->getPrimaryKey()['id'];
  110.                 continue;
  111.             }
  113.             $payload = $formCommand->getPayload();
  114.             if (isset($payload['technical_name']) && $payload['technical_name'] === $technicalName) {
  115.                 return false;
  116.             }
  117.         }
  119.         $query = $this->connection->createQueryBuilder()
  120.             ->select('technical_name')
  121.             ->from(FormDefinition::ENTITY_NAME)
  122.             ->where('technical_name = :technical_name')
  123.             ->andWhere('id NOT IN (:ids)')
  124.             ->setParameter('technical_name', $technicalName)
  125.             ->setParameter('ids', $ignoredIds, Connection::PARAM_STR_ARRAY)
  126.             ->setMaxResults(1)
  127.             ->execute();
  129.         if (!($query instanceof ResultStatement)) {
  130.             return true;
  131.         }
  133.         return !(bool) $query->fetchColumn();
  134.     }
  135. }