platform/src/Core/Content/Category/Validation/EntryPointValidator.php line 50

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 Shopware\Core\Content\Category\Validation;
  10. use Doctrine\DBAL\Connection;
  11. use Doctrine\DBAL\Driver\ResultStatement;
  12. use Shopware\Core\Content\Category\CategoryDefinition;
  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\PostWriteValidationEvent;
  17. use Shopware\Core\Framework\Validation\WriteConstraintViolationException;
  18. use Shopware\Core\System\SalesChannel\SalesChannelDefinition;
  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 EntryPointValidator implements EventSubscriberInterface
  25. {
  26.     private const ERROR_CODE = 'CONTENT__INVALID_CATEGORY_TYPE_AS_ENTRY_POINT';
  28.     private const ALLOWED_TYPE_CHANGE = [
  29.         CategoryDefinition::TYPE_PAGE,
  30.         CategoryDefinition::TYPE_FOLDER,
  31.     ];
  33.     /**
  34.      * @var Connection
  35.      */
  36.     private $connection;
  38.     public function __construct(Connection $connection)
  39.     {
  40.         $this->connection = $connection;
  41.     }
  43.     public static function getSubscribedEvents(): array
  44.     {
  45.         return [
  46.             PostWriteValidationEvent::class => 'postValidate',
  47.         ];
  48.     }
  50.     public function postValidate(PostWriteValidationEvent $event): void
  51.     {
  52.         $violationList = new ConstraintViolationList();
  53.         foreach ($event->getCommands() as $command) {
  54.             if (!($command instanceof InsertCommand || $command instanceof UpdateCommand)) {
  55.                 continue;
  56.             }
  58.             if ($command->getDefinition()->getClass() !== CategoryDefinition::class) {
  59.                 continue;
  60.             }
  62.             if (!isset($command->getPayload()['type'])) {
  63.                 continue;
  64.             }
  66.             $violationList->addAll($this->checkTypeChange($command, $event));
  67.         }
  69.         if ($violationList->count() > 0) {
  70.             $event->getExceptions()->add(new WriteConstraintViolationException($violationList));
  72.             return;
  73.         }
  74.     }
  76.     private function checkTypeChange(WriteCommand $command, PostWriteValidationEvent $event): ConstraintViolationListInterface
  77.     {
  78.         $violationList = new ConstraintViolationList();
  79.         $payload = $command->getPayload();
  81.         if (\in_array($payload['type'], self::ALLOWED_TYPE_CHANGE, true)) {
  82.             return $violationList;
  83.         }
  85.         if ($this->isCategoryEntryPoint($command->getPrimaryKey()['id'], $event)) {
  86.             return $violationList;
  87.         }
  89.         $messageTemplate = 'The type can not be assigned while category is entry point.';
  90.         $parameters = ['{{ value }}' => $payload['type']];
  92.         $violationList->add(new ConstraintViolation(
  93.             str_replace(array_keys($parameters), $parameters, $messageTemplate),
  94.             $messageTemplate,
  95.             $parameters,
  96.             null,
  97.             sprintf('%s/type', $command->getPath()),
  98.             $payload['type'],
  99.             null,
  100.             self::ERROR_CODE
  101.         ));
  103.         return $violationList;
  104.     }
  106.     private function isCategoryEntryPoint(string $categoryId, PostWriteValidationEvent $event): bool
  107.     {
  108.         foreach ($event->getCommands() as $salesChannelCommand) {
  109.             if ($salesChannelCommand->getDefinition()->getClass() !== SalesChannelDefinition::class) {
  110.                 continue;
  111.             }
  113.             $payload = $salesChannelCommand->getPayload();
  114.             if ((isset($payload['navigation_category_id']) && $payload['navigation_category_id'] === $categoryId)
  115.                 || (isset($payload['footer_category_id']) && $payload['footer_category_id'] === $categoryId)
  116.                 || (isset($payload['service_category_id']) && $payload['service_category_id'] === $categoryId)
  117.             ) {
  118.                 return false;
  119.             }
  120.         }
  122.         $query = $this->connection->createQueryBuilder()
  123.             ->select('id')
  124.             ->from(SalesChannelDefinition::ENTITY_NAME)
  125.             ->where('navigation_category_id = :navigation_id')
  126.             ->orWhere('footer_category_id = :footer_id')
  127.             ->orWhere('service_category_id = :service_id')
  128.             ->setParameter('navigation_id', $categoryId)
  129.             ->setParameter('footer_id', $categoryId)
  130.             ->setParameter('service_id', $categoryId)
  131.             ->setMaxResults(1)
  132.             ->execute();
  134.         if (!($query instanceof ResultStatement)) {
  135.             return true;
  136.         }
  138.         return !(bool) $query->fetchColumn();
  139.     }
  140. }