Add arrayAccess, update types minor changes

Alex Westergaard · Alex Westergaard · commit 584c9daf47de · 2023-02-09T22:13:43.000+01:00
diff --git a/src/Analytics.php b/src/Analytics.php
@@ -84,7 +84,7 @@ public function setUserId(string $id)
     /**
      * @param int|float $microOrUnix time() or microtime(true)
      */
-    public function setTimestamp($microOrUnix)
+    public function setTimestamp(int|float $microOrUnix)
     {
         $secondInMicro = intval(strtr('1_000_000', ['_' => '']));
         $offsetLimit = strtotime('-3 days') * $secondInMicro;
diff --git a/src/Event/Refund.php b/src/Event/Refund.php
@@ -22,9 +22,6 @@ class Refund extends Model\Event implements Facade\Refund
     /**
      * 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)
     {
diff --git a/src/Helper/Helper.php b/src/Helper/Helper.php
@@ -0,0 +1,59 @@
+<?php
+
+namespace AlexWestergaard\PhpGa4\Helper;
+
+class Helper
+{
+    /** @return array<int,string> */
+    public const RESERVED_EVENT_NAMES = [
+        'ad_activeview',
+        'ad_click',
+        'ad_exposure',
+        'ad_impression',
+        'ad_query',
+        'adunit_exposure',
+        'app_clear_data',
+        'app_install',
+        'app_update',
+        'app_remove',
+        'error',
+        'first_open',
+        'first_visit',
+        'in_app_purchase',
+        'notification_dismiss',
+        'notification_foreground',
+        'notification_open',
+        'notification_receive',
+        'os_update',
+        'screen_view',
+        'session_start',
+        'user_engagement',
+    ];
+
+    /** @return array<int,string> */
+    public const RESERVED_USER_PROPERTY_NAMES = [
+        'first_open_time',
+        'first_visit_time',
+        'last_deep_link_referrer',
+        'user_id',
+        'first_open_after_install',
+    ];
+
+    /**
+     * @param string $input
+     * @return string snake_case
+     */
+    public static function snake(string $input)
+    {
+        return strtolower(preg_replace('/(?<!^)[A-Z]/', '_$0', $input));
+    }
+
+    /**
+     * @param string $input
+     * @return string CamelCase
+     */
+    public static function camel(string $input)
+    {
+        return lcfirst(str_replace(' ', '', ucwords(str_replace('_', ' ', $input))));
+    }
+}
diff --git a/src/Item.php b/src/Item.php
@@ -56,15 +56,8 @@ public function setCurrency(string $iso)
         return $this;
     }
 
-    /**
-     * @param int|float $amount
-     */
-    public function setDiscount($amount)
+    public function setDiscount(int|float $amount)
     {
-        if (!is_numeric($amount)) {
-            throw new GA4Exception("setDiscount value must be numeric");
-        }
-
         $this->discount = $amount;
         return $this;
     }
@@ -111,15 +104,8 @@ public function setLocationId(string $id)
         return $this;
     }
 
-    /**
-     * @param int|float $amount
-     */
-    public function setPrice($amount)
+    public function setPrice(int|float $amount)
     {
-        if (!is_numeric($amount)) {
-            throw new GA4Exception("setPrice value must be numeric");
-        }
-
         $this->price = 0 + $amount;
         return $this;
     }
@@ -191,14 +177,12 @@ public static function fromArray(array $params = [])
         return $item;
     }
 
