bump version && changelog to 2.7.0

moving the procedere into one step so there's not an accidental triggering of an GA-Push-Event which at the end overwrites the View-Item-Push-Event in the cmpEvent

Application/Model/ManagerHandler.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace D3\GoogleAnalytics4\Application\Model;
+
+use OxidEsales\Eshop\Core\Registry;
+use OxidEsales\Eshop\Core\ViewConfig;
+
+class ManagerHandler
+{
+    /**
+     * @return string
+     */
+    public function getCurrManager() :string
+    {
+        /** @var ManagerTypes $oManagerTypes */
+        $oManagerTypes = oxNew(ManagerTypes::class);
+
+        /** @var ViewConfig $oViewConfig */
+        $oViewConfig = oxNew(ViewConfig::class);
+
+        $aManagerList =  $oManagerTypes->getManagerList();
+
+        foreach ($aManagerList as $managerName){
+           if ($oViewConfig->isModuleActive($managerName)){
+               return $managerName;
+           }
+        }
+
+       return $this->getExplicitManager();
+    }
+
+    /**
+     * @return string
+     */
+    public function getModuleSettingExplicitManagerSelectValue() :string
+    {
+        return Registry::getConfig()->getConfigParam('d3_gtm_settings_HAS_STD_MANAGER');
+    }
+
+    /**
+     * @return string
+     */
+    public function getExplicitManager() :string
+    {
+        $sPotentialManagerName = $this->getModuleSettingExplicitManagerSelectValue();
+
+        /** @var ManagerTypes $oManagerTypes */
+        $oManagerTypes = oxNew(ManagerTypes::class);
+        return $oManagerTypes->isManagerInList($sPotentialManagerName)
+            ? $sPotentialManagerName
+            : "NONE";
+    }
+}

Application/Model/ManagerTypes.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace D3\GoogleAnalytics4\Application\Model;
+
+class ManagerTypes
+{
+    #ToDo: make own classes for each of the manager
+
+
+    const EXTERNAL_SERVICE          = "externalService";
+    const NET_COOKIE_MANAGER        = "net_cookie_manager";
+
+    /**
+     * Further information's:
+     * https://github.com/aggrosoft/oxid-cookie-compliance
+     */
+    const AGCOOKIECOMPLIANCE        = "agcookiecompliance";
+
+    /**
+     * Used the OXID Module.
+     *
+     * Further information's:
+     * https://docs.oxid-esales.com/modules/usercentrics/de/latest/einfuehrung.html
+     *
+     * Usercentrics homepage:
+     * https://usercentrics.com
+     */
+    const USERCENTRICS_MODULE       = "oxps_usercentrics";
+
+    /**
+     * manually included usercentrics script
+     */
+    const USERCENTRICS_MANUALLY     = "USERCENTRICS";
+
+    const CONSENTMANAGER            = "CONSENTMANAGER";
+
+    /**
+     * @return array
+     */
+    public function getManagerList(): array
+    {
+        return [
+            "externalService"       => self::EXTERNAL_SERVICE,
+            "agcookiecompliance"    => self::AGCOOKIECOMPLIANCE,
+            "net_cookie_manager"    => self::NET_COOKIE_MANAGER,
+            "oxps_usercentrics"     => self::USERCENTRICS_MODULE,
+            "usercentrics"          => self::USERCENTRICS_MANUALLY,
+            "consentmanager"        => self::CONSENTMANAGER
+        ];
+    }
+
+    /**
+     * @param string $sManager
+     * @return bool
+     */
+    public function isManagerInList(string $sManager) :bool
+    {
+        return in_array($sManager, $this->getManagerList(), true);
+    }
+}

Application/views/admin/de/module_options.php

