Add default event parameters (#41)

~ https://support.google.com/analytics/answer/9234069

Note

The following parameters are collected by default with every event,
including [custom
events](https://support.google.com/analytics/answer/12229021).

language
page_location
page_referrer
page_title
screen_resolution

Author: aawnu

src/Facade/Type/DefaultEventParams.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace AlexWestergaard\PhpGa4\Facade\Type;
+
+interface DefaultEventParams
+{
+    /** @var language */
+    public function setLanguage(string $lang);
+
+    /** @var page_location */
+    public function setPageLocation(string $url);
+
+    /** @var page_referrer */
+    public function setPageReferrer(string $url);
+
+    /** @var page_title */
+    public function setPageTitle(string $title);
+
+    /** @var screen_resolution */
+    public function setScreenResolution(string $wxh);
+
+    public function toArray(): array;
+}

src/Facade/Type/Event.php

@@ -2,7 +2,7 @@
 
 namespace AlexWestergaard\PhpGa4\Facade\Type;
 
-interface Event extends IO
+interface Event extends IO, DefaultEventParams
 {
     /** @return array<int,string> */
     public const RESERVED_NAMES = [

src/Helper/AbstractEvent.php

@@ -3,10 +3,60 @@
 namespace AlexWestergaard\PhpGa4\Helper;
 
 use AlexWestergaard\PhpGa4\Facade\Type\Event;
+use AlexWestergaard\PhpGa4\Facade\Type\DefaultEventParams;
 use AlexWestergaard\PhpGa4\Exception\Ga4EventException;
 
 abstract class AbstractEvent extends AbstractIO implements Event
 {
+    protected null|string $language;
+    protected null|string $page_location;
+    protected null|string $page_referrer;
+    protected null|string $page_title;
+    protected null|string $screen_resolution;
+
+    public function setLanguage(string $lang)
+    {
+        $this->language = $lang;
+        return $this;
+    }
+
+    public function setPageLocation(string $url)
+    {
+        $this->page_location = $url;
+        return $this;
+    }
+
+    public function setPageReferrer(string $url)
+    {
+        $this->page_referrer = $url;
+        return $this;
+    }
+
+    public function setPageTitle(string $title)
+    {
+        $this->page_title = $title;
+        return $this;
+    }
+
+    public function setScreenResolution(string $wxh)
+    {
+        $this->screen_resolution = $wxh;
+        return $this;
+    }
+
+    public function setEventPage(DefaultEventParams $page)
+    {
+        $args = $page->toArray();
+
+        $this->language = $args['language'] ?? null;
+        $this->page_location = $args['page_location'] ?? null;
+        $this->page_referrer = $args['page_referrer'] ?? null;
+        $this->page_title = $args['page_title'] ?? null;
+        $this->screen_resolution = $args['screen_resolution'] ?? null;
+
+        return $this;
+    }
+
     public function toArray(): array
     {
         $return = [];
@@ -34,6 +84,21 @@ public function toArray(): array
         return $return;
     }
 
+    public function getAllParams(): array
+    {
+        return array_unique(array_merge(
+            [
+                'language',
+                'page_location',
+                'page_referrer',
+                'page_title',
+                'screen_resolution',
+            ],
+            $this->getParams(),
+            $this->getRequiredParams()
+        ));
+    }
+
     public static function new(): static
     {
         return new static();

src/Helper/DefaultEventParams.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace AlexWestergaard\PhpGa4\Helper;
+
+use AlexWestergaard\PhpGa4\Facade\Type\DefaultEventParams as TypeDefaultEventParams;
+
+class DefaultEventParams implements TypeDefaultEventParams
+{
+    public function __construct(
+        protected null|string $language = null,
+        protected null|string $page_location = null,
+        protected null|string $page_referrer = null,
+        protected null|string $page_title = null,
+        protected null|string $screen_resolution = null
+    ) {
+    }
+
+    public function setLanguage(string $lang)
+    {
+        $this->language = $lang;
+        return $this;
+    }
+
+    public function setPageLocation(string $url)
+    {
+        $this->page_location = $url;
+        return $this;
+    }
+
+    public function setPageReferrer(string $url)
+    {
+        $this->page_referrer = $url;
+        return $this;
+    }
+
+    public function setPageTitle(string $title)
+    {
+        $this->page_title = $title;
+        return $this;
+    }
+
+    public function setScreenResolution(string $wxh)
+    {
+        $this->screen_resolution = $wxh;
+        return $this;
+    }
+
+    public function toArray(): array
+    {
+        return [
+            'language' => $this->language,
+            'page_location' => $this->page_location,
+            'page_referrer' => $this->page_referrer,
+            'page_title' => $this->page_title,
+            'screen_resolution' => $this->screen_resolution,
+        ];
+    }
+}

test/Unit/EventTest.php

@@ -420,6 +420,12 @@ protected function assertEventFills(AbstractEvent $event)
     private function populateEventByFromArray(TypeEvent $event)
     {
         return $event::fromArray([
+            'language' => 'en-US',
+            'page_location' => '/',
+            'page_referrer' => 'https://example.com/',
+            'page_title' => 'Home - Site',
+            'screen_resolution' => '1920x1080',
+            // ---
             'currency' => $this->prefill['currency'],
             'value' => 9.99,
             'affiliation' => 'affiliation',
@@ -456,6 +462,12 @@ private function populateEventByFromArray(TypeEvent $event)
 
     private function populateEventByArrayable(TypeEvent $event)
     {
+        $event['language'] = 'en-US';
+        $event['page_location'] = '/';
+        $event['page_referrer'] = 'https://example.com/';
+        $event['page_title'] = 'Home - Site';
+        $event['screen_resolution'] = '1920x1080';
+
         $event['currency'] = $this->prefill['currency'];
         $event['value'] = 9.99;
         $event['affiliation'] = 'affiliation';
@@ -496,6 +508,12 @@ private function populateEventByMethod(
     ) {
         $params = $event->getAllParams();
 
+        $event->setLanguage('en-US');
+        $event->setPageLocation('/');
+        $event->setPageReferrer('https://example.com/');
+        $event->setPageTitle('Home - Site');
+        $event->setScreenResolution('1920x1080');
+
         if (in_array('currency', $params)) {
             $event->setCurrency($this->prefill['currency']);
             if (in_array('value', $params)) {