vendor/shopware/core/Content/Flow/Indexing/FlowIndexer.php line 84

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Flow\Indexing;
  5. use Shopware\Core\Content\Flow\Events\FlowIndexerEvent;
  6. use Shopware\Core\Content\Flow\FlowDefinition;
  7. use Shopware\Core\Framework\App\Event\AppActivatedEvent;
  8. use Shopware\Core\Framework\App\Event\AppDeactivatedEvent;
  9. use Shopware\Core\Framework\App\Event\AppDeletedEvent;
  10. use Shopware\Core\Framework\App\Event\AppInstalledEvent;
  11. use Shopware\Core\Framework\App\Event\AppUpdatedEvent;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Dbal\Common\IteratorFactory;
  13. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepositoryInterface;
  14. use Shopware\Core\Framework\DataAbstractionLayer\Event\EntityWrittenContainerEvent;
  15. use Shopware\Core\Framework\DataAbstractionLayer\Indexing\EntityIndexer;
  16. use Shopware\Core\Framework\DataAbstractionLayer\Indexing\EntityIndexingMessage;
  17. use Shopware\Core\Framework\DataAbstractionLayer\Indexing\MessageQueue\IterateEntityIndexerMessage;
  18. use Shopware\Core\Framework\Feature;
  19. use Shopware\Core\Framework\Log\Package;
  20. use Shopware\Core\Framework\Plugin\Event\PluginPostActivateEvent;
  21. use Shopware\Core\Framework\Plugin\Event\PluginPostDeactivateEvent;
  22. use Shopware\Core\Framework\Plugin\Event\PluginPostInstallEvent;
  23. use Shopware\Core\Framework\Plugin\Event\PluginPostUninstallEvent;
  24. use Shopware\Core\Framework\Plugin\Event\PluginPostUpdateEvent;
  25. use Shopware\Core\Framework\Plugin\Exception\DecorationPatternException;
  26. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  27. use Symfony\Component\Messenger\MessageBusInterface;
  28. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  30. /**
  31. * @deprecated tag:v6.5.0 - reason:becomes-internal - EventSubscribers will become internal in v6.5.0
  32. */
  33. #[Package('business-ops')]
  34. class FlowIndexer extends EntityIndexer implements EventSubscriberInterface
  35. {
  36. private IteratorFactory $iteratorFactory;
  38. private EntityRepositoryInterface $repository;
  40. private FlowPayloadUpdater $payloadUpdater;
  42. private EventDispatcherInterface $eventDispatcher;
  44. private MessageBusInterface $messageBus;
  46. /**
  47. * @internal
  48. */
  49. public function __construct(
  50. IteratorFactory $iteratorFactory,
  51. EntityRepositoryInterface $repository,
  52. FlowPayloadUpdater $payloadUpdater,
  53. EventDispatcherInterface $eventDispatcher,
  54. MessageBusInterface $messageBus
  55. ) {
  56. $this->iteratorFactory = $iteratorFactory;
  57. $this->repository = $repository;
  58. $this->payloadUpdater = $payloadUpdater;
  59. $this->eventDispatcher = $eventDispatcher;
  60. $this->messageBus = $messageBus;
  61. }
  63. public function getName(): string
  64. {
  65. return 'flow.indexer';
  66. }
  68. public static function getSubscribedEvents(): array
  69. {
  70. return [
  71. PluginPostInstallEvent::class => 'refreshPlugin',
  72. PluginPostActivateEvent::class => 'refreshPlugin',
  73. PluginPostUpdateEvent::class => 'refreshPlugin',
  74. PluginPostDeactivateEvent::class => 'refreshPlugin',
  75. PluginPostUninstallEvent::class => 'refreshPlugin',
  76. AppInstalledEvent::class => 'refreshPlugin',
  77. AppUpdatedEvent::class => 'refreshPlugin',
  78. AppActivatedEvent::class => 'refreshPlugin',
  79. AppDeletedEvent::class => 'refreshPlugin',
  80. AppDeactivatedEvent::class => 'refreshPlugin',
  81. ];
  82. }
  84. public function refreshPlugin(): void
  85. {
  86. // Schedule indexer to update flows
  87. $this->messageBus->dispatch(new IterateEntityIndexerMessage($this->getName(), null));
  88. }
  90. /**
  91. * @param array{offset: string}|null $offset
  92. *
  93. * @deprecated tag:v6.5.0 The parameter $offset will be native typed
  94. */
  95. public function iterate(/*?array */$offset): ?EntityIndexingMessage
  96. {
  97. if ($offset !== null && !\is_array($offset)) {
  98. Feature::triggerDeprecationOrThrow(
  99. 'v6.5.0.0',
  100. 'Parameter `$offset` of method "iterate()" in class "FlowIndexer" will be natively typed to `?array` in v6.5.0.0.'
  101. );
  102. }
  104. $iterator = $this->iteratorFactory->createIterator($this->repository->getDefinition(), $offset);
  106. $ids = $iterator->fetch();
  108. if (empty($ids)) {
  109. return null;
  110. }
  112. return new FlowIndexingMessage(array_values($ids), $iterator->getOffset());
  113. }
  115. public function update(EntityWrittenContainerEvent $event): ?EntityIndexingMessage
  116. {
  117. $updates = $event->getPrimaryKeys(FlowDefinition::ENTITY_NAME);
  119. if (empty($updates)) {
  120. return null;
  121. }
  123. $this->handle(new FlowIndexingMessage(array_values($updates), null, $event->getContext()));
  125. return null;
  126. }
  128. public function handle(EntityIndexingMessage $message): void
  129. {
  130. $ids = array_unique(array_filter($message->getData()));
  132. if (empty($ids)) {
  133. return;
  134. }
  136. $this->payloadUpdater->update($ids);
  138. $this->eventDispatcher->dispatch(new FlowIndexerEvent($ids, $message->getContext()));
  139. }
  141. public function getTotal(): int
  142. {
  143. return $this->iteratorFactory->createIterator($this->repository->getDefinition())->fetchCount();
  144. }
  146. public function getDecorated(): EntityIndexer
  147. {
  148. throw new DecorationPatternException(static::class);
  149. }
  150. }