-    /**
-     * @param GA4Exception $childErrors
-     */
-    public function toArray(bool $isParent = false, $childErrors = null): array
+    public function toArray(bool $isParent = false, GA4Exception|null $childErrors = null): array
     {
         if (!($childErrors instanceof GA4Exception) && $childErrors !== null) {
             throw new GA4Exception("$childErrors is neither NULL of instance of GA4Exception");
         }
+        
         $return = parent::toArray($isParent, $childErrors);
 
         if (isset($return['item_category'])) {
diff --git a/src/Model/Event.php b/src/Model/Event.php
@@ -2,10 +2,12 @@
 
 namespace AlexWestergaard\PhpGa4\Model;
 
+use ArrayAccess;
 use AlexWestergaard\PhpGa4\Facade;
 use AlexWestergaard\PhpGa4\GA4Exception;
+use AlexWestergaard\PhpGa4\Helper\Helper;
 
-abstract class Event extends ToArray implements Facade\Export
+abstract class Event extends ToArray implements Facade\Export, ArrayAccess
 {
     private $debug = false;
 
@@ -19,10 +21,60 @@ abstract public function getName(): string;
     public function debug($on = true)
     {
         $this->debug = boolval($on);
-        
+
         return $this;
     }
 
+    public function offsetExists(mixed $offset): bool
+    {
+        return property_exists($this, Helper::snake($offset));
+    }
+
+    public function offsetGet(mixed $offset): mixed
+    {
+        $callable = Helper::snake($offset);
+        return $this->offsetExists($callable) ? $this->$callable : null;
+    }
+
+    public function offsetSet(mixed $offset, mixed $value): void
+    {
+        $callable = Helper::camel($offset);
+        if ($this->offsetExists($offset)) {
+            $this->$callable = $value;
+            if (method_exists($this, ($method = 'add' . $callable))) {
+                $this->$method($value);
+            } elseif (method_exists($this, ($method = 'set' . $callable))) {
+                $this->$method($value);
+            }
+
+            if (is_array($value)) {
+                $callable = substr($callable, -1) === 's' ? substr($callable, 0, -1) : $callable;
+                
+                foreach ($value as $paramRow) {
+                    if (method_exists($this, ($method = 'add' . $callable))) {
+                        $this->$method($paramRow);
+                    } elseif (method_exists($this, ($method = 'set' . $callable))) {
+                        $this->$method($paramRow);
+                    }
+                }
+            } else {
+                if (method_exists($this, ($method = 'add' . $callable))) {
+                    $this->$method($value);
+                } elseif (method_exists($this, ($method = 'set' . $callable))) {
+                    $this->$method($value);
+                }
+            }
+        }
+    }
+
+    public function offsetUnset(mixed $offset): void
+    {
+        $var = Helper::snake($offset);
+        if ($this->offsetExists($offset)) {
+            $this->$var = null;
+        }
+    }
+
     /**
      * @param GA4Exception $childErrors
      */
@@ -31,7 +83,7 @@ public function toArray(bool $isParent = false): array
         $return = [];
 
         if (!method_exists($this, 'getName')) {
-            GA4Exception::push("'self::getName()' does not exist");
+            GA4Exception::push("'getName()' does not exist");
         } else {
             $name = $this->getName();
             if (empty($name)) {
@@ -40,30 +92,7 @@ public function toArray(bool $isParent = false): array
                 GA4Exception::push("Name '{$name}' can not be longer than 40 characters");
             } elseif (preg_match('/[^\w\d\-]/', $name)) {
                 GA4Exception::push("Name '{$name}' can only be letters, numbers, underscores and dashes");
-            } elseif (in_array($name, [
-                'ad_activeview',
-                'ad_click',
-                'ad_exposure',
-                'ad_impression',
-                'ad_query',
-                'adunit_exposure',
-                'app_clear_data',
-                'app_install',
-                'app_update',
-                'app_remove',
-                'error',
-                'first_open',
-                'first_visit',
-                'in_app_purchase',
-                'notification_dismiss',
-                'notification_foreground',
-                'notification_open',
-                'notification_receive',
-                'os_update',
-                'screen_view',
-                'session_start',
-                'user_engagement',
-            ])) {
+            } elseif (in_array($name, Helper::RESERVED_EVENT_NAMES)) {
                 GA4Exception::push("Name '{$name}' is reserved");
             } else {
                 $return['name'] = $name;
@@ -98,7 +127,7 @@ public static function fromArray(array $params = [])
                 continue;
             }
 
-            $callableName = implode('', array_map('ucfirst', explode('_', $insertable)));
+            $callableName = Helper::camel($insertable);
 
             if (is_array($param)) {
                 $callableName = substr($callableName, -1) === 's' ? substr($callableName, 0, -1) : $callableName;
@@ -117,6 +146,7 @@ public static function fromArray(array $params = [])
                 }
             }
         }
+        
         return $event;
     }
 
diff --git a/src/Model/ToArray.php b/src/Model/ToArray.php
@@ -2,18 +2,15 @@
 
 namespace AlexWestergaard\PhpGa4\Model;
 
-use AlexWestergaard\PhpGa4\GA4Exception;
 use AlexWestergaard\PhpGa4\Facade;
+use AlexWestergaard\PhpGa4\GA4Exception;
 
 abstract class ToArray implements Facade\Export
 {
     abstract public function getParams(): array;
 
     abstract public function getRequiredParams(): array;
 
-    /**
-     * @param GA4Exception $childErrors
-     */
     public function toArray(bool $isParent = false): array
     {
         $return = [];
diff --git a/src/UserProperty.php b/src/UserProperty.php
@@ -3,6 +3,7 @@
 namespace AlexWestergaard\PhpGa4;
 
 use AlexWestergaard\PhpGa4\Facade;
+use AlexWestergaard\PhpGa4\Helper\Helper;
 
 class UserProperty implements Facade\Export
 {
@@ -12,13 +13,7 @@ class UserProperty implements Facade\Export
     public function setName(string $name)
     {
         if (
-            in_array($name, [
-                'first_open_time',
-                'first_visit_time',
-                'last_deep_link_referrer',
-                'user_id',
-                'first_open_after_install',
-            ])
+            in_array($name, Helper::RESERVED_USER_PROPERTY_NAMES)
             || substr($name, 0, 9) == 'firebase_'
             || substr($name, 0, 7) == 'google_'
             || substr($name, 0, 4) == 'ga_'
diff --git a/test/AnalyticsTest.php b/test/AnalyticsTest.php
@@ -67,7 +67,7 @@ public function testItem()
         $this->assertInstanceOf(Item::class, $this->item);
 
         $arr = $this->item->toArray();
-        $this->assertTrue(is_array($arr));
+        $this->assertIsArray($arr);
         $this->assertArrayHasKey('item_id', $arr);
         $this->assertArrayHasKey('item_name', $arr);
         $this->assertArrayHasKey('currency', $arr);
@@ -88,7 +88,7 @@ public function testItemFromArray()
         $this->assertInstanceOf(Item::class, $item);
 
         $arr = $item->toArray();
-        $this->assertTrue(is_array($arr));
+        $this->assertIsArray($arr);
         $this->assertArrayHasKey('item_id', $arr);
         $this->assertArrayHasKey('item_name', $arr);
         $this->assertArrayHasKey('currency', $arr);
@@ -103,7 +103,7 @@ public function testUserProperty()
             ->setValue('premium');
 
         $this->assertInstanceOf(UserProperty::class, $userProperty);
-        $this->assertTrue(is_array($userProperty->toArray()));
+        $this->assertIsArray($userProperty->toArray());
 
         $this->analytics->addUserProperty($userProperty);
 
@@ -132,7 +132,7 @@ public function testPartialRefundWithItems()
         $this->analytics->addEvent($refund);
 
         $arr = $this->analytics->toArray();
-        $this->assertTrue(is_array($arr));
+        $this->assertIsArray($arr);
 
         $arr = $refund->toArray();
         $this->assertArrayHasKey('params', $arr);
@@ -239,7 +239,7 @@ public function testPrebuildEvents()
                 $event->setGroupId('999');
             }
 
-            $this->assertTrue(is_array($event->toArray()), $eventName);
+            $this->assertIsArray($event->toArray(), $eventName);
 
             $this->analytics->addEvent($event);
         }
@@ -263,9 +263,24 @@ public function testBuildEventFromArray()
             'items' => [$this->item],
         ]);
 
-        $this->assertTrue(is_array($event->toArray()), get_class($event));
+        $this->assertIsArray($event->toArray(), get_class($event));
 
         $this->analytics->addEvent($event);
         $this->assertTrue($this->analytics->post());
     }
+
+    public function testEventArrayable()
+    {
+        $event = new Event\AddToCart();
+        $event['currency'] = $this->prefill['currency'];
+        $event['value'] = ($value = rand(1000, 10000) / 100);
+
+        $this->assertArrayHasKey('currency', $event);
+        $this->assertArrayHasKey('value', $event);
+        $this->assertArrayHasKey('items', $event);
+
+        $this->assertEquals($this->prefill['currency'], $event['currency']);
+        $this->assertEquals($value, $event['value']);
+        $this->assertIsArray($event['items']);
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ public function setUserId(string $id)`
`84`	`84`	`/**`
`85`	`85`	`* @param int\|float $microOrUnix time() or microtime(true)`
`86`	`86`	`*/`
`87`		`- public function setTimestamp($microOrUnix)`
	`87`	`+ public function setTimestamp(int\|float $microOrUnix)`
`88`	`88`	`{`
`89`	`89`	`$secondInMicro = intval(strtr('1_000_000', ['_' => '']));`
`90`	`90`	`$offsetLimit = strtotime('-3 days') * $secondInMicro;`
Original file line number	Diff line number	Diff line change
`@@ -56,15 +56,8 @@ public function setCurrency(string $iso)`
`56`	`56`	`return $this;`
`57`	`57`	`}`
`58`	`58`
`59`		`- /**`
`60`		`- * @param int\|float $amount`
`61`		`- */`
`62`		`- public function setDiscount($amount)`
	`59`	`+ public function setDiscount(int\|float $amount)`
`63`	`60`	`{`
`64`		`- if (!is_numeric($amount)) {`
`65`		`- throw new GA4Exception("setDiscount value must be numeric");`
`66`		`- }`
`67`		`-`
`68`	`61`	`$this->discount = $amount;`
`69`	`62`	`return $this;`
`70`	`63`	`}`
`@@ -111,15 +104,8 @@ public function setLocationId(string $id)`
`111`	`104`	`return $this;`
`112`	`105`	`}`
`113`	`106`
`114`		`- /**`
`115`		`- * @param int\|float $amount`
`116`		`- */`
`117`		`- public function setPrice($amount)`
	`107`	`+ public function setPrice(int\|float $amount)`
`118`	`108`	`{`
`119`		`- if (!is_numeric($amount)) {`
`120`		`- throw new GA4Exception("setPrice value must be numeric");`
`121`		`- }`
`122`		`-`
`123`	`109`	`$this->price = 0 + $amount;`
`124`	`110`	`return $this;`
`125`	`111`	`}`
`@@ -191,14 +177,12 @@ public static function fromArray(array $params = [])`
`191`	`177`	`return $item;`
`192`	`178`	`}`
`193`	`179`
`194`		`- /**`
`195`		`- * @param GA4Exception $childErrors`
`196`		`- */`
`197`		`- public function toArray(bool $isParent = false, $childErrors = null): array`
	`180`	`+ public function toArray(bool $isParent = false, GA4Exception\|null $childErrors = null): array`
`198`	`181`	`{`
`199`	`182`	`if (!($childErrors instanceof GA4Exception) && $childErrors !== null) {`
`200`	`183`	`throw new GA4Exception("$childErrors is neither NULL of instance of GA4Exception");`
`201`	`184`	`}`
	`185`	`+`
`202`	`186`	`$return = parent::toArray($isParent, $childErrors);`
`203`	`187`
`204`	`188`	`if (isset($return['item_category'])) {`