Added the CouponUtilized event

Changelog.md

@@ -13,6 +13,10 @@
   - `hasAnyCoupon()`
   - `getPromotionsAmount()`
   - `setPromotionsAmount()`
+- Added the following events:
+  - `CouponAdded` (to checkout)
+  - `CouponRemoved` (from checkout)
+  - `CouponUtilized` (after a successful checkout converted to an order)
 
 ## 4.1.0
 ##### 2024-07-11

Contracts/CouponEvent.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Vanilo\Checkout\Contracts;
+
+interface CouponEvent extends CheckoutEvent
+{
+    public function getCouponCode(): string;
+}

Events/BaseCouponEvent.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Contains the BaseCouponEvent class.
+ *
+ * @copyright   Copyright (c) 2024 Vanilo UG
+ * @author      Attila Fulop
+ * @license     MIT
+ * @since       2024-08-24
+ *
+ */
+
+namespace Vanilo\Checkout\Events;
+
+use Vanilo\Checkout\Contracts\Checkout;
+use Vanilo\Checkout\Contracts\CouponEvent;
+
+abstract class BaseCouponEvent extends BaseCheckoutEvent implements CouponEvent
+{
+    public readonly string $couponCode;
+
+    public function __construct(Checkout $checkout, string $couponCode)
+    {
+        parent::__construct($checkout);
+        $this->couponCode = $couponCode;
+    }
+
+    public function getCouponCode(): string
+    {
+        return $this->couponCode;
+    }
+}

Events/CouponAdded.php

@@ -3,7 +3,7 @@
 declare(strict_types=1);
 
 /**
- * Contains the CouponAdded class.
+ * Contains the CouponAdded event class.
  *
  * @copyright   Copyright (c) 2024 Vanilo UG
  * @author      Attila Fulop
@@ -14,15 +14,6 @@
 
 namespace Vanilo\Checkout\Events;
 
-use Vanilo\Checkout\Contracts\Checkout;
-
-class CouponAdded extends BaseCheckoutEvent
+class CouponAdded extends BaseCouponEvent
 {
-    public readonly string $couponCode;
-
-    public function __construct(Checkout $checkout, string $couponCode)
-    {
-        parent::__construct($checkout);
-        $this->couponCode = $couponCode;
-    }
 }

Events/CouponRemoved.php

@@ -3,7 +3,7 @@
 declare(strict_types=1);
 
 /**
- * Contains the CouponRemoved class.
+ * Contains the CouponRemoved event class.
  *
  * @copyright   Copyright (c) 2024 Vanilo UG
  * @author      Attila Fulop
@@ -14,15 +14,6 @@
 
 namespace Vanilo\Checkout\Events;
 
-use Vanilo\Checkout\Contracts\Checkout;
-
-class CouponRemoved extends BaseCheckoutEvent
+class CouponRemoved extends BaseCouponEvent
 {
-    public readonly string $couponCode;
-
-    public function __construct(Checkout $checkout, string $couponCode)
-    {
-        parent::__construct($checkout);
-        $this->couponCode = $couponCode;
-    }
 }

Events/CouponUtilized.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Contains the CouponUtilized Event class
+ *
+ * @copyright   Copyright (c) 2024 Vanilo UG
+ * @author      Attila Fulop
+ * @license     MIT
+ * @since       2024-08-24
+ *
+ */
+
+namespace Vanilo\Checkout\Events;
+
+class CouponUtilized extends BaseCouponEvent
+{
+}