@@ -31,8 +31,10 @@ $aLang = [
     // for cookie manager settings
     'SHOP_MODULE_GROUP_d3_gtm_settings_cookiemanager'   => 'Cookie Manager Einstellungen',
     'SHOP_MODULE_d3_gtm_settings_hasOwnCookieManager'   => 'Cookie Manager nutzen?',
-    'SHOP_MODULE_d3_gtm_settings_HAS_CONSENTMANAGER'      => 'Nutzen Sie die Consentmanager-Einbindung?',
-    'SHOP_MODULE_d3_gtm_settings_HAS_CONSENTMANAGER_NO'   => 'Nein',
-    'SHOP_MODULE_d3_gtm_settings_HAS_CONSENTMANAGER_YES'  => 'Ja',
+    'SHOP_MODULE_d3_gtm_settings_HAS_STD_MANAGER'                   => 'Nutzen Sie eine der folgenden Einbindungen?<br>
+                                                                        Dann wählen Sie bitte die zutreffende aus.',
+    'SHOP_MODULE_d3_gtm_settings_HAS_STD_MANAGER_NONE'              => '---',
+    'SHOP_MODULE_d3_gtm_settings_HAS_STD_MANAGER_CONSENTMANAGER'    => 'consentmanager',
+    'SHOP_MODULE_d3_gtm_settings_HAS_STD_MANAGER_USERCENTRICS'      => 'usercentrics',
     'SHOP_MODULE_d3_gtm_settings_cookieName'  => 'CookieID',
 ];

Application/views/blocks/_gtm_nojs.tpl

@@ -1,4 +1,4 @@
-[{if $oViewConf->D3blShowGtmScript() && !$oViewConf->getCookieManagerType()}]
+[{if $oViewConf->D3blShowGtmScript()}]
     [{if $oViewConf->getGtmContainerId()}][{strip}]
     <!-- Google Tag Manager (noscript) -->
     <noscript>

Application/views/ga4/add_to_cart.tpl

@@ -1,11 +1,17 @@
 [{$smarty.block.parent}]
 
-[{assign var="d3ProductObject" value=$oView->getProduct()}]
-[{assign var="d3PriceObject" value=$d3ProductObject->getPrice()}]
+[{* variable $gtmProduct is passed from parent tempalte *}]
+[{assign var="d3PriceObject" value=$gtmProduct->getPrice()}]
+[{assign var="gtmCurrency" value=$oView->getActCurrency()}]
+[{assign var="gtmManufacturer" value=$gtmProduct->getManufacturer()}]
+[{assign var="gtmCategory" value=$gtmProduct->getCategory()}]
 
 [{capture assign=d3_ga4_add_to_cart}]
-[{block name="d3_ga4_add_to_basket"}]
+  [{block name="d3_ga4_add_to_basket"}]
   $("#toBasket").click(function(event) {
+  dataLayer.push({"event": null, "eventLabel": null, "ecommerce": null});  /* Clear the previous ecommerce object. */
+
+  let itemCategories = '[{if $gtmCategory}][{$gtmCategory->getLink()|parse_url:5|ltrim:"/"|rtrim:"/"}][{else}]no category[{/if}]'.split('/');
 
   [{*** Debug cases ***}]
   [{*event.preventDefault();*}]
@@ -36,21 +42,6 @@
       }
     });
   });
-[{/block}]
-[{/capture}]
+  [{/block}]
+  [{/capture}]
 [{oxscript add=$d3_ga4_add_to_cart}]
-
-[{strip}]
-    [{* variable $gtmProduct is passed from parent tempalte *}]
-
-    [{assign var="gtmCurrency" value=$oView->getActCurrency()}]
-    [{assign var="gtmManufacturer" value=$gtmProduct->getManufacturer()}]
-    [{assign var="gtmCategory" value=$gtmProduct->getCategory()}]
-
-    <script>
-      dataLayer.push({"event": null, "eventLabel": null, "ecommerce": null});  /* Clear the previous ecommerce object. */
-
-      let itemCategories = '[{if $gtmCategory}][{$gtmCategory->getLink()|parse_url:5|ltrim:"/"|rtrim:"/"}][{else}]no category[{/if}]'.split('/');
-
-    </script>
-[{/strip}]

