Added the PaymentMethodSelected checkout event

Changelog.md

@@ -32,6 +32,7 @@
     - `CouponAdded` (to checkout)
     - `CouponRemoved` (from checkout)
     - `CouponUtilized` (after a successful checkout converted to an order)
+    - `PaymentMethodSelected`
 - Added a listener to update coupon and promo usage after a `CouponUtilized` event (Foundation)
 - Added a promotion calculation listener (on CouponAdded and CouponRemoved events)
 - Added the `PercentDiscount` adjuster class

src/Checkout/Changelog.md

@@ -17,6 +17,7 @@
   - `CouponAdded` (to checkout)
   - `CouponRemoved` (from checkout)
   - `CouponUtilized` (after a successful checkout converted to an order)
+  - `PaymentMethodSelected`
 
 ## 4.1.0
 ##### 2024-07-11

src/Checkout/Drivers/BaseCheckoutStore.php

@@ -23,6 +23,7 @@
 use Vanilo\Checkout\Events\BillpayerChanged;
 use Vanilo\Checkout\Events\CouponAdded;
 use Vanilo\Checkout\Events\CouponRemoved;
+use Vanilo\Checkout\Events\PaymentMethodSelected;
 use Vanilo\Checkout\Events\ShippingMethodSelected;
 use Vanilo\Checkout\Models\CheckoutStateProxy;
 use Vanilo\Checkout\Traits\EmulatesFillAttributes;
@@ -154,7 +155,12 @@ public function getPaymentMethodId(): null|int|string
 
     public function setPaymentMethodId(null|int|string $paymentMethodId): void
     {
+        $old = $this->getPaymentMethodId();
         $this->writeRawDataToStore('payment_method_id', $paymentMethodId);
+
+        if ($old !== $paymentMethodId) {
+            Event::dispatch(new PaymentMethodSelected($this, $old));
+        }
     }
 
     public function getNotes(): ?string

src/Checkout/Events/PaymentMethodSelected.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Contains the PaymentMethodSelected event class.
+ *
+ * @copyright   Copyright (c) 2024 Vanilo UG
+ * @author      Attila Fulop
+ * @license     MIT
+ * @since       2024-11-11
+ *
+ */
+
+namespace Vanilo\Checkout\Events;
+
+use Vanilo\Checkout\Contracts\Checkout;
+
+class PaymentMethodSelected extends BaseCheckoutEvent
+{
+    protected null|int|string $oldPaymentMethodId;
+
+    protected null|int|string $newPaymentMethodId;
+
+    public function __construct(Checkout $checkout, null|int|string $oldPaymentMethodId)
+    {
+        parent::__construct($checkout);
+        $this->oldPaymentMethodId = $oldPaymentMethodId;
+        $this->newPaymentMethodId = $checkout->getPaymentMethodId();
+    }
+
+    public function selectedPaymentMethodId(): null|int|string
+    {
+        return $this->newPaymentMethodId;
+    }
+
+    public function oldPaymentMethodId(): null|int|string
+    {
+        return $this->oldPaymentMethodId;
+    }
+}