Enable debug mode for individual events on live (#25)

Author: aawnu

src/Model/Event.php

@@ -7,44 +7,20 @@
 
 abstract class Event extends ToArray implements Facade\Export
 {
+    private $debug = false;
+
     /**
      * Return the name of the event
      *
      * @return string
      */
     abstract public function getName(): string;
 
-    public static function fromArray(array $params = [])
+    public function debug($on = true)
     {
-        $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;
-                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;
+        $this->debug = boolval($on);
+        
+        return $this;
     }
 
     /**
@@ -96,6 +72,10 @@ public function toArray(bool $isParent = false): array
 
         $parent = parent::toArray(true);
 
+        if ($this->debug) {
+            $parent['debug_mode'] = true;
+        }
+
         if (!$isParent && GA4Exception::hasStack()) {
             throw GA4Exception::getFinalStack();
         }
@@ -107,6 +87,39 @@ public function toArray(bool $isParent = false): array
         return $return;
     }
 
+    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;
+                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;
+    }
+
     public static function new()
     {
         return new static();

test/AnalyticsTest.php

@@ -267,6 +267,16 @@ public function testPrebuildEvents()
         $this->assertTrue($this->analytics->post());
     }
 
+    public function testEventCanAddDebugParameter()
+    {
+        $this->prepareSituation();
+
+        $event = Event\Refund::new()->setTransactionId(1)->addItem($this->item)->debug()->toArray();
+
+        $this->assertArrayHasKey('debug_mode', $event['params']);
+        $this->assertTrue($event['params']['debug_mode']);
+    }
+
     public function testBuildEventFromArray()
     {
         $this->prepareSituation();