vendor/shopware/core/Checkout/Order/Listener/OrderStateChangeEventListener.php line 48

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Checkout\Order\Listener;
  5. use Shopware\Core\Checkout\Order\Aggregate\OrderDelivery\OrderDeliveryEntity;
  6. use Shopware\Core\Checkout\Order\Event\OrderStateChangeCriteriaEvent;
  7. use Shopware\Core\Checkout\Order\Event\OrderStateMachineStateChangeEvent;
  8. use Shopware\Core\Checkout\Order\OrderEntity;
  9. use Shopware\Core\Checkout\Order\OrderException;
  10. use Shopware\Core\Framework\Context;
  11. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Pricing\CashRoundingConfig;
  13. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  14. use Shopware\Core\Framework\Event\BusinessEventCollector;
  15. use Shopware\Core\Framework\Event\BusinessEventCollectorEvent;
  16. use Shopware\Core\Framework\Log\Package;
  17. use Shopware\Core\System\StateMachine\Aggregation\StateMachineState\StateMachineStateEntity;
  18. use Shopware\Core\System\StateMachine\Event\StateMachineStateChangeEvent;
  19. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  20. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  22. /**
  23.  * @internal
  24.  */
  25. #[Package('customer-order')]
  26. class OrderStateChangeEventListener implements EventSubscriberInterface
  27. {
  28.     /**
  29.      * @internal
  30.      */
  31.     public function __construct(private readonly EntityRepository $orderRepository, private readonly EntityRepository $transactionRepository, private readonly EntityRepository $deliveryRepository, private readonly EventDispatcherInterface $eventDispatcher, private readonly BusinessEventCollector $businessEventCollector, private readonly EntityRepository $stateRepository)
  32.     {
  33.     }
  35.     public static function getSubscribedEvents(): array
  36.     {
  37.         return [
  38.             'state_machine.order.state_changed' => 'onOrderStateChange',
  39.             'state_machine.order_delivery.state_changed' => 'onOrderDeliveryStateChange',
  40.             'state_machine.order_transaction.state_changed' => 'onOrderTransactionStateChange',
  41.             BusinessEventCollectorEvent::NAME => 'onAddStateEvents',
  42.         ];
  43.     }
  45.     /**
  46.      * @throws OrderException
  47.      */
  48.     public function onOrderDeliveryStateChange(StateMachineStateChangeEvent $event): void
  49.     {
  50.         $orderDeliveryId = $event->getTransition()->getEntityId();
  52.         $criteria = new Criteria([$orderDeliveryId]);
  53.         $criteria->addAssociation('order.orderCustomer');
  54.         $criteria->addAssociation('order.transactions');
  56.         /** @var OrderDeliveryEntity|null $orderDelivery */
  57.         $orderDelivery = $this->deliveryRepository
  58.             ->search($criteria, $event->getContext())
  59.             ->first();
  61.         if ($orderDelivery === null) {
  62.             throw OrderException::orderDeliveryNotFound($orderDeliveryId);
  63.         }
  65.         if ($orderDelivery->getOrder() === null) {
  66.             throw OrderException::orderDeliveryNotFound($orderDeliveryId);
  67.         }
  69.         $context = $this->getContext($orderDelivery->getOrderId(), $event->getContext());
  70.         $order = $this->getOrder($orderDelivery->getOrderId(), $context);
  72.         $this->dispatchEvent($event->getStateEventName(), $order, $context);
  73.     }
  75.     /**
  76.      * @throws OrderException
  77.      */
  78.     public function onOrderTransactionStateChange(StateMachineStateChangeEvent $event): void
  79.     {
  80.         $orderTransactionId = $event->getTransition()->getEntityId();
  82.         $criteria = new Criteria([$orderTransactionId]);
  83.         $criteria->addAssociation('paymentMethod');
  84.         $criteria->addAssociation('order.orderCustomer');
  85.         $criteria->addAssociation('order.transactions');
  87.         $orderTransaction = $this->transactionRepository
  88.             ->search($criteria, $event->getContext())
  89.             ->first();
  91.         if ($orderTransaction === null) {
  92.             throw OrderException::orderTransactionNotFound($orderTransactionId);
  93.         }
  95.         if ($orderTransaction->getPaymentMethod() === null) {
  96.             throw OrderException::orderTransactionNotFound($orderTransactionId);
  97.         }
  99.         if ($orderTransaction->getOrder() === null) {
  100.             throw OrderException::orderTransactionNotFound($orderTransactionId);
  101.         }
  103.         $context = $this->getContext($orderTransaction->getOrderId(), $event->getContext());
  104.         $order = $this->getOrder($orderTransaction->getOrderId(), $context);
  106.         $this->dispatchEvent($event->getStateEventName(), $order, $context);
  107.     }
  109.     public function onOrderStateChange(StateMachineStateChangeEvent $event): void
  110.     {
  111.         $orderId = $event->getTransition()->getEntityId();
  113.         $context = $this->getContext($orderId, $event->getContext());
  114.         $order = $this->getOrder($orderId, $context);
  116.         $this->dispatchEvent($event->getStateEventName(), $order, $context);
  117.     }
  119.     public function onAddStateEvents(BusinessEventCollectorEvent $event): void
  120.     {
  121.         $context = $event->getContext();
  123.         $collection = $event->getCollection();
  125.         $criteria = new Criteria();
  126.         $criteria->addAssociation('stateMachine');
  128.         $states = $this->stateRepository->search($criteria, $context);
  130.         $sides = [
  131.             StateMachineStateChangeEvent::STATE_MACHINE_TRANSITION_SIDE_ENTER,
  132.             StateMachineStateChangeEvent::STATE_MACHINE_TRANSITION_SIDE_LEAVE,
  133.         ];
  135.         /** @var StateMachineStateEntity $state */
  136.         foreach ($states as $state) {
  137.             foreach ($sides as $side) {
  138.                 $machine = $state->getStateMachine();
  139.                 if (!$machine) {
  140.                     continue;
  141.                 }
  143.                 $name = implode('.', [
  144.                     $side,
  145.                     $machine->getTechnicalName(),
  146.                     $state->getTechnicalName(),
  147.                 ]);
  149.                 $definition = $this->businessEventCollector->define(OrderStateMachineStateChangeEvent::class, $name);
  151.                 if (!$definition) {
  152.                     continue;
  153.                 }
  155.                 $collection->set($name, $definition);
  156.             }
  157.         }
  158.     }
  160.     /**
  161.      * @throws OrderException
  162.      */
  163.     private function dispatchEvent(string $stateEventName, OrderEntity $order, Context $context): void
  164.     {
  165.         $this->eventDispatcher->dispatch(
  166.             new OrderStateMachineStateChangeEvent($stateEventName, $order, $context),
  167.             $stateEventName
  168.         );
  169.     }
  171.     private function getContext(string $orderId, Context $context): Context
  172.     {
  173.         $order = $this->orderRepository->search(new Criteria([$orderId]), $context)->first();
  175.         if (!$order instanceof OrderEntity) {
  176.             throw OrderException::orderNotFound($orderId);
  177.         }
  179.         /** @var CashRoundingConfig $itemRounding */
  180.         $itemRounding = $order->getItemRounding();
  182.         $orderContext = new Context(
  183.             $context->getSource(),
  184.             $order->getRuleIds() ?? [],
  185.             $order->getCurrencyId(),
  186.             array_values(array_unique(array_merge([$order->getLanguageId()], $context->getLanguageIdChain()))),
  187.             $context->getVersionId(),
  188.             $order->getCurrencyFactor(),
  189.             true,
  190.             $order->getTaxStatus(),
  191.             $itemRounding
  192.         );
  194.         $orderContext->addState(...$context->getStates());
  195.         $orderContext->addExtensions($context->getExtensions());
  197.         return $orderContext;
  198.     }
  200.     /**
  201.      * @throws OrderException
  202.      */
  203.     private function getOrder(string $orderId, Context $context): OrderEntity
  204.     {
  205.         $orderCriteria = $this->getOrderCriteria($orderId);
  207.         $order = $this->orderRepository
  208.             ->search($orderCriteria, $context)
  209.             ->first();
  211.         if (!$order instanceof OrderEntity) {
  212.             throw OrderException::orderNotFound($orderId);
  213.         }
  215.         return $order;
  216.     }
  218.     private function getOrderCriteria(string $orderId): Criteria
  219.     {
  220.         $criteria = new Criteria([$orderId]);
  221.         $criteria->addAssociation('orderCustomer.salutation');
  222.         $criteria->addAssociation('orderCustomer.customer');
  223.         $criteria->addAssociation('stateMachineState');
  224.         $criteria->addAssociation('deliveries.shippingMethod');
  225.         $criteria->addAssociation('deliveries.shippingOrderAddress.country');
  226.         $criteria->addAssociation('deliveries.shippingOrderAddress.countryState');
  227.         $criteria->addAssociation('salesChannel');
  228.         $criteria->addAssociation('language.locale');
  229.         $criteria->addAssociation('transactions.paymentMethod');
  230.         $criteria->addAssociation('lineItems');
  231.         $criteria->addAssociation('lineItems.downloads.media');
  232.         $criteria->addAssociation('currency');
  233.         $criteria->addAssociation('addresses.country');
  234.         $criteria->addAssociation('addresses.countryState');
  235.         $criteria->addAssociation('tags');
  237.         $event = new OrderStateChangeCriteriaEvent($orderId, $criteria);
  238.         $this->eventDispatcher->dispatch($event);
  240.         return $criteria;
  241.     }
  242. }