Application/views/ga4/view_item_list.tpl

@@ -1,5 +1,5 @@
 [{$smarty.block.parent}]
-[{assign var="gtmProducts" value=$products}]
+[{assign var="gtmProducts" value=$oView->getArticleList()}]
 
 [{assign var="breadCrumb" value=''}]
 

CHANGELOG.md

@@ -4,6 +4,93 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.7.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.6.0...2.7.0) - 2023-06-19
+### Changed
+- add_to_cart event template-structure
+
+## [2.6.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.5.0...2.6.0) - 2023-05-31
+### Added
+- add settings to explicit choose an external service (usercentrics/ consentmanager)
+- position to block-extension
+- extended instructions to check for in readme
+### Fixed
+- usercentrics script
+- missing right articleList-getter
+### Changed
+- view_item_list-template block extension
+- cookieManager handling
+### Removed
+- additional check for cookieManagerType
+
+## [2.5.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.4.0...2.5.0) - 2023-05-23
+### Added
+- additional settings to explicitly indicate that consentmanager is used
+### Fixed
+- unnecessary converting of int to str
+- missing PriceObject-bug
+### Changed
+- genuine code cleanup
+
+## [2.4.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.3.3...2.4.0) - 2023-05-02
+### Added
+- "OXID Cookie Management powered by usercentrics" compatibility
+- usercentrics defined script attributes
+- cookie-manager evaluation
+### Changed
+- genuine clean up of base-js-files
+
+## [2.3.3](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.3.2...2.3.3) - 2023-03-20
+### Fixed
+- metadata file path for view_item
+
+## [2.3.2](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.2.2...2.3.2) - 2023-03-17
+### Added
+- Aggrosoft-Cookie-Consent compatibility
+### Fixed
+- wrong function for pageview on thankyou page
+### Deleted
+- unused files
+
+## [2.2.2](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.2.1...2.2.2) - 2023-02-22
+### Fixed
+- price formatting in view_cart
+
+## [2.2.1](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.1.1...2.2.1) - 2023-02-21
+### Added
+- cookie handling
+
+## [2.1.1](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.1...2.1.1) - 2023-01-27
+### Fixed
+- add missing class import
+
+## [2.1](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.0...2.1) - 2023-01-27
+### Added
+- block section for add_to_basket js
+- template block order positions
+
+## [2.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.1...2.0) - 2023-01-20
+### Added
+- using of ContainerFactory in ViewConfig
+
+## [1.8.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.7.0...1.8.0) - 2023-05-31
+### Fixed
+- bug in explicit manager selection
+
+## [1.7.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.6.0...1.7.0) - 2023-05-31
+### Added
+- extended call to read the technical documentation
+### Changed
+- block-extension for view_item_list
+- way of getting list-articles in view_item_list
+
+## [1.6.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.5.0...1.6.0) - 2023-05-30
+### Added
+- possibility to choose between consentmanager && usercentrics
+- position to block extension
+### Changed
+- genuine code cleanup
+- usercentrics includation script
+
 ## [1.5.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.4.0...1.5.0) - 2023-05-23
 ### Added
 - additional settings to explicitly indicate that consentmanager is used

Docs/README.md

@@ -12,8 +12,8 @@ Für den geregelten Ablauf sind folgende Blöcke nötig:
     - Datei: page/search/search.tpl
     - GA4 Event: view_search_results
 - Artikelliste
-    - Blockname: d3Ga4_view_item_list (muss hinzugefügt werden)
-    - Datei: widget/product/list.tpl
+    - Blockname: page_list_productlist (muss hinzugefügt werden)
+    - Datei: page/list/list.tpl
     - GA4 Event: view_item_list
 - Detailseite
     - Blockname: details_productmain_title
