vendor/shopware/core/Content/Rule/DataAbstractionLayer/RuleIndexer.php line 168

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Rule\DataAbstractionLayer;
  5. use Doctrine\DBAL\Connection;
  6. use Shopware\Core\Checkout\Cart\CartRuleLoader;
  7. use Shopware\Core\Content\Rule\Event\RuleIndexerEvent;
  8. use Shopware\Core\Content\Rule\RuleDefinition;
  9. use Shopware\Core\Content\Rule\RuleEvents;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Dbal\Common\IteratorFactory;
  11. use Shopware\Core\Framework\DataAbstractionLayer\Doctrine\RetryableQuery;
  12. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepositoryInterface;
  13. use Shopware\Core\Framework\DataAbstractionLayer\Event\EntityWrittenContainerEvent;
  14. use Shopware\Core\Framework\DataAbstractionLayer\Event\EntityWrittenEvent;
  15. use Shopware\Core\Framework\DataAbstractionLayer\Indexing\EntityIndexer;
  16. use Shopware\Core\Framework\DataAbstractionLayer\Indexing\EntityIndexingMessage;
  17. use Shopware\Core\Framework\Feature;
  18. use Shopware\Core\Framework\Log\Package;
  19. use Shopware\Core\Framework\Plugin\Event\PluginPostActivateEvent;
  20. use Shopware\Core\Framework\Plugin\Event\PluginPostDeactivateEvent;
  21. use Shopware\Core\Framework\Plugin\Event\PluginPostInstallEvent;
  22. use Shopware\Core\Framework\Plugin\Event\PluginPostUninstallEvent;
  23. use Shopware\Core\Framework\Plugin\Event\PluginPostUpdateEvent;
  24. use Shopware\Core\Framework\Plugin\Exception\DecorationPatternException;
  25. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  26. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  28. /**
  29. * @deprecated tag:v6.5.0 - reason:becomes-internal - EventSubscribers will become internal in v6.5.0
  30. */
  31. #[Package('business-ops')]
  32. class RuleIndexer extends EntityIndexer implements EventSubscriberInterface
  33. {
  34. public const PAYLOAD_UPDATER = 'rule.payload';
  36. public const AREA_UPDATER = 'rule.area';
  38. private IteratorFactory $iteratorFactory;
  40. private Connection $connection;
  42. private EntityRepositoryInterface $repository;
  44. private RulePayloadUpdater $payloadUpdater;
  46. private EventDispatcherInterface $eventDispatcher;
  48. private CartRuleLoader $cartRuleLoader;
  50. private RuleAreaUpdater $areaUpdater;
  52. /**
  53. * @internal
  54. */
  55. public function __construct(
  56. Connection $connection,
  57. IteratorFactory $iteratorFactory,
  58. EntityRepositoryInterface $repository,
  59. RulePayloadUpdater $payloadUpdater,
  60. RuleAreaUpdater $areaUpdater,
  61. CartRuleLoader $cartRuleLoader,
  62. EventDispatcherInterface $eventDispatcher
  63. ) {
  64. $this->iteratorFactory = $iteratorFactory;
  65. $this->repository = $repository;
  66. $this->connection = $connection;
  67. $this->payloadUpdater = $payloadUpdater;
  68. $this->areaUpdater = $areaUpdater;
  69. $this->eventDispatcher = $eventDispatcher;
  70. $this->cartRuleLoader = $cartRuleLoader;
  71. }
  73. public function getName(): string
  74. {
  75. return 'rule.indexer';
  76. }
  78. public static function getSubscribedEvents(): array
  79. {
  80. return [
  81. PluginPostInstallEvent::class => 'refreshPlugin',
  82. PluginPostActivateEvent::class => 'refreshPlugin',
  83. PluginPostUpdateEvent::class => 'refreshPlugin',
  84. PluginPostDeactivateEvent::class => 'refreshPlugin',
  85. PluginPostUninstallEvent::class => 'refreshPlugin',
  86. RuleEvents::RULE_WRITTEN_EVENT => 'onRuleWritten',
  87. ];
  88. }
  90. public function refreshPlugin(): void
  91. {
  92. // Delete the payload and invalid flag of all rules
  93. $update = new RetryableQuery(
  94. $this->connection,
  95. $this->connection->prepare('UPDATE `rule` SET `payload` = null, `invalid` = 0')
  96. );
  97. $update->execute();
  98. }
  100. /**
  101. * @param array{offset: string}|null $offset
  102. *
  103. * @deprecated tag:v6.5.0 The parameter $offset will be native typed
  104. */
  105. public function iterate(/*?array */$offset): ?EntityIndexingMessage
  106. {
  107. if ($offset !== null && !\is_array($offset)) {
  108. Feature::triggerDeprecationOrThrow(
  109. 'v6.5.0.0',
  110. 'Parameter `$offset` of method "iterate()" in class "RuleIndexer" will be natively typed to `?array` in v6.5.0.0.'
  111. );
  112. }
  114. $iterator = $this->iteratorFactory->createIterator($this->repository->getDefinition(), $offset);
  116. $ids = $iterator->fetch();
  118. if (empty($ids)) {
  119. return null;
  120. }
  122. return new RuleIndexingMessage(array_values($ids), $iterator->getOffset());
  123. }
  125. public function update(EntityWrittenContainerEvent $event): ?EntityIndexingMessage
  126. {
  127. $updates = $event->getPrimaryKeys(RuleDefinition::ENTITY_NAME);
  129. if (empty($updates)) {
  130. return null;
  131. }
  133. $this->handle(new RuleIndexingMessage(array_values($updates), null, $event->getContext()));
  135. return null;
  136. }
  138. public function handle(EntityIndexingMessage $message): void
  139. {
  140. $ids = $message->getData();
  142. $ids = array_unique(array_filter($ids));
  143. if (empty($ids)) {
  144. return;
  145. }
  147. if ($message->allow(self::PAYLOAD_UPDATER)) {
  148. $this->payloadUpdater->update($ids);
  149. }
  151. if ($message->allow(self::AREA_UPDATER)) {
  152. $this->areaUpdater->update($ids);
  153. }
  155. $this->eventDispatcher->dispatch(new RuleIndexerEvent($ids, $message->getContext(), $message->getSkip()));
  156. }
  158. public function getTotal(): int
  159. {
  160. return $this->iteratorFactory->createIterator($this->repository->getDefinition())->fetchCount();
  161. }
  163. public function getDecorated(): EntityIndexer
  164. {
  165. throw new DecorationPatternException(static::class);
  166. }
  168. public function onRuleWritten(EntityWrittenEvent $event): void
  169. {
  170. $this->cartRuleLoader->invalidate();
  171. }
  172. }