Add static fromArray() method to Events and Items (#22)

Author: aawnu

src/Item.php

@@ -2,8 +2,8 @@
 
 namespace AlexWestergaard\PhpGa4;
 
-use AlexWestergaard\PhpGa4\Facade;
 use AlexWestergaard\PhpGa4\Model;
+use AlexWestergaard\PhpGa4\Facade;
 
 /**
  * @requires One of item_id or item_name must be present and valid
@@ -168,6 +168,29 @@ public function getRequiredParams(): array
         return $return;
     }
 
+    public static function fromArray(array $params = [])
+    {
+        $item = static::new();
+
+        $insertables = array_unique(array_merge($item->getParams(), $item->getRequiredParams()));
+
+        foreach ($insertables as $insertable) {
+            if (!in_array($insertable, array_keys($params)) || is_null($param = $params[$insertable])) {
+                continue;
+            }
+
+            $callableName = implode('', array_map('ucfirst', explode('_', $insertable)));
+
+            if (method_exists($item, ($method = 'add' . $callableName))) {
+                $item->$method($param);
+            } elseif (method_exists($item, ($method = 'set' . $callableName))) {
+                $item->$method($param);
+            }
+        }
+
+        return $item;
+    }
+
     /**
      * @param GA4Exception $childErrors
      */

src/Model/Event.php

@@ -2,8 +2,8 @@
 
 namespace AlexWestergaard\PhpGa4\Model;
 
-use AlexWestergaard\PhpGa4\GA4Exception;
 use AlexWestergaard\PhpGa4\Facade;
+use AlexWestergaard\PhpGa4\GA4Exception;
 
 abstract class Event extends ToArray implements Facade\Export
 {
@@ -14,6 +14,40 @@ abstract class Event extends ToArray implements Facade\Export
      */
     abstract public function getName(): string;
 
+    public static function fromArray(array $params = [])
+    {
+        $event = static::new();
+
+        $insertables = array_unique(array_merge($event->getParams(), $event->getRequiredParams()));
+
+        foreach ($insertables as $insertable) {
+            if (!in_array($insertable, array_keys($params)) || is_null($param = $params[$insertable])) {
+                continue;
+            }
+
+            $callableName = implode('', array_map('ucfirst', explode('_', $insertable)));
+
+            if (is_array($param)) {
+                $callableName = substr($callableName, -1) === 's' ? substr($callableName, 0, -1) : $callableName;
+                var_dump($callableName);
+                foreach ($param as $paramRow) {
+                    if (method_exists($event, ($method = 'add' . $callableName))) {
+                        $event->$method($paramRow);
+                    } elseif (method_exists($event, ($method = 'set' . $callableName))) {
+                        $event->$method($paramRow);
+                    }
+                }
+            } else {
+                if (method_exists($event, ($method = 'add' . $callableName))) {
+                    $event->$method($param);
+                } elseif (method_exists($event, ($method = 'set' . $callableName))) {
+                    $event->$method($param);
+                }
+            }
+        }
+        return $event;
+    }
+
     /**
      * @param GA4Exception $childErrors
      */

test/AnalyticsTest.php

@@ -1,10 +1,10 @@
 <?php
 
-use AlexWestergaard\PhpGa4\Analytics;
-use AlexWestergaard\PhpGa4\Event\Refund;
 use AlexWestergaard\PhpGa4\Item;
-use AlexWestergaard\PhpGa4\UserProperty;
+use AlexWestergaard\PhpGa4\Event;
+use AlexWestergaard\PhpGa4\Analytics;
 use AlexWestergaard\PhpGa4\GA4Exception;
+use AlexWestergaard\PhpGa4\UserProperty;
 
 class AnalyticsTest extends \PHPUnit\Framework\TestCase
 {
@@ -83,6 +83,29 @@ public function testItem()
         $this->assertArrayHasKey('quantity', $arr);
     }
 
+    public function testItemFromArray()
+    {
+        $this->prepareSituation();
+
+        $item = Item::fromArray([
+            'item_id' => '2',
+            'item_name' => 'Second Product',
+            'currency' => $this->prefill['currency'],
+            'price' => 9.99,
+            'quantity' => 4,
+        ]);
+
+        $this->assertInstanceOf(Item::class, $item);
+
+        $arr = $item->toArray();
+        $this->assertTrue(is_array($arr));
+        $this->assertArrayHasKey('item_id', $arr);
+        $this->assertArrayHasKey('item_name', $arr);
+        $this->assertArrayHasKey('currency', $arr);
+        $this->assertArrayHasKey('price', $arr);
+        $this->assertArrayHasKey('quantity', $arr);
+    }
+
     public function testUserProperty()
     {
         $this->prepareSituation();
@@ -109,7 +132,7 @@ public function testFullRefundNoItems()
     {
         $this->prepareSituation();
 
-        $refund = Refund::new()->setTransactionId(1)->isFullRefund(true);
+        $refund = Event\Refund::new()->setTransactionId(1)->isFullRefund(true);
 
         $this->analytics->addEvent($refund);
 
@@ -120,7 +143,7 @@ public function testPartialRefundWithItems()
     {
         $this->prepareSituation();
 
-        $refund = Refund::new()->setTransactionId(1)->addItem($this->item);
+        $refund = Event\Refund::new()->setTransactionId(1)->addItem($this->item);
 
         $this->analytics->addEvent($refund);
 
@@ -137,7 +160,7 @@ public function testPartialRefundNoItemsThrows()
     {
         $this->prepareSituation();
 
-        $refund = Refund::new()->setTransactionId(1);
+        $refund = Event\Refund::new()->setTransactionId(1);
 
         $this->expectException(GA4Exception::class);
 
@@ -243,4 +266,20 @@ public function testPrebuildEvents()
 
         $this->assertTrue($this->analytics->post());
     }
+
+    public function testBuildEventFromArray()
+    {
+        $this->prepareSituation();
+
+        $event = Event\AddToCart::fromArray([
+            'currency' => $this->prefill['currency'],
+            'value' => rand(1000, 10000) / 100,
+            'items' => [$this->item],
+        ]);
+
+        $this->assertTrue(is_array($event->toArray()), get_class($event));
+
+        $this->analytics->addEvent($event);
+        $this->assertTrue($this->analytics->post());
+    }
 }