@@ -63,6 +63,14 @@ Aktivieren Sie anschließend diese Weiche. Setzen Sie den Haken bei "Eigenen Coo
     ```Einstell. > Cookie Manager Einstellungen > Cookie-ID``` eintragen
 
 - [OXID Cookie Management powered by usercentrics](https://docs.oxid-esales.com/modules/usercentrics/de/latest/einfuehrung.html)
-  - In der Usercentrics-Verwaltung einen Service für Google Analytics anlegen
-  - Den Service-Namen in den Moduleinstellungen des 'Google Analytics 4' unter
+  - In der Usercentrics-Verwaltung die Services "Google Analytics" und "Google Tag Manager" anlegen
+  - Den Service ```Google Tag Manager``` in den Moduleinstellungen des 'Google Analytics 4' unter
+    Google Tag Manager eintragen
+  - 
+- [Consent Management Provider](https://www.consentmanager.net/)
+  - In der Consentmanager-Oberfläche den Anbieter "Google Tag Manager" mit der ID s905 hinzufügen
+  - Im Frontend, im consentmanager-Pop-up nach dem 'Google Tag Manager' suchen
+    - kleines Fragezeichen neben den Namen anklicken und ganz runter scrollen
+      - prüfen, ob ein Cookie vorgegeben ist
+      - sonst, in der Consentmanager-Oberfläche Cookie-Liste entsprechendes Cookie suchen und im Admin unter
         ```Einstell. > Cookie Manager Einstellungen > Cookie-ID``` eintragen

Modules/Core/ViewConfig.php

@@ -12,9 +12,13 @@
 
 namespace D3\GoogleAnalytics4\Modules\Core;
 
+use D3\GoogleAnalytics4\Application\Model\ManagerHandler;
+use D3\GoogleAnalytics4\Application\Model\ManagerTypes;
 use OxidEsales\Eshop\Application\Controller\FrontendController;
 use OxidEsales\Eshop\Core\Config;
 use OxidEsales\Eshop\Core\Registry;
+use OxidEsales\EshopCommunity\Internal\Container\ContainerFactory;
+use OxidEsales\EshopCommunity\Internal\Framework\Module\Configuration\Bridge\ModuleSettingBridgeInterface;
 
 class ViewConfig extends ViewConfig_parent
 {
@@ -27,42 +31,33 @@ class ViewConfig extends ViewConfig_parent
     {
         if ($this->sContainerId === null)
         {
-
-            $this->sContainerId = $this->getConfig()->getConfigParam('d3_gtm_sContainerID');
+            $this->sContainerId = ContainerFactory::getInstance()
+                                                  ->getContainer()
+                                                  ->get(ModuleSettingBridgeInterface::class)
+                                                  ->get('d3_gtm_sContainerID', 'd3googleanalytics4');
         }
         return $this->sContainerId;
     }
 
-    public function getModuleConsentmanagerSettingSelectValue() :bool
-    {
-        return Registry::getConfig()->getConfigParam('d3_gtm_settings_HAS_CONSENTMANAGER') === 'YES';
-    }
-
-    public function getCookieManagerType()
+    /**
+     * @return void
+     */
+    public function defineCookieManagerType() :void
     {
         if ($this->sCookieManagerType === null)
         {
-            $this->sCookieManagerType = false;
-
-            $allowedManagerTypes = [
-                'net_cookie_manager',
-                'agcookiecompliance',
-                'oxps_usercentrics'
-            ];
-
-            foreach ($allowedManagerTypes as $type) {
-                if ($this->isModuleActive($type)) {
-                    $this->sCookieManagerType = $type;
-                    break;
-                }
+            /** @var ManagerHandler $oManagerHandler */
+            $oManagerHandler = oxNew(ManagerHandler::class);
+            $this->sCookieManagerType = $oManagerHandler->getCurrManager();
         }
     }
 
-        if ($this->sCookieManagerType === false and $this->getModuleConsentmanagerSettingSelectValue()){
-            return "consentmanager";
-        }
-
-        return $this->sCookieManagerType;
+    /**
+     * @return bool
+     */
+    public function shallUseOwnCookieManager() :bool
+    {
+        return (bool) Registry::getConfig()->getConfigParam('d3_gtm_settings_hasOwnCookieManager');
     }
 
     /**
@@ -74,29 +69,37 @@ class ViewConfig extends ViewConfig_parent
         $oConfig = Registry::getConfig();
 
         // No Cookie Manager in use
-        if (!$oConfig->getConfigParam('d3_gtm_settings_hasOwnCookieManager')) {
+        if (!$this->shallUseOwnCookieManager()) {
             return true;
         }
 
+        $this->defineCookieManagerType();
+
         $sCookieID = $oConfig->getConfigParam('d3_gtm_settings_cookieName');
 
         // Netensio Cookie Manager
-        if ($this->getCookieManagerType() == "net_cookie_manager") {
+        if ($this->sCookieManagerType === ManagerTypes::NET_COOKIE_MANAGER) {
             $oSession = Registry::getSession();
             $aCookies = $oSession->getVariable("aCookieSel");
 
-            return (!is_null($aCookies) && is_array($aCookies) && array_key_exists($sCookieID, $aCookies) && $aCookies[$sCookieID] == "1");
+            return (is_array($aCookies) && array_key_exists($sCookieID, $aCookies) && $aCookies[$sCookieID] == "1");
         }
 
         // Aggrosoft Cookie Consent
-        if ($this->getCookieManagerType() == "agcookiecompliance") {
+        if ($this->sCookieManagerType === ManagerTypes::AGCOOKIECOMPLIANCE) {
             if (method_exists($this, "isCookieCategoryEnabled")) {
                 return $this->isCookieCategoryEnabled($sCookieID);
             }
         }
 
-        // UserCentrics
-        if ($this->getCookieManagerType() === "oxps_usercentrics" or $this->getCookieManagerType() === 'consentmanager') {
+        // UserCentrics or consentmanager
+        if (
+            $this->sCookieManagerType       === ManagerTypes::USERCENTRICS_MODULE
+            or $this->sCookieManagerType    === ManagerTypes::USERCENTRICS_MANUALLY
+            or $this->sCookieManagerType    === ManagerTypes::CONSENTMANAGER
+            or $this->sCookieManagerType    === ManagerTypes::EXTERNAL_SERVICE
+        )
+        {
             // Always needs the script-tags delivered to the DOM.
             return true;
         }
@@ -110,21 +113,27 @@ class ViewConfig extends ViewConfig_parent
      * This is especially important for UserCentrics.
      * @return string
      */
-    public function getGtmScriptAttributes()
+    public function getGtmScriptAttributes() :string
     {
         $oConfig = Registry::getConfig();
-
-        if ($this->getCookieManagerType() == "oxps_usercentrics") {
         $sCookieId = $oConfig->getConfigParam('d3_gtm_settings_cookieName');
 
+        if (false === $this->shallUseOwnCookieManager()){
+            return "";
+        }
+
+        if (
+            $this->sCookieManagerType === ManagerTypes::USERCENTRICS_MODULE
+            or $this->sCookieManagerType === ManagerTypes::USERCENTRICS_MANUALLY
+        )
+        {
             if ($sCookieId) {
-                return 'type="text/plain" data-usercentrics="' . $sCookieId . '"';
+                return 'data-usercentrics="' . $sCookieId . '" type="text/plain" async=""';
             }
         }
 
-        if ($this->getCookieManagerType() == "consentmanager") {
-            $sCookieId = $oConfig->getConfigParam('d3_gtm_settings_cookieName');
-
+        if ($this->sCookieManagerType === ManagerTypes::CONSENTMANAGER)
+        {
             if ($sCookieId) {
                 return 'async 
                         type="text/plain"
@@ -144,7 +153,10 @@ class ViewConfig extends ViewConfig_parent
     {
         if ($this->blGA4enabled === null)
         {
-            $this->sContainerId = $this->getConfig()->getConfigParam('d3_gtm_blEnableGA4');
+            $this->sContainerId = ContainerFactory::getInstance()
+                                                  ->getContainer()
+                                                  ->get(ModuleSettingBridgeInterface::class)
+                                                  ->get('d3_gtm_blEnableGA4', 'd3googleanalytics4');
         }
 
         return $this->blGA4enabled;

README.md

@@ -23,13 +23,17 @@ Dieses Paket erfordert einen mit Composer installierten OXID eShop in einer in d
 Öffnen Sie eine Kommandozeile und navigieren Sie zum Stammverzeichnis des Shops (Elternverzeichnis von source und vendor). Führen Sie den folgenden Befehl aus. Passen Sie die Pfadangaben an Ihre Installationsumgebung an.
 
 ```bash
-php composer require d3/google-analytics4:^1
+php composer require d3/google-analytics4:^2
 ```
 
 Sofern nötig, bestätigen Sie bitte, dass Sie `package-name` erlauben, Code auszuführen.
 
 Aktivieren Sie das Modul im Shopadmin unter "Erweiterungen -> Module".
 
+### Wichtig!
+Bitte stellen Sie sicher, dass die nötigen Template-Blöcke im OXID-Shop zur Verfügung stehen. 
+Lesen Sie mehr in der [technischen Doku](./Docs/README.md) unter "Blöcke"!
+
 ## Verwendung
 ### Grundfunktionalität
 Nach erfolgreicher Installation finden Sie in Ihrem Shop-Admin unter "Erweiterungen > Module" 

composer.json

@@ -45,7 +45,7 @@
   },
   "require": {
     "php": ">=7.1",
-    "oxid-esales/oxideshop-ce": "v6.0 - 6.3",
+    "oxid-esales/oxideshop-ce": "^6.5",
     "google/apiclient":" ^2.0"
   },
   "autoload": {

metadata.php

@@ -17,7 +17,7 @@ $aModule          = [
                       Die Entwicklung basiert auf einem Fork von Marat Bedoev - <a href='https://github.com/vanilla-thunder/oxid-module-gtm'>Github-Link</a>
                       ",
     'thumbnail'   => 'thumbnail.png',
-    'version'     => '1.5.0',
+    'version'     => '2.7.0',
     'author'      => 'Data Development (Inh.: Thomas Dartsch)',
     'email'       => 'support@shopmodule.com',
     'url'         => 'https://www.oxidmodule.com/',
@@ -35,7 +35,8 @@ $aModule          = [
         [
             'template' => 'layout/base.tpl',
             'block'    => 'head_meta_robots',
-            'file'     => '/Application/views/blocks/_gtm_js.tpl'
+            'file'     => '/Application/views/blocks/_gtm_js.tpl',
+            'position' => 150
         ],
         // tag manager nojs
         [
@@ -64,8 +65,8 @@ $aModule          = [
         // Lists
         // view_item_list
         [
-            'template' => 'widget/product/list.tpl',
-            'block'    => 'widget_product_list',
+            'template' => 'page/list/list.tpl',
+            'block'    => 'page_list_productlist',
             'file'     => '/Application/views/ga4/view_item_list.tpl',
             'position' => 150
         ],
@@ -122,10 +123,10 @@ $aModule          = [
         ],
         [
             'group' => 'd3_gtm_settings_cookiemanager',
-            'name' => 'd3_gtm_settings_HAS_CONSENTMANAGER',
+            'name' => 'd3_gtm_settings_HAS_STD_MANAGER',
             'type' => 'select',
             'value' => 'none',
-            'constraints' => 'NO|YES',
+            'constraints' => 'NONE|CONSENTMANAGER|USERCENTRICS',
         ],
     ]
 ];