Clean up for Version 2.0 (#101)

Author: aawnu

.github/dependabot.yml

@@ -1,6 +1,5 @@
 version: 2
 updates:
-
   # Maintain dependencies for GitHub Actions
   - package-ecosystem: "github-actions"
     directory: "/"
@@ -9,7 +8,7 @@ updates:
       day: "monday"
     assignees:
       - "octocat"
-      
+
   # Maintain dependencies for Composer
   - package-ecosystem: "composer"
     directory: "/"

README.md

@@ -1,3 +1,5 @@
+# Google Analytics 4 Server-Side PHP Package
+
 [![Version](https://img.shields.io/packagist/v/alexwestergaard/php-ga4?color=blue&label=stable%20release)](https://github.com/aawnu/php-ga4/releases/latest)
 [![Version](https://img.shields.io/packagist/v/alexwestergaard/php-ga4?color=yellow&include_prereleases&label=latest%20release)](https://github.com/aawnu/php-ga4/releases)
 ![Code Coverage Badge](https://raw.githubusercontent.com/AlexWestergaard/php-ga4/image-data/coverage.svg)
@@ -22,7 +24,7 @@ The European Union have notified that Google Analytics does not comply with GDPR
 
 Setup requires a **Measurement ID** and **API Secret**. Go to Administrator (Bottom left) -> Account -> Data Streams -> {Your Stream}. Here you should find Measurement ID at top and "Api Secrets for Measurement Protocol" a little down the page, where you can create yourself an `API secret`.
 
-Go to `Administrator` (bottom left) and then select your `Account` -> `Data Streams` -> your stream.  
+Go to `Administrator` (bottom left) and then select your `Account` -> `Data Streams` -> your stream.
 Here you will find `Measurement-ID` at top from and further down `Api Secrets for Measurement Protocol`, in there you can create yourself an `API Secret`.
 
 Once you have obtained the credentials, you can initialise the Analytics like this:
@@ -47,7 +49,7 @@ Server Side Tagging is not supposed to replace the frontend Client and session i
 4. Server uses `_ga` (or `_gid`) to send/populate events
    - Eg. GenerateLead, Purchase, Refund and other backend handled events.
 
-Note: It is entirely possible to push events to backend without acquiring the session cookies from Google Analytics; you will, however, lose information bundled inside the `GTAG.js` request if you do not figure out how to push that via backend too. You can replace the `_ga` and `_gid` sessions with your own uniquely generated id.
+Note: It is entirely possible to push events to backend without acquiring the session cookies from Google Analytics; you will, however, lose information bundled inside the `gtag.js` request if you do not figure out how to push that via backend too. You can replace the `_ga` and `_gid` sessions with your own uniquely generated id.
 
 All requests should follow this structure and contain at least 1 event for Google Analytics to accept it.
 
@@ -87,7 +89,7 @@ $event->setPageReferrer(string $var);
 $event->setPageTitle(string $var);
 $event->setScreenResolution(string $var);
 // Fillable for multiple events
-$eventPage = AlexWestergaard\PhpGa4\Helper\EventParamsHelper();
+$eventPage = AlexWestergaard\PhpGa4\Helper\EventParamsHelper(...);
 $event->setEventPage($eventPage);
 ```
 
@@ -132,18 +134,19 @@ $event->setEventPage($eventPage);
 
 ## Frontend & Backend Communication
 
-This library is built for backend server side tracking, but you will probably trigger most events through frontend with Javascript or Websockets. There will be 2 examples, one as pure backend for logged/queued events and one for frontend to backend communication.
+This library is built for backend server side tracking, but you will probably trigger most events through frontend with Javascript or Websockets.
+There will be 2 examples, one as pure backend for logged/queued events and one for frontend to backend communication.
 
 ### Logging / Queue
 
 ```php
+// require vendor/autoload.php
+
 use AlexWestergaard\PhpGa4\Exception;
 use AlexWestergaard\PhpGa4\Analytics;
 use AlexWestergaard\PhpGa4\Event;
 use AlexWestergaard\PhpGa4\Item;
 
-// require vendor/autoload.php
-
 $visitors = getVisitorsAndEvents(); // pseudo function, make your own logic here
 
 foreach ($visitors as $collection) {
@@ -185,54 +188,6 @@ foreach ($visitors as $collection) {
 
 ```
 
-### Frontend => Backend
-
-#### Frontend
-
-```js
-// array< array< eventName, array<eventParams> > >
-axios.post("/your-api-endpoint/ga4-event-receiver", [
-  // Note each event is its own object inside an array as
-  // this allows to pass the same event type multiple times
-  {
-    addToCart: {
-      currency: "EUR",
-      value: 13.37,
-      items: [
-        {
-          item_id: 1,
-          item_name: "Cup",
-          price: 13.37,
-          quantity: 1,
-        },
-      ],
-    },
-  },
-]);
-```
-
-#### Backend
-
-```php
-use AlexWestergaard\PhpGa4\Helper\ConvertHelper;
-use AlexWestergaard\PhpGa4\Exception;
-use AlexWestergaard\PhpGa4\Analytics;
-use AlexWestergaard\PhpGa4\Event;
-
-// require vendor/autoload.php
-
-try {
-    $events = ConvertHelper::parseEvents($_POST);
-
-    Analytics::new($measurementId, $apiSecret)
-        ->addEvent(...$events)
-        ->post();
-} catch (Exception\Ga4Exception $exception) {
-    // Handle exception
-    // Exceptions might be stacked, check: $exception->getPrevious();
-}
-```
-
 ## Custom Events
 
 You can build your own custom events. All you need is to implement and fullfill the `AlexWestergaard\PhpGa4\Facade\Type\EventType` facade/interface.
@@ -319,11 +274,6 @@ Two important points:
 - Events sent to the Validation Server will not show up in reports.
 - There is no way for events sent through measurement protocol (Server Side) to show up in the `debugView` in Google Analytics Admin.
 
-## Additional information
-
-- Geographic information is only available via automatic collection from gtag, Google Tag Manager, or Google Analytics for Firebase.
-- The `page_view` event works, however it's not documented in the official documentation, so do not rely on it.
-
 ## Documentation
 
 - [Measurement Protocol](https://developers.google.com/analytics/devguides/collection/protocol/ga4)

phpunit.xml

@@ -1,10 +1,15 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php"
-    colors="true" stopOnFailure="false" beStrictAboutTestsThatDoNotTestAnything="true"
-    beStrictAboutTodoAnnotatedTests="true" testdox="true"
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    bootstrap="vendor/autoload.php"
+    colors="true"
+    stopOnFailure="false"
+    beStrictAboutTestsThatDoNotTestAnything="true"
+    testdox="true"
     xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.1/phpunit.xsd"
-    cacheDirectory=".phpunit.cache" displayDetailsOnTestsThatTriggerDeprecations="true"
-    failOnWarning="true">
+    cacheDirectory=".phpunit.cache"
+    displayDetailsOnTestsThatTriggerDeprecations="true"
+    failOnWarning="true"
+    displayDetailsOnPhpunitDeprecations="true">
     <testsuites>
         <testsuite name="Units">
             <directory>test/Unit</directory>

src/Analytics.php

@@ -197,27 +197,4 @@ public static function new(string $measurement_id, string $api_secret, bool $deb
     {
         return new static($measurement_id, $api_secret, $debug);
     }
-
-    /**
-     * Deprecated references
-     */
-
-    /** @deprecated 1.1.9 Please use `Analytics->consent->setAdPersonalizationPermission()` instead */
-    public function setNonPersonalizedAds(bool $exclude)
-    {
-        $this->consent->setAdPersonalizationPermission(!$exclude);
-        return $this;
-    }
-
-    /** @deprecated 1.1.1 Please use `Analytics->consent->setAdPersonalizationPermission()` instead */
-    public function allowPersonalisedAds(bool $allow)
-    {
-        $this->consent->setAdPersonalizationPermission($allow);
-    }
-
-    /** @deprecated 1.1.1 Please use `Analytics->setTimestampMicros()` instead */
-    public function setTimestamp(int|float $microOrUnix)
-    {
-        $this->setTimestampMicros($microOrUnix);
-    }
 }

src/Event/PageView.php

@@ -21,5 +21,4 @@ public function setCurrency(string $iso);
      * @param integer|float $val eg. 7.77
      */
     public function setValue(int|float $val);
-
 }

src/Facade/Group/AddToCartFacade.php

@@ -29,15 +29,7 @@ public function setUserId(string $id);
      * @var timestamp_micros
      * @param integer|float $microOrUnix microtime(true) or time()
      */
-    public function setTimestamp(int|float $microOrUnix);
-
-    /**
-     * Indicate if these events should be used for personalized ads.
-     *
-     * @var non_personalized_ads
-     * @param boolean $allow
-     */
-    public function allowPersonalisedAds(bool $allow);
+    public function setTimestampMicros(int|float $microOrUnix);
 
     /**
      * The user properties for the measurement

src/Facade/Group/AnalyticsFacade.php

@@ -34,14 +34,6 @@ public function setUserId(string $id);
      */
     public function setTimestampMicros(int|float $microOrUnix);
 
-    /**
-     * Indicate if these events should be used for personalized ads.
-     *
-     * @var non_personalized_ads
-     * @param boolean $allow
-     */
-    public function setNonPersonalizedAds(bool $allow);
-
     /**
      * The user properties for the measurement (Up to 25 custom per project, see link)
      *

src/Facade/Type/AnalyticsType.php

@@ -34,14 +34,6 @@ public function setUserId(string $id);
      */
     public function setTimestampMicros(int|float $microOrUnix);
 
-    /**
-     * Indicate if these events should be used for personalized ads.
-     *
-     * @var non_personalized_ads
-     * @param boolean $allow
-     */
-    public function setNonPersonalizedAds(bool $allow);
-
     /**
      * The user properties for the measurement (Up to 25 custom per project, see link)
      *

src/Facade/Type/FirebaseType.php

@@ -6,6 +6,4 @@
  * Use this type to skip reserved names of events inside the EventHelper.
  * NOTICE: reserved names will not pass debugging, be careful with this.
  */
-interface GtmEventType extends EventType
-{
-}
+interface GtmEventType extends EventType {}