src/Core/Content/Rule/DataAbstractionLayer/RuleIndexer.php line 68

  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\EntityRepository;
  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\Log\Package;
  18. use Shopware\Core\Framework\Plugin\Event\PluginPostActivateEvent;
  19. use Shopware\Core\Framework\Plugin\Event\PluginPostDeactivateEvent;
  20. use Shopware\Core\Framework\Plugin\Event\PluginPostInstallEvent;
  21. use Shopware\Core\Framework\Plugin\Event\PluginPostUninstallEvent;
  22. use Shopware\Core\Framework\Plugin\Event\PluginPostUpdateEvent;
  23. use Shopware\Core\Framework\Plugin\Exception\DecorationPatternException;
  24. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  25. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  27. /**
  28.  * @internal
  29.  */
  30. #[Package('business-ops')]
  31. class RuleIndexer extends EntityIndexer implements EventSubscriberInterface
  32. {
  33.     final public const PAYLOAD_UPDATER = 'rule.payload';
  35.     final public const AREA_UPDATER = 'rule.area';
  37.     /**
  38.      * @internal
  39.      */
  40.     public function __construct(
  41.         private readonly Connection $connection,
  42.         private readonly IteratorFactory $iteratorFactory,
  43.         private readonly EntityRepository $repository,
  44.         private readonly RulePayloadUpdater $payloadUpdater,
  45.         private readonly RuleAreaUpdater $areaUpdater,
  46.         private readonly CartRuleLoader $cartRuleLoader,
  47.         private readonly EventDispatcherInterface $eventDispatcher
  48.     ) {
  49.     }
  51.     public function getName(): string
  52.     {
  53.         return 'rule.indexer';
  54.     }
  56.     public static function getSubscribedEvents(): array
  57.     {
  58.         return [
  59.             PluginPostInstallEvent::class => 'refreshPlugin',
  60.             PluginPostActivateEvent::class => 'refreshPlugin',
  61.             PluginPostUpdateEvent::class => 'refreshPlugin',
  62.             PluginPostDeactivateEvent::class => 'refreshPlugin',
  63.             PluginPostUninstallEvent::class => 'refreshPlugin',
  64.             RuleEvents::RULE_WRITTEN_EVENT => 'onRuleWritten',
  65.         ];
  66.     }
  68.     public function refreshPlugin(): void
  69.     {
  70.         // Delete the payload and invalid flag of all rules
  71.         $update = new RetryableQuery(
  72.             $this->connection,
  73.             $this->connection->prepare('UPDATE `rule` SET `payload` = null, `invalid` = 0')
  74.         );
  75.         $update->execute();
  76.     }
  78.     public function iterate(?array $offset): ?EntityIndexingMessage
  79.     {
  80.         $iterator = $this->iteratorFactory->createIterator($this->repository->getDefinition(), $offset);
  82.         $ids = $iterator->fetch();
  84.         if (empty($ids)) {
  85.             return null;
  86.         }
  88.         return new RuleIndexingMessage(array_values($ids), $iterator->getOffset());
  89.     }
  91.     public function update(EntityWrittenContainerEvent $event): ?EntityIndexingMessage
  92.     {
  93.         $updates = $event->getPrimaryKeys(RuleDefinition::ENTITY_NAME);
  95.         if (empty($updates)) {
  96.             return null;
  97.         }
  99.         $this->handle(new RuleIndexingMessage(array_values($updates), null, $event->getContext()));
  101.         return null;
  102.     }
  104.     public function handle(EntityIndexingMessage $message): void
  105.     {
  106.         $ids = $message->getData();
  108.         $ids = array_unique(array_filter($ids));
  109.         if (empty($ids)) {
  110.             return;
  111.         }
  113.         if ($message->allow(self::PAYLOAD_UPDATER)) {
  114.             $this->payloadUpdater->update($ids);
  115.         }
  117.         if ($message->allow(self::AREA_UPDATER)) {
  118.             $this->areaUpdater->update($ids);
  119.         }
  121.         $this->eventDispatcher->dispatch(new RuleIndexerEvent($ids, $message->getContext(), $message->getSkip()));
  122.     }
  124.     public function getTotal(): int
  125.     {
  126.         return $this->iteratorFactory->createIterator($this->repository->getDefinition())->fetchCount();
  127.     }
  129.     public function getDecorated(): EntityIndexer
  130.     {
  131.         throw new DecorationPatternException(static::class);
  132.     }
  134.     public function onRuleWritten(EntityWrittenEvent $event): void
  135.     {
  136.         $this->cartRuleLoader->invalidate();
  137.     }
  138. }