Add support for Symfony Workflow

monsieurbiz · Oct 1, 2024 · fde36a8 · fde36a8
1 parent d545260
commit fde36a8
Show file tree

Hide file tree

Showing 5 changed files with 393 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -52,8 +52,10 @@ Show any order on the Sylius backend and click on the top right `History` button
 
 ## How does it work?
 
-This plugin is based on the state machine events. It uses the native Winzou state machine callback system to save named 
-order events when they are triggered. 
+This plugin is based on the state machine events. It uses both the native Winzou state machine callback system and
+Symfony Workflow events to save named order events when they are triggered. 
+
+Depending on your `sylius_state_machine_abstraction.default_adapter` configuration:
 
 ```yaml
 # src/Resources/config/state_machine/checkout.yaml
@@ -67,6 +69,47 @@ winzou_state_machine:
           args: [ 'object', 'constant("MonsieurBiz\\SyliusOrderHistoryPlugin\\Entity\\OrderHistoryEventInterface::TYPE_CHECKOUT")', '"addressed"' ]
 ```
 
+or
+
+```php
+<?php
+
+declare(strict_types=1);
+
+namespace App\EventListener\Workflow;
+
+use MonsieurBiz\SyliusOrderHistoryPlugin\Entity\OrderHistoryEventInterface;
+use MonsieurBiz\SyliusOrderHistoryPlugin\Notifier\OrderHistoryNotifierInterface;
+use MonsieurBiz\SyliusOrderHistoryPlugin\Notifier\OrderHistoryWithAddressesDataNotifier;
+use Sylius\Component\Core\Model\OrderInterface;
+use Symfony\Component\EventDispatcher\Attribute\AsEventListener;
+use Symfony\Component\Workflow\Event\CompletedEvent;
+
+final class CheckoutWorkflowEventListener
+{
+    public function __construct(
+        #[Autowire(service: OrderHistoryWithAddressesDataNotifier::class)]
+        private OrderHistoryNotifierInterface $orderHistoryWithAddressesDataNotifier,
+    ) {
+    }
+
+    #[AsEventListener(event: 'workflow.sylius_order_checkout.completed.addressed')]
+    public function addressed(CompletedEvent $event): void
+    {
+        $order = $event->getSubject();
+        if (!$order instanceof OrderInterface) {
+            return;
+        }
+
+        $this->orderHistoryWithAddressesDataNotifier->notifyEvent(
+            $order,
+            OrderHistoryEventInterface::TYPE_CHECKOUT,
+            'addressed',
+        );
+    }
+}
+```
+
 Callback dedicated notifier service / actions who add different details following context:
 * `\MonsieurBiz\SyliusOrderHistoryPlugin\Notifier\OrderHistoryNotifier` is a basic notifier with no particular details 
     except the given ones as parameters.

