bump version && changelog to 1.8.0

bug would adjust the script even if the check for an own cookieManager is not set

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_STD_MANAGER'                   => 'Nutzen Sie eine der folgenden Einbindungen?<br>
-    'SHOP_MODULE_d3_gtm_settings_HAS_CONSENTMANAGER_NO'   => 'Nein',
+                                                                        Dann wählen Sie bitte die zutreffende aus.',
-    'SHOP_MODULE_d3_gtm_settings_HAS_CONSENTMANAGER_YES'  => 'Ja',
+    '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/view_item_list.tpl

@@ -1,36 +1,36 @@
-[{$smarty.block.parent}]
+[{$smarty.block.parent}]
-[{assign var="gtmProducts" value=$products}]
+[{assign var="gtmProducts" value=$oView->getArticleList()}]
-
+
-[{assign var="breadCrumb" value=''}]
+[{assign var="breadCrumb" value=''}]
-
+
-[{if $gtmProducts|@count}]
+[{if $gtmProducts|@count}]
-[{strip}]
+[{strip}]
-    <script>
+    <script>
-        /* ga4 */
+        /* ga4 */
-        dataLayer.push({ecommerce: null});
+        dataLayer.push({ecommerce: null});
-        dataLayer.push({
+        dataLayer.push({
-            'event':'view_item_list',
+            'event':'view_item_list',
-            'event_name': 'view_item_list',
+            'event_name': 'view_item_list',
-            'ecommerce': {
+            'ecommerce': {
-              'item_list_id': '[{$oView->getCategoryId()}]',
+              'item_list_id': '[{$oView->getCategoryId()}]',
-              'item_list_name': '[{foreach from=$oView->getBreadCrumb() item=sCrum}][{if $sCrum.title }][{$breadCrumb|cat:$sCrum.title|cat:" > "}][{/if}][{/foreach}]',
+              'item_list_name': '[{foreach from=$oView->getBreadCrumb() item=sCrum}][{if $sCrum.title }][{$breadCrumb|cat:$sCrum.title|cat:" > "}][{/if}][{/foreach}]',
-                'items': [
+                'items': [
-                    [{foreach from=$gtmProducts name="gtmProducts" item="gtmProduct"}]
+                    [{foreach from=$gtmProducts name="gtmProducts" item="gtmProduct"}]
-                    [{assign var="d3PriceObject" value=$gtmProduct->getPrice()}]
+                    [{assign var="d3PriceObject" value=$gtmProduct->getPrice()}]
-                    [{assign var="gtmManufacturer" value=$gtmProduct->getManufacturer()}]
+                    [{assign var="gtmManufacturer" value=$gtmProduct->getManufacturer()}]
-                    [{if !$gtmCategory}][{assign var="gtmCategory" value=$gtmProduct->getCategory()}][{/if}]
+                    [{if !$gtmCategory}][{assign var="gtmCategory" value=$gtmProduct->getCategory()}][{/if}]
-                    {
+                    {
-                        'item_id': '[{$gtmProduct->getFieldData("oxartnum")}]',
+                        'item_id': '[{$gtmProduct->getFieldData("oxartnum")}]',
-                        'item_name': '[{$gtmProduct->getFieldData("oxtitle")}]',
+                        'item_name': '[{$gtmProduct->getFieldData("oxtitle")}]',
-                        'price': [{$d3PriceObject->getPrice()}],
+                        'price': [{$d3PriceObject->getPrice()}],
-                        'item_brand': '[{if $gtmManufacturer}][{$gtmManufacturer->oxmanufacturers__oxtitle->value}][{/if}]',
+                        'item_brand': '[{if $gtmManufacturer}][{$gtmManufacturer->oxmanufacturers__oxtitle->value}][{/if}]',
-                        'item_category': '[{if $gtmCategory}][{$gtmCategory->getLink()|parse_url:5|ltrim:"/"|rtrim:"/"}][{else}]-[{/if}]',
+                        'item_category': '[{if $gtmCategory}][{$gtmCategory->getLink()|parse_url:5|ltrim:"/"|rtrim:"/"}][{else}]-[{/if}]',
-                        'quantity': 1
+                        'quantity': 1
-                    }[{if !$smarty.foreach.gtmProducts.last}],[{/if}]
+                    }[{if !$smarty.foreach.gtmProducts.last}],[{/if}]
-                    [{/foreach}]
+                    [{/foreach}]
-                ]
+                ]
-            }
+            }
-        });
+        });
-    </script>
+    </script>
-[{/strip}]
+[{/strip}]
 [{/if}]

CHANGELOG.md

@@ -4,7 +4,26 @@ 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.5.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.4.0...2.5.0) - 2023-05-23
+## [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
 ### Fixed
@@ -13,47 +32,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### 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.4.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.3.1...1.4.0) - 2023-05-02
 ### Added
 - "OXID Cookie Management powered by usercentrics" compatibility

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)
+    - Blockname: page_list_productlist
-    - Datei: widget/product/list.tpl
+    - Datei: page/list/list.tpl
     - GA4 Event: view_item_list
 - Detailseite
     - Blockname: details_productmain_title
