Add separator between Refund and Partial Refund (#17)

Partial Refunds requires Items to be passed

Author: aawnu

src/Event/Refund.php

@@ -18,6 +18,21 @@ class Refund extends Model\Event implements Facade\Refund
     protected $tax;
     protected $items = [];
 
+    private $isFullRefund = false;
+
+    /**
+     * Full refunds does not require items to be passed. \
+     * This will skip the items check if true
+     *
+     * @param boolean $is
+     * @return static
+     */
+    public function isFullRefund(bool $is)
+    {
+        $this->isFullRefund = $is;
+        return $this;
+    }
+
     public function getName(): string
     {
         return 'refund';
@@ -52,7 +67,11 @@ public function getRequiredParams(): array
         }
 
         $return[] = 'transaction_id';
-        $return[] = 'items';
+
+        if (!$this->isFullRefund) {
+            $return[] = 'items';
+        }
+
         return $return;
     }
 

test/AnalyticsTest.php

@@ -1,6 +1,7 @@
 <?php
 
 use AlexWestergaard\PhpGa4\Analytics;
+use AlexWestergaard\PhpGa4\Event\Refund;
 use AlexWestergaard\PhpGa4\Item;
 use AlexWestergaard\PhpGa4\UserProperty;
 use AlexWestergaard\PhpGa4\GA4Exception;
@@ -104,6 +105,45 @@ public function testUserProperty()
         $this->assertTrue($this->analytics->post());
     }
 
+    public function testFullRefundNoItems()
+    {
+        $this->prepareSituation();
+
+        $refund = Refund::new()->setTransactionId(1)->isFullRefund(true);
+
+        $this->analytics->addEvent($refund);
+
+        $this->assertTrue($this->analytics->post());
+    }
+
+    public function testPartialRefundWithItems()
+    {
+        $this->prepareSituation();
+
+        $refund = Refund::new()->setTransactionId(1)->addItem($this->item);
+
+        $this->analytics->addEvent($refund);
+
+        $arr = $this->analytics->toArray();
+        $this->assertTrue(is_array($arr));
+
+        $arr = $refund->toArray();
+        $this->assertArrayHasKey('params', $arr);
+        $arr = $arr['params'];
+        $this->assertArrayHasKey('items', $arr);
+    }
+
+    public function testPartialRefundNoItemsThrows()
+    {
+        $this->prepareSituation();
+
+        $refund = Refund::new()->setTransactionId(1);
+
+        $this->expectException(GA4Exception::class);
+
+        $this->analytics->addEvent($refund);
+    }
+
     public function testPrebuildEvents()
     {
         $this->prepareSituation();