src/Core/Content/Category/Validation/EntryPointValidator.php line 46

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Category\Validation;
  5. use Doctrine\DBAL\Connection;
  6. use Shopware\Core\Content\Category\CategoryDefinition;
  7. use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\InsertCommand;
  8. use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\UpdateCommand;
  9. use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\WriteCommand;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Write\Validation\PostWriteValidationEvent;
  11. use Shopware\Core\Framework\Log\Package;
  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.  * @internal
  21.  */
  22. #[Package('content')]
  23. class EntryPointValidator implements EventSubscriberInterface
  24. {
  25.     private const ERROR_CODE = 'CONTENT__INVALID_CATEGORY_TYPE_AS_ENTRY_POINT';
  27.     private const ALLOWED_TYPE_CHANGE = [
  28.         CategoryDefinition::TYPE_PAGE,
  29.         CategoryDefinition::TYPE_FOLDER,
  30.     ];
  32.     /**
  33.      * @internal
  34.      */
  35.     public function __construct(private readonly Connection $connection)
  36.     {
  37.     }
  39.     public static function getSubscribedEvents(): array
  40.     {
  41.         return [
  42.             PostWriteValidationEvent::class => 'postValidate',
  43.         ];
  44.     }
  46.     public function postValidate(PostWriteValidationEvent $event): void
  47.     {
  48.         $violationList = new ConstraintViolationList();
  49.         foreach ($event->getCommands() as $command) {
  50.             if (!($command instanceof InsertCommand || $command instanceof UpdateCommand)) {
  51.                 continue;
  52.             }
  54.             if ($command->getDefinition()->getClass() !== CategoryDefinition::class) {
  55.                 continue;
  56.             }
  58.             if (!isset($command->getPayload()['type'])) {
  59.                 continue;
  60.             }
  62.             $violationList->addAll($this->checkTypeChange($command, $event));
  63.         }
  65.         if ($violationList->count() > 0) {
  66.             $event->getExceptions()->add(new WriteConstraintViolationException($violationList));
  68.             return;
  69.         }
  70.     }
  72.     private function checkTypeChange(WriteCommand $command, PostWriteValidationEvent $event): ConstraintViolationListInterface
  73.     {
  74.         $violationList = new ConstraintViolationList();
  75.         $payload = $command->getPayload();
  77.         if (\in_array($payload['type'], self::ALLOWED_TYPE_CHANGE, true)) {
  78.             return $violationList;
  79.         }
  81.         if ($this->isCategoryEntryPoint($command->getPrimaryKey()['id'], $event)) {
  82.             return $violationList;
  83.         }
  85.         $messageTemplate = 'The type can not be assigned while category is entry point.';
  86.         $parameters = ['{{ value }}' => $payload['type']];
  88.         $violationList->add(new ConstraintViolation(
  89.             str_replace(array_keys($parameters), $parameters, $messageTemplate),
  90.             $messageTemplate,
  91.             $parameters,
  92.             null,
  93.             sprintf('%s/type', $command->getPath()),
  94.             $payload['type'],
  95.             null,
  96.             self::ERROR_CODE
  97.         ));
  99.         return $violationList;
  100.     }
  102.     private function isCategoryEntryPoint(string $categoryId, PostWriteValidationEvent $event): bool
  103.     {
  104.         foreach ($event->getCommands() as $salesChannelCommand) {
  105.             if ($salesChannelCommand->getDefinition()->getClass() !== SalesChannelDefinition::class) {
  106.                 continue;
  107.             }
  109.             $payload = $salesChannelCommand->getPayload();
  110.             if ((isset($payload['navigation_category_id']) && $payload['navigation_category_id'] === $categoryId)
  111.                 || (isset($payload['footer_category_id']) && $payload['footer_category_id'] === $categoryId)
  112.                 || (isset($payload['service_category_id']) && $payload['service_category_id'] === $categoryId)
  113.             ) {
  114.                 return false;
  115.             }
  116.         }
  118.         $result = $this->connection->createQueryBuilder()
  119.             ->select('id')
  120.             ->from(SalesChannelDefinition::ENTITY_NAME)
  121.             ->where('navigation_category_id = :navigation_id')
  122.             ->orWhere('footer_category_id = :footer_id')
  123.             ->orWhere('service_category_id = :service_id')
  124.             ->setParameter('navigation_id', $categoryId)
  125.             ->setParameter('footer_id', $categoryId)
  126.             ->setParameter('service_id', $categoryId)
  127.             ->setMaxResults(1)
  128.             ->executeQuery();
  130.         return !$result->fetchOne();
  131.     }
  132. }