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

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\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. * @deprecated tag:v6.5.0 - reason:becomes-internal - EventSubscribers will become internal in v6.5.0
  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. private Connection $connection;
  34. /**
  35. * @internal
  36. */
  37. public function __construct(Connection $connection)
  38. {
  39. $this->connection = $connection;
  40. }
  42. public static function getSubscribedEvents(): array
  43. {
  44. return [
  45. PostWriteValidationEvent::class => 'postValidate',
  46. ];
  47. }
  49. public function postValidate(PostWriteValidationEvent $event): void
  50. {
  51. $violationList = new ConstraintViolationList();
  52. foreach ($event->getCommands() as $command) {
  53. if (!($command instanceof InsertCommand || $command instanceof UpdateCommand)) {
  54. continue;
  55. }
  57. if ($command->getDefinition()->getClass() !== CategoryDefinition::class) {
  58. continue;
  59. }
  61. if (!isset($command->getPayload()['type'])) {
  62. continue;
  63. }
  65. $violationList->addAll($this->checkTypeChange($command, $event));
  66. }
  68. if ($violationList->count() > 0) {
  69. $event->getExceptions()->add(new WriteConstraintViolationException($violationList));
  71. return;
  72. }
  73. }
  75. private function checkTypeChange(WriteCommand $command, PostWriteValidationEvent $event): ConstraintViolationListInterface
  76. {
  77. $violationList = new ConstraintViolationList();
  78. $payload = $command->getPayload();
  80. if (\in_array($payload['type'], self::ALLOWED_TYPE_CHANGE, true)) {
  81. return $violationList;
  82. }
  84. if ($this->isCategoryEntryPoint($command->getPrimaryKey()['id'], $event)) {
  85. return $violationList;
  86. }
  88. $messageTemplate = 'The type can not be assigned while category is entry point.';
  89. $parameters = ['{{ value }}' => $payload['type']];
  91. $violationList->add(new ConstraintViolation(
  92. str_replace(array_keys($parameters), $parameters, $messageTemplate),
  93. $messageTemplate,
  94. $parameters,
  95. null,
  96. sprintf('%s/type', $command->getPath()),
  97. $payload['type'],
  98. null,
  99. self::ERROR_CODE
  100. ));
  102. return $violationList;
  103. }
  105. private function isCategoryEntryPoint(string $categoryId, PostWriteValidationEvent $event): bool
  106. {
  107. foreach ($event->getCommands() as $salesChannelCommand) {
  108. if ($salesChannelCommand->getDefinition()->getClass() !== SalesChannelDefinition::class) {
  109. continue;
  110. }
  112. $payload = $salesChannelCommand->getPayload();
  113. if ((isset($payload['navigation_category_id']) && $payload['navigation_category_id'] === $categoryId)
  114. || (isset($payload['footer_category_id']) && $payload['footer_category_id'] === $categoryId)
  115. || (isset($payload['service_category_id']) && $payload['service_category_id'] === $categoryId)
  116. ) {
  117. return false;
  118. }
  119. }
  121. $result = $this->connection->createQueryBuilder()
  122. ->select('id')
  123. ->from(SalesChannelDefinition::ENTITY_NAME)
  124. ->where('navigation_category_id = :navigation_id')
  125. ->orWhere('footer_category_id = :footer_id')
  126. ->orWhere('service_category_id = :service_id')
  127. ->setParameter('navigation_id', $categoryId)
  128. ->setParameter('footer_id', $categoryId)
  129. ->setParameter('service_id', $categoryId)
  130. ->setMaxResults(1)
  131. ->executeQuery();
  133. return !$result->fetchOne();
  134. }
  135. }