vendor/shopware/core/Content/Category/Validation/EntryPointValidator.php line 48

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Category\Validation;
  5. use Doctrine\DBAL\Connection;
  6. use Doctrine\DBAL\Driver\ResultStatement;
  7. use Shopware\Core\Content\Category\CategoryDefinition;
  8. use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\InsertCommand;
  9. use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\UpdateCommand;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\WriteCommand;
  11. use Shopware\Core\Framework\DataAbstractionLayer\Write\Validation\PostWriteValidationEvent;
  12. use Shopware\Core\Framework\Validation\WriteConstraintViolationException;
  13. use Shopware\Core\System\SalesChannel\SalesChannelDefinition;
  14. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  15. use Symfony\Component\Validator\ConstraintViolation;
  16. use Symfony\Component\Validator\ConstraintViolationList;
  17. use Symfony\Component\Validator\ConstraintViolationListInterface;
  19. /**
  20.  * @deprecated tag:v6.5.0 - reason:becomes-internal - EventSubscribers will become internal in v6.5.0
  21.  */
  22. class EntryPointValidator implements EventSubscriberInterface
  23. {
  24.     private const ERROR_CODE = 'CONTENT__INVALID_CATEGORY_TYPE_AS_ENTRY_POINT';
  26.     private const ALLOWED_TYPE_CHANGE = [
  27.         CategoryDefinition::TYPE_PAGE,
  28.         CategoryDefinition::TYPE_FOLDER,
  29.     ];
  31.     private Connection $connection;
  33.     /**
  34.      * @internal
  35.      */
  36.     public function __construct(Connection $connection)
  37.     {
  38.         $this->connection = $connection;
  39.     }
  41.     public static function getSubscribedEvents(): array
  42.     {
  43.         return [
  44.             PostWriteValidationEvent::class => 'postValidate',
  45.         ];
  46.     }
  48.     public function postValidate(PostWriteValidationEvent $event): void
  49.     {
  50.         $violationList = new ConstraintViolationList();
  51.         foreach ($event->getCommands() as $command) {
  52.             if (!($command instanceof InsertCommand || $command instanceof UpdateCommand)) {
  53.                 continue;
  54.             }
  56.             if ($command->getDefinition()->getClass() !== CategoryDefinition::class) {
  57.                 continue;
  58.             }
  60.             if (!isset($command->getPayload()['type'])) {
  61.                 continue;
  62.             }
  64.             $violationList->addAll($this->checkTypeChange($command, $event));
  65.         }
  67.         if ($violationList->count() > 0) {
  68.             $event->getExceptions()->add(new WriteConstraintViolationException($violationList));
  70.             return;
  71.         }
  72.     }
  74.     private function checkTypeChange(WriteCommand $command, PostWriteValidationEvent $event): ConstraintViolationListInterface
  75.     {
  76.         $violationList = new ConstraintViolationList();
  77.         $payload = $command->getPayload();
  79.         if (\in_array($payload['type'], self::ALLOWED_TYPE_CHANGE, true)) {
  80.             return $violationList;
  81.         }
  83.         if ($this->isCategoryEntryPoint($command->getPrimaryKey()['id'], $event)) {
  84.             return $violationList;
  85.         }
  87.         $messageTemplate = 'The type can not be assigned while category is entry point.';
  88.         $parameters = ['{{ value }}' => $payload['type']];
  90.         $violationList->add(new ConstraintViolation(
  91.             str_replace(array_keys($parameters), $parameters, $messageTemplate),
  92.             $messageTemplate,
  93.             $parameters,
  94.             null,
  95.             sprintf('%s/type', $command->getPath()),
  96.             $payload['type'],
  97.             null,
  98.             self::ERROR_CODE
  99.         ));
  101.         return $violationList;
  102.     }
  104.     private function isCategoryEntryPoint(string $categoryId, PostWriteValidationEvent $event): bool
  105.     {
  106.         foreach ($event->getCommands() as $salesChannelCommand) {
  107.             if ($salesChannelCommand->getDefinition()->getClass() !== SalesChannelDefinition::class) {
  108.                 continue;
  109.             }
  111.             $payload = $salesChannelCommand->getPayload();
  112.             if ((isset($payload['navigation_category_id']) && $payload['navigation_category_id'] === $categoryId)
  113.                 || (isset($payload['footer_category_id']) && $payload['footer_category_id'] === $categoryId)
  114.                 || (isset($payload['service_category_id']) && $payload['service_category_id'] === $categoryId)
  115.             ) {
  116.                 return false;
  117.             }
  118.         }
  120.         $query = $this->connection->createQueryBuilder()
  121.             ->select('id')
  122.             ->from(SalesChannelDefinition::ENTITY_NAME)
  123.             ->where('navigation_category_id = :navigation_id')
  124.             ->orWhere('footer_category_id = :footer_id')
  125.             ->orWhere('service_category_id = :service_id')
  126.             ->setParameter('navigation_id', $categoryId)
  127.             ->setParameter('footer_id', $categoryId)
  128.             ->setParameter('service_id', $categoryId)
  129.             ->setMaxResults(1)
  130.             ->execute();
  132.         if (!($query instanceof ResultStatement)) {
  133.             return true;
  134.         }
  136.         return !(bool) $query->fetchColumn();
  137.     }
  138. }