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

Open in your IDE?
  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\Validation\WriteConstraintViolationException;
  12. use Shopware\Core\System\SalesChannel\SalesChannelDefinition;
  13. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  14. use Symfony\Component\Validator\ConstraintViolation;
  15. use Symfony\Component\Validator\ConstraintViolationList;
  16. use Symfony\Component\Validator\ConstraintViolationListInterface;
  18. /**
  19.  * @deprecated tag:v6.5.0 - reason:becomes-internal - EventSubscribers will become internal in v6.5.0
  20.  */
  21. class EntryPointValidator implements EventSubscriberInterface
  22. {
  23.     private const ERROR_CODE = 'CONTENT__INVALID_CATEGORY_TYPE_AS_ENTRY_POINT';
  25.     private const ALLOWED_TYPE_CHANGE = [
  26.         CategoryDefinition::TYPE_PAGE,
  27.         CategoryDefinition::TYPE_FOLDER,
  28.     ];
  30.     private Connection $connection;
  32.     /**
  33.      * @internal
  34.      */
  35.     public function __construct(Connection $connection)
  36.     {
  37.         $this->connection = $connection;
  38.     }
  40.     public static function getSubscribedEvents(): array
  41.     {
  42.         return [
  43.             PostWriteValidationEvent::class => 'postValidate',
  44.         ];
  45.     }
  47.     public function postValidate(PostWriteValidationEvent $event): void
  48.     {
  49.         $violationList = new ConstraintViolationList();
  50.         foreach ($event->getCommands() as $command) {
  51.             if (!($command instanceof InsertCommand || $command instanceof UpdateCommand)) {
  52.                 continue;
  53.             }
  55.             if ($command->getDefinition()->getClass() !== CategoryDefinition::class) {
  56.                 continue;
  57.             }
  59.             if (!isset($command->getPayload()['type'])) {
  60.                 continue;
  61.             }
  63.             $violationList->addAll($this->checkTypeChange($command, $event));
  64.         }
  66.         if ($violationList->count() > 0) {
  67.             $event->getExceptions()->add(new WriteConstraintViolationException($violationList));
  69.             return;
  70.         }
  71.     }
  73.     private function checkTypeChange(WriteCommand $command, PostWriteValidationEvent $event): ConstraintViolationListInterface
  74.     {
  75.         $violationList = new ConstraintViolationList();
  76.         $payload = $command->getPayload();
  78.         if (\in_array($payload['type'], self::ALLOWED_TYPE_CHANGE, true)) {
  79.             return $violationList;
  80.         }
  82.         if ($this->isCategoryEntryPoint($command->getPrimaryKey()['id'], $event)) {
  83.             return $violationList;
  84.         }
  86.         $messageTemplate = 'The type can not be assigned while category is entry point.';
  87.         $parameters = ['{{ value }}' => $payload['type']];
  89.         $violationList->add(new ConstraintViolation(
  90.             str_replace(array_keys($parameters), $parameters, $messageTemplate),
  91.             $messageTemplate,
  92.             $parameters,
  93.             null,
  94.             sprintf('%s/type', $command->getPath()),
  95.             $payload['type'],
  96.             null,
  97.             self::ERROR_CODE
  98.         ));
  100.         return $violationList;
  101.     }
  103.     private function isCategoryEntryPoint(string $categoryId, PostWriteValidationEvent $event): bool
  104.     {
  105.         foreach ($event->getCommands() as $salesChannelCommand) {
  106.             if ($salesChannelCommand->getDefinition()->getClass() !== SalesChannelDefinition::class) {
  107.                 continue;
  108.             }
  110.             $payload = $salesChannelCommand->getPayload();
  111.             if ((isset($payload['navigation_category_id']) && $payload['navigation_category_id'] === $categoryId)
  112.                 || (isset($payload['footer_category_id']) && $payload['footer_category_id'] === $categoryId)
  113.                 || (isset($payload['service_category_id']) && $payload['service_category_id'] === $categoryId)
  114.             ) {
  115.                 return false;
  116.             }
  117.         }
  119.         $result = $this->connection->createQueryBuilder()
  120.             ->select('id')
  121.             ->from(SalesChannelDefinition::ENTITY_NAME)
  122.             ->where('navigation_category_id = :navigation_id')
  123.             ->orWhere('footer_category_id = :footer_id')
  124.             ->orWhere('service_category_id = :service_id')
  125.             ->setParameter('navigation_id', $categoryId)
  126.             ->setParameter('footer_id', $categoryId)
  127.             ->setParameter('service_id', $categoryId)
  128.             ->setMaxResults(1)
  129.             ->executeQuery();
  131.         return !$result->fetchOne();
  132.     }
  133. }