diff --git a/src/EventListener/Workflow/CheckoutWorkflowEventListener.php b/src/EventListener/Workflow/CheckoutWorkflowEventListener.php
@@ -0,0 +1,97 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MonsieurBiz\SyliusOrderHistoryPlugin\EventListener\Workflow;
+
+use MonsieurBiz\SyliusOrderHistoryPlugin\Entity\OrderHistoryEventInterface;
+use MonsieurBiz\SyliusOrderHistoryPlugin\Notifier\OrderHistoryNotifier;
+use MonsieurBiz\SyliusOrderHistoryPlugin\Notifier\OrderHistoryNotifierInterface;
+use MonsieurBiz\SyliusOrderHistoryPlugin\Notifier\OrderHistoryWithAddressesDataNotifier;
+use MonsieurBiz\SyliusOrderHistoryPlugin\Notifier\OrderHistoryWithPaymentDataNotifier;
+use MonsieurBiz\SyliusOrderHistoryPlugin\Notifier\OrderHistoryWithShipmentDataNotifier;
+use Sylius\Component\Core\Model\OrderInterface;
+use Symfony\Component\DependencyInjection\Attribute\Autowire;
+use Symfony\Component\EventDispatcher\Attribute\AsEventListener;
+use Symfony\Component\Workflow\Event\CompletedEvent;
+
+final class CheckoutWorkflowEventListener
+{
+    public function __construct(
+        #[Autowire(service: OrderHistoryWithAddressesDataNotifier::class)]
+        private OrderHistoryNotifierInterface $orderHistoryWithAddressesDataNotifier,
+        #[Autowire(service: OrderHistoryNotifier::class)]
+        private OrderHistoryNotifierInterface $orderHistoryNotifier,
+        #[Autowire(service: OrderHistoryWithShipmentDataNotifier::class)]
+        private OrderHistoryNotifierInterface $orderHistoryWithShipmentDataNotifier,
+        #[Autowire(service: OrderHistoryWithPaymentDataNotifier::class)]
+        private OrderHistoryNotifierInterface $orderHistoryWithPaymentDataNotifier,
+    ) {
+    }
+
+    #[AsEventListener(event: 'workflow.sylius_order_checkout.completed.addressed')]
+    public function addressed(CompletedEvent $event): void
+    {
+        $order = $event->getSubject();
+        if (!$order instanceof OrderInterface) {
+            return;
+        }
+
+        $this->orderHistoryWithAddressesDataNotifier->notifyEvent($order, OrderHistoryEventInterface::TYPE_CHECKOUT, 'addressed');
+    }
+
+    #[AsEventListener(event: 'workflow.sylius_order_checkout.completed.skip_shipping')]
+    public function shippingSkipped(CompletedEvent $event): void
+    {
+        $order = $event->getSubject();
+        if (!$order instanceof OrderInterface) {
+            return;
+        }
+
+        $this->orderHistoryNotifier->notifyEvent($order, OrderHistoryEventInterface::TYPE_CHECKOUT, 'shipping_skipped');
+    }
+
+    #[AsEventListener(event: 'workflow.sylius_order_checkout.completed.select_shipping')]
+    public function shippingSelected(CompletedEvent $event): void
+    {
+        $order = $event->getSubject();
+        if (!$order instanceof OrderInterface) {
+            return;
+        }
+
+        $this->orderHistoryWithShipmentDataNotifier->notifyEvent($order, OrderHistoryEventInterface::TYPE_CHECKOUT, 'shipping_selected');
+    }
+
+    #[AsEventListener(event: 'workflow.sylius_order_checkout.completed.skip_payment')]
+    public function paymentSkipped(CompletedEvent $event): void
+    {
+        $order = $event->getSubject();
+        if (!$order instanceof OrderInterface) {
+            return;
+        }
+
+        $this->orderHistoryNotifier->notifyEvent($order, OrderHistoryEventInterface::TYPE_CHECKOUT, 'payment_skipped');
+    }
+
+    #[AsEventListener(event: 'workflow.sylius_order_checkout.completed.select_payment')]
+    public function paymentSelected(CompletedEvent $event): void
+    {
+        $order = $event->getSubject();
+        if (!$order instanceof OrderInterface) {
+            return;
+        }
+
+        $this->orderHistoryWithPaymentDataNotifier->notifyEvent($order, OrderHistoryEventInterface::TYPE_CHECKOUT, 'payment_selected');
+    }
+
+    #[AsEventListener(event: 'workflow.sylius_order_checkout.completed.complete')]
+    public function completed(CompletedEvent $event): void
+    {
+        $order = $event->getSubject();
+        if (!$order instanceof OrderInterface) {
+            return;
+        }
+
+        $this->orderHistoryNotifier->notifyEvent($order, OrderHistoryEventInterface::TYPE_CHECKOUT, 'completed');
+    }
+}
diff --git a/src/EventListener/Workflow/OrderWorkflowEventListener.php b/src/EventListener/Workflow/OrderWorkflowEventListener.php
@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MonsieurBiz\SyliusOrderHistoryPlugin\EventListener\Workflow;
+
+use MonsieurBiz\SyliusOrderHistoryPlugin\Entity\OrderHistoryEventInterface;
+use MonsieurBiz\SyliusOrderHistoryPlugin\Notifier\OrderHistoryNotifier;
+use MonsieurBiz\SyliusOrderHistoryPlugin\Notifier\OrderHistoryNotifierInterface;
+use Sylius\Component\Core\Model\OrderInterface;
+use Symfony\Component\DependencyInjection\Attribute\Autowire;
+use Symfony\Component\EventDispatcher\Attribute\AsEventListener;
+use Symfony\Component\Workflow\Event\CompletedEvent;
+
+final class OrderWorkflowEventListener
+{
+    public function __construct(
+        #[Autowire(service: OrderHistoryNotifier::class)]
+        private OrderHistoryNotifierInterface $orderHistoryNotifier,
+    ) {
+    }
+
+    #[AsEventListener(event: 'workflow.sylius_order.completed.create')]
+    public function new(CompletedEvent $event): void
+    {
+        $order = $event->getSubject();
+        if (!$order instanceof OrderInterface) {
+            return;
+        }
+
+        $this->orderHistoryNotifier->notifyEvent($order, OrderHistoryEventInterface::TYPE_ORDER, 'new');
+    }
+
+    #[AsEventListener(event: 'workflow.sylius_order.completed.cancel')]
+    public function cancelled(CompletedEvent $event): void
+    {
+        $order = $event->getSubject();
+        if (!$order instanceof OrderInterface) {
+            return;
+        }
+
+        $this->orderHistoryNotifier->notifyEvent($order, OrderHistoryEventInterface::TYPE_ORDER, 'cancelled');
+    }
+
+    #[AsEventListener(event: 'workflow.sylius_order.completed.fulfill')]
+    public function fulfilled(CompletedEvent $event): void
+    {
+        $order = $event->getSubject();
+        if (!$order instanceof OrderInterface) {
+            return;
+        }
+
+        $this->orderHistoryNotifier->notifyEvent($order, OrderHistoryEventInterface::TYPE_ORDER, 'fulfilled');
+    }
+}
diff --git a/src/EventListener/Workflow/PaymentWorkflowEventListener.php b/src/EventListener/Workflow/PaymentWorkflowEventListener.php
@@ -0,0 +1,128 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MonsieurBiz\SyliusOrderHistoryPlugin\EventListener\Workflow;
+
+use MonsieurBiz\SyliusOrderHistoryPlugin\Entity\OrderHistoryEventInterface;
+use MonsieurBiz\SyliusOrderHistoryPlugin\Notifier\OrderHistoryNotifierInterface;
+use MonsieurBiz\SyliusOrderHistoryPlugin\Notifier\OrderHistoryWithPaymentDataNotifier;
+use Sylius\Component\Core\Model\OrderInterface;
+use Sylius\Component\Core\Model\PaymentInterface;
+use Symfony\Component\DependencyInjection\Attribute\Autowire;
+use Symfony\Component\EventDispatcher\Attribute\AsEventListener;
+use Symfony\Component\Workflow\Event\CompletedEvent;
+
+final class PaymentWorkflowEventListener
+{
+    public function __construct(
+        #[Autowire(service: OrderHistoryWithPaymentDataNotifier::class)]
+        private OrderHistoryNotifierInterface $orderHistoryWithPaymentDataNotifier,
+    ) {
+    }
+
+    #[AsEventListener(event: 'workflow.sylius_payment.completed.create')]
+    public function new(CompletedEvent $event): void
+    {
+        $payment = $event->getSubject();
+        if (!$payment instanceof PaymentInterface) {
+            return;
+        }
+        $order = $payment->getOrder();
+        if (!$order instanceof OrderInterface) {
+            return;
+        }
+
+        $this->orderHistoryWithPaymentDataNotifier->notifyEvent($order, OrderHistoryEventInterface::TYPE_PAYMENT, 'new');
+    }
+
+    #[AsEventListener(event: 'workflow.sylius_payment.completed.process')]
+    public function processing(CompletedEvent $event): void
+    {
+        $payment = $event->getSubject();
+        if (!$payment instanceof PaymentInterface) {
+            return;
+        }
+        $order = $payment->getOrder();
+        if (!$order instanceof OrderInterface) {
+            return;
+        }
+
+        $this->orderHistoryWithPaymentDataNotifier->notifyEvent($order, OrderHistoryEventInterface::TYPE_PAYMENT, 'processing');
+    }
+
+    #[AsEventListener(event: 'workflow.sylius_payment.completed.authorize')]
+    public function authorized(CompletedEvent $event): void
+    {
+        $payment = $event->getSubject();
+        if (!$payment instanceof PaymentInterface) {
+            return;
+        }
+        $order = $payment->getOrder();
+        if (!$order instanceof OrderInterface) {
+            return;
+        }
+
+        $this->orderHistoryWithPaymentDataNotifier->notifyEvent($order, OrderHistoryEventInterface::TYPE_PAYMENT, 'authorized');
+    }
+
+    #[AsEventListener(event: 'workflow.sylius_payment.completed.complete')]
+    public function completed(CompletedEvent $event): void
+    {
+        $payment = $event->getSubject();
+        if (!$payment instanceof PaymentInterface) {
+            return;
+        }
+        $order = $payment->getOrder();
+        if (!$order instanceof OrderInterface) {
+            return;
+        }
+
+        $this->orderHistoryWithPaymentDataNotifier->notifyEvent($order, OrderHistoryEventInterface::TYPE_PAYMENT, 'completed');
+    }
+
+    #[AsEventListener(event: 'workflow.sylius_payment.completed.fail')]
+    public function failed(CompletedEvent $event): void
+    {
+        $payment = $event->getSubject();
+        if (!$payment instanceof PaymentInterface) {
+            return;
+        }
+        $order = $payment->getOrder();
+        if (!$order instanceof OrderInterface) {
+            return;
+        }
+
+        $this->orderHistoryWithPaymentDataNotifier->notifyEvent($order, OrderHistoryEventInterface::TYPE_PAYMENT, 'failed');
+    }
+
+    #[AsEventListener(event: 'workflow.sylius_payment.completed.cancel')]
+    public function cancelled(CompletedEvent $event): void
+    {
+        $payment = $event->getSubject();
+        if (!$payment instanceof PaymentInterface) {
+            return;
+        }
+        $order = $payment->getOrder();
+        if (!$order instanceof OrderInterface) {
+            return;
+        }
+
+        $this->orderHistoryWithPaymentDataNotifier->notifyEvent($order, OrderHistoryEventInterface::TYPE_PAYMENT, 'cancelled');
+    }
+
+    #[AsEventListener(event: 'workflow.sylius_payment.completed.refund')]
+    public function refunded(CompletedEvent $event): void
+    {
+        $payment = $event->getSubject();
+        if (!$payment instanceof PaymentInterface) {
+            return;
+        }
+        $order = $payment->getOrder();
+        if (!$order instanceof OrderInterface) {
+            return;
+        }
+
+        $this->orderHistoryWithPaymentDataNotifier->notifyEvent($order, OrderHistoryEventInterface::TYPE_PAYMENT, 'refunded');
+    }
+}