@@ -63,6 +63,6 @@ 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
+  - In der Usercentrics-Verwaltung die Services "Google Analytics" und "Google Tag Manager" anlegen
-  - Den Service-Namen in den Moduleinstellungen des 'Google Analytics 4' unter
+  - Den Service ```Google Tag Manager``` in den Moduleinstellungen des 'Google Analytics 4' unter
     ```Einstell. > Cookie Manager Einstellungen > Cookie-ID``` eintragen

Modules/Core/ViewConfig.php

@@ -15,8 +15,6 @@ namespace D3\GoogleAnalytics4\Modules\Core;
 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
 {
@@ -29,17 +27,26 @@ class ViewConfig extends ViewConfig_parent
     {
         if ($this->sContainerId === null)
         {
-            $this->sContainerId = ContainerFactory::getInstance()
+            $this->sContainerId = $this->getConfig()->getConfigParam('d3_gtm_sContainerID');
-                                                  ->getContainer()
-                                                  ->get(ModuleSettingBridgeInterface::class)
-                                                  ->get('d3_gtm_sContainerID', 'd3googleanalytics4');
         }
         return $this->sContainerId;
     }
 
-    public function getModuleConsentmanagerSettingSelectValue() :bool
+    /**
+     * @return mixed
+     */
+    public function getModuleSettingExplicitManagerSelectValue()
     {
-        return Registry::getConfig()->getConfigParam('d3_gtm_settings_HAS_CONSENTMANAGER') === 'YES';
+        return Registry::getConfig()->getConfigParam('d3_gtm_settings_HAS_STD_MANAGER');
+    }
+
+    /**
+     * @return false|mixed
+     */
+    public function getExplicitManager()
+    {
+        $sManagerName = $this->getModuleSettingExplicitManagerSelectValue();
+        return $sManagerName === "NONE" ? false : $sManagerName;
     }
 
     public function getCookieManagerType()
@@ -62,13 +69,21 @@ class ViewConfig extends ViewConfig_parent
             }
         }
 
-        if ($this->sCookieManagerType === false and $this->getModuleConsentmanagerSettingSelectValue()){
+        if ($this->sCookieManagerType === false and $this->getExplicitManager()){
-            return "consentmanager";
+            return "externalService";
         }
 
         return $this->sCookieManagerType;
     }
 
+    /**
+     * @return bool
+     */
+    public function shallUseOwnCookieManager()
+    {
+        return (bool) Registry::getConfig()->getConfigParam('d3_gtm_settings_hasOwnCookieManager');
+    }
+
     /**
      * @return bool
      */
@@ -78,7 +93,7 @@ class ViewConfig extends ViewConfig_parent
         $oConfig = Registry::getConfig();
 
         // No Cookie Manager in use
-        if (!$oConfig->getConfigParam('d3_gtm_settings_hasOwnCookieManager')) {
+        if (false === $this->shallUseOwnCookieManager()) {
             return true;
         }
 
@@ -99,13 +114,12 @@ class ViewConfig extends ViewConfig_parent
             }
         }
 
-        // UserCentrics
+        // UserCentrics or consentmanager
-        if ($this->getCookieManagerType() === "oxps_usercentrics" or $this->getCookieManagerType() === 'consentmanager') {
+        if ($this->getCookieManagerType() === "oxps_usercentrics" or $this->getCookieManagerType() === 'externalService') {
             // Always needs the script-tags delivered to the DOM.
             return true;
         }
 
-        // Cookie Manager not (yet) supported
         return false;
     }
 
@@ -118,15 +132,19 @@ class ViewConfig extends ViewConfig_parent
     {
         $oConfig = Registry::getConfig();
 
-        if ($this->getCookieManagerType() == "oxps_usercentrics") {
+        if (false === $this->shallUseOwnCookieManager()){
+            return "";
+        }
+
+        if ($this->getCookieManagerType() === "oxps_usercentrics" or $this->getExplicitManager() === 'USERCENTRICS') {
             $sCookieId = $oConfig->getConfigParam('d3_gtm_settings_cookieName');
 
             if ($sCookieId) {
-                return 'type="text/plain" data-usercentrics="' . $sCookieId . '"';
+                return 'data-usercentrics="' . $sCookieId . '" type="text/plain" async=""';
             }
         }
 
-        if ($this->getCookieManagerType() == "consentmanager") {
+        if ($this->getCookieManagerType() === "externalService" and $this->getExplicitManager() === 'CONSENTMANAGER') {
             $sCookieId = $oConfig->getConfigParam('d3_gtm_settings_cookieName');
 
             if ($sCookieId) {
@@ -148,10 +166,7 @@ class ViewConfig extends ViewConfig_parent
     {
         if ($this->blGA4enabled === null)
         {
-            $this->sContainerId = ContainerFactory::getInstance()
+            $this->sContainerId = $this->getConfig()->getConfigParam('d3_gtm_blEnableGA4');
-                                                  ->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:^2
+php composer require d3/google-analytics4:^1
 ```
 
 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 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": "^6.5",
+    "oxid-esales/oxideshop-ce": "v6.0 - 6.3",
     "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'     => '2.5.0',
+    'version'     => '1.8.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',
+            'template' => 'page/list/list.tpl',
-            'block'    => 'widget_product_list',
+            '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',
         ],
     ]
 ];