vendor/shopware/core/Content/Flow/Dispatching/FlowDispatcher.php line 45

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Flow\Dispatching;
  5. use Psr\EventDispatcher\StoppableEventInterface;
  6. use Psr\Log\LoggerInterface;
  7. use Shopware\Core\Content\Flow\Dispatching\Struct\Flow;
  8. use Shopware\Core\Content\Flow\Exception\ExecuteSequenceException;
  9. use Shopware\Core\Framework\Context;
  10. use Shopware\Core\Framework\Event\FlowEventAware;
  11. use Shopware\Core\Framework\Event\FlowLogEvent;
  12. use Shopware\Core\Framework\Log\Package;
  13. use Symfony\Component\DependencyInjection\ContainerInterface;
  14. use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
  15. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  16. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  18. /**
  19.  * @internal not intended for decoration or replacement
  20.  */
  21. #[Package('business-ops')]
  22. class FlowDispatcher implements EventDispatcherInterface
  23. {
  24.     private ContainerInterface $container;
  26.     public function __construct(
  27.         private readonly EventDispatcherInterface $dispatcher,
  28.         private readonly LoggerInterface $logger,
  29.         private readonly FlowFactory $flowFactory
  30.     ) {
  31.     }
  33.     public function setContainer(ContainerInterface $container): void
  34.     {
  35.         $this->container = $container;
  36.     }
  38.     /**
  39.      * @template TEvent of object
  40.      *
  41.      * @param TEvent $event
  42.      *
  43.      * @return TEvent
  44.      */
  45.     public function dispatch(object $event, ?string $eventName = null): object
  46.     {
  47.         $event = $this->dispatcher->dispatch($event, $eventName);
  49.         if (!$event instanceof FlowEventAware) {
  50.             return $event;
  51.         }
  53.         $flowLogEvent = new FlowLogEvent(FlowLogEvent::NAME, $event);
  54.         $this->dispatcher->dispatch($flowLogEvent, $flowLogEvent->getName());
  56.         if (($event instanceof StoppableEventInterface && $event->isPropagationStopped())
  57.             || $event->getContext()->hasState(Context::SKIP_TRIGGER_FLOW)
  58.         ) {
  59.             return $event;
  60.         }
  62.         $storableFlow = $this->flowFactory->create($event);
  63.         $this->callFlowExecutor($storableFlow);
  65.         return $event;
  66.     }
  68.     /**
  69.      * @param callable $listener can not use native type declaration @see https://github.com/symfony/symfony/issues/42283
  70.      */
  71.     public function addListener(string $eventName, $listener, int $priority = 0): void // @phpstan-ignore-line
  72.     {
  73.         /** @var callable(object): void $listener - Specify generic callback interface callers can provide more specific implementations */
  74.         $this->dispatcher->addListener($eventName, $listener, $priority);
  75.     }
  77.     public function addSubscriber(EventSubscriberInterface $subscriber): void
  78.     {
  79.         $this->dispatcher->addSubscriber($subscriber);
  80.     }
  82.     public function removeListener(string $eventName, callable $listener): void
  83.     {
  84.         /** @var callable(object): void $listener - Specify generic callback interface callers can provide more specific implementations */
  85.         $this->dispatcher->removeListener($eventName, $listener);
  86.     }
  88.     public function removeSubscriber(EventSubscriberInterface $subscriber): void
  89.     {
  90.         $this->dispatcher->removeSubscriber($subscriber);
  91.     }
  93.     /**
  94.      * @return array<array-key, array<array-key, callable(object): void>|callable(object): void>
  95.      */
  96.     public function getListeners(?string $eventName = null): array
  97.     {
  98.         return $this->dispatcher->getListeners($eventName);
  99.     }
  101.     public function getListenerPriority(string $eventName, callable $listener): ?int
  102.     {
  103.         /** @var callable(object): void $listener - Specify generic callback interface callers can provide more specific implementations */
  104.         return $this->dispatcher->getListenerPriority($eventName, $listener);
  105.     }
  107.     public function hasListeners(?string $eventName = null): bool
  108.     {
  109.         return $this->dispatcher->hasListeners($eventName);
  110.     }
  112.     private function callFlowExecutor(StorableFlow $event): void
  113.     {
  114.         $flows = $this->getFlows($event->getName());
  116.         if (empty($flows)) {
  117.             return;
  118.         }
  120.         /** @var FlowExecutor|null $flowExecutor */
  121.         $flowExecutor = $this->container->get(FlowExecutor::class);
  123.         if ($flowExecutor === null) {
  124.             throw new ServiceNotFoundException(FlowExecutor::class);
  125.         }
  127.         foreach ($flows as $flow) {
  128.             try {
  129.                 /** @var Flow $payload */
  130.                 $payload = $flow['payload'];
  131.                 $flowExecutor->execute($payload, $event);
  132.             } catch (ExecuteSequenceException $e) {
  133.                 $this->logger->error(
  134.                     "Could not execute flow with error message:\n"
  135.                     . 'Flow name: ' . $flow['name'] . "\n"
  136.                     . 'Flow id: ' . $flow['id'] . "\n"
  137.                     . 'Sequence id: ' . $e->getSequenceId() . "\n"
  138.                     . $e->getMessage() . "\n"
  139.                     . 'Error Code: ' . $e->getCode() . "\n"
  140.                 );
  141.             } catch (\Throwable $e) {
  142.                 $this->logger->error(
  143.                     "Could not execute flow with error message:\n"
  144.                     . 'Flow name: ' . $flow['name'] . "\n"
  145.                     . 'Flow id: ' . $flow['id'] . "\n"
  146.                     . $e->getMessage() . "\n"
  147.                     . 'Error Code: ' . $e->getCode() . "\n"
  148.                 );
  149.             }
  150.         }
  151.     }
  153.     /**
  154.      * @return array<string, mixed>
  155.      */
  156.     private function getFlows(string $eventName): array
  157.     {
  158.         /** @var AbstractFlowLoader|null $flowLoader */
  159.         $flowLoader = $this->container->get(FlowLoader::class);
  161.         if ($flowLoader === null) {
  162.             throw new ServiceNotFoundException(FlowExecutor::class);
  163.         }
  165.         $flows = $flowLoader->load();
  167.         $result = [];
  168.         if (\array_key_exists($eventName, $flows)) {
  169.             $result = $flows[$eventName];
  170.         }
  172.         return $result;
  173.     }
  174. }