bump version && changelog to 1.4.0

taken from pull-request; thank you C. Stäblein

Application/views/admin/de/module_options.php

@@ -1,13 +1,16 @@
 <?php
+
 /**
- * For the full copyright and license information, please view the LICENSE
+ * This Software is the property of Data Development and is protected
- * file that was distributed with this source code.
+ * by copyright law - it is NOT Freeware.
- *
+ * Any unauthorized use of this software without a valid license
- * https://www.d3data.de
+ * is a violation of the license agreement and will be prosecuted by
+ * civil and criminal law.
+ * http://www.shopmodule.com
  *
  * @copyright (C) D3 Data Development (Inh. Thomas Dartsch)
- * @author    D3 Data Development - Daniel Seifert <info@shopmodule.com>
+ * @author        D3 Data Development - Daniel Seifert <support@shopmodule.com>
- * @link      https://www.oxidmodule.com
+ * @link          http://www.oxidmodule.com
  */
 
 $style = '<style type="text/css">

Application/views/blocks/_gtm_js.tpl

@@ -1,40 +1,12 @@
-[{assign var="d3VtConfigObject" value=$oViewConf->getConfig()}]
+[{* Always prepare the data layer to avoid errors *}]
-[{if $d3VtConfigObject->getConfigParam('d3_gtm_settings_hasOwnCookieManager')}]
+<script>
-    [{if $oViewConf->D3blAcceptedCookie($d3VtConfigObject->getConfigParam('d3_gtm_settings_cookieName'))}]
+  var dataLayer = [{$oViewConf->getGtmDataLayer()}] || [];
+</script>
 
-        [{if $oViewConf->getGtmContainerId()}][{strip}]
+[{if $oViewConf->D3blShowGtmScript()}]
-        <!-- Google Tag Manager -->
-        <script>
-          var dataLayer = [{$oViewConf->getGtmDataLayer()}] || [];
-          (function (w, d, s, l, i) {
-            w[l] = w[l] || [];
-            w[l].push({'gtm.start': new Date().getTime(), event: 'gtm.js'});
-            var f = d.getElementsByTagName(s)[0], j = d.createElement(s), dl = l != 'dataLayer' ? '&l=' + l : '';
-            j.async = true;
-            j.src = 'https://www.googletagmanager.com/gtm.js?id=' + i + dl;
-            f.parentNode.insertBefore(j, f);
-          })(window, document, 'script', 'dataLayer', '[{$oViewConf->getGtmContainerId()}]');
-        </script>
-        <!-- End Google Tag Manager -->
-        [{if $oViewConf->getTopActionClassName() === "alist" }]
-        [{* include file="ga4_view_item_list.tpl" gtmCategory=$oView->getActiveCategory() gtmProducts=$oView->getArticleList() listtype=$oView->getListType() *}]
-        [{elseif $oViewConf->getTopActionClassName() === "details" }]
-        [{* include file="ga4_view_item.tpl" gtmProduct=$oView->getProduct() *}]
-        [{elseif $oViewConf->getTopActionClassName() === "search" }]
-        [{elseif $oViewConf->getTopActionClassName() === "basket" }]
-
-        [{/if}]
-        [{/strip}][{/if}]
-    [{else}]
-    <script>
-      var dataLayer = [{$oViewConf->getGtmDataLayer()}] || [];
-    </script>
-    [{/if}]
-[{else}]
     [{if $oViewConf->getGtmContainerId()}][{strip}]
     <!-- Google Tag Manager -->
-    <script>
+    <script [{$oViewConf->getGtmScriptAttributes()}]>
-      var dataLayer = [{$oViewConf->getGtmDataLayer()}] || [];
       (function (w, d, s, l, i) {
         w[l] = w[l] || [];
         w[l].push({'gtm.start': new Date().getTime(), event: 'gtm.js'});
@@ -45,15 +17,15 @@
       })(window, document, 'script', 'dataLayer', '[{$oViewConf->getGtmContainerId()}]');
     </script>
     <!-- End Google Tag Manager -->
+
     [{if $oViewConf->getTopActionClassName() === "alist" }]
     [{* include file="ga4_view_item_list.tpl" gtmCategory=$oView->getActiveCategory() gtmProducts=$oView->getArticleList() listtype=$oView->getListType() *}]
     [{elseif $oViewConf->getTopActionClassName() === "details" }]
     [{* include file="ga4_view_item.tpl" gtmProduct=$oView->getProduct() *}]
     [{elseif $oViewConf->getTopActionClassName() === "search" }]
     [{elseif $oViewConf->getTopActionClassName() === "basket" }]
-
     [{/if}]
     [{/strip}][{/if}]
-[{/if}]
+    [{/if}]
 
 [{$smarty.block.parent}]

Application/views/blocks/_gtm_nojs.tpl

@@ -1,8 +1,12 @@
-[{if $oViewConf->getGtmContainerId()}][{strip}]
+[{if $oViewConf->D3blShowGtmScript() && !$oViewConf->getCookieManagerType()}]
+    [{if $oViewConf->getGtmContainerId()}][{strip}]
     <!-- Google Tag Manager (noscript) -->
     <noscript>
         <iframe src="https://www.googletagmanager.com/ns.html?id=[{$oViewConf->getGtmContainerId()}]"
                 height="0" width="0" style="display:none;visibility:hidden"></iframe>
     </noscript>
-    <!-- End Google Tag Manager (noscript) -->[{/strip}][{/if}]
+<!-- End Google Tag Manager (noscript) -->
+    [{/strip}][{/if}]
+    [{/if}]
+
 [{$smarty.block.parent}]

Application/views/blocks/detail.tpl

@@ -0,0 +1,25 @@
+[{$smarty.block.parent}]
+[{assign var="gtmProduct" value=$oView->getProduct()}]
+[{assign var="gtmCategory" value=$gtmProduct->getCategory()}]
+[{assign var="gtmManufacturer" value=$gtmProduct->getManufacturer()}]
+
+<script>
+    dataLayer.push({"event": null, "eventLabel": null, "ecommerce": null});  /* Clear the previous ecommerce object. */
+    dataLayer.push({
+        'event': 'view_item',
+        'eventLabel':'Product View',
+        'ecommerce': {
+            'currency': '[{$currency->name}]',
+            'items': [
+                {
+                    'item_name': '[{$gtmProduct->oxarticles__oxtitle->value}]',
+                    'item_id': '[{$gtmProduct->oxarticles__oxartnum->value}]',
+                    'item_brand': '[{if $gtmManufacturer}][{$gtmManufacturer->oxmanufacturers__oxtitle->value}][{/if}]',
+                    'item_category': '[{if $gtmCategory}][{$gtmCategory->getLink()|parse_url:5|ltrim:"/"|rtrim:"/"}][{else}]-[{/if}]',
+                    'item_variant': '[{if $gtmProduct->oxarticles__oxvarselect->value}][{$gtmProduct->oxarticles__oxvarselect->value}][{/if}]',
+                    'price': [{$gtmProduct->oxarticles__oxprice->value}]
+                }
+            ]
+        }
+    });
+</script>

Application/views/blocks/widget_product_list.tpl

@@ -0,0 +1,35 @@
+[{$smarty.block.parent}]
+[{assign var="gtmProduct" value=$oView->getProduct()}]
+[{assign var="gtmCategory" value=$gtmProduct->getCategory()}]
+[{assign var="gtmManufacturer" value=$gtmProduct->getManufacturer()}]
+<script>
+    dataLayer.push({"event": null, "eventLabel": null, "ecommerce": null});  /* Clear the previous ecommerce object. */
+    dataLayer.push({
+        'event': 'ee.impression',
+        'eventLabel':'Impression',
+        'ecommerce': {
+            'currencyCode': '[{$currency->name}]',
+            'impressions': [
+                {
+                    'name': '[{$gtmProduct->oxarticles__oxtitle->value}]',
+                    'id': '[{$gtmProduct->oxarticles__oxartnum->value}]',
+                    'price': [{$gtmProduct->oxarticles__oxprice->value}],
+                    'brand': '[{if $gtmManufacturer}][{$gtmManufacturer->oxmanufacturers__oxtitle->value}][{/if}]',
+                    'category': '[{if $gtmCategory}][{$gtmCategory->getLink()|parse_url:5|ltrim:"/"|rtrim:"/"}][{else}]-[{/if}]',
+                    'variant': '[{if $gtmProduct->oxarticles__oxvarselect->value}][{$gtmProduct->oxarticles__oxvarselect->value}][{/if}]'
+                    [{if $list && $position}],
+                    'list': '[{$list}]',
+                    'position': [{"_"|str_replace:"":$position}]
+                    [{/if}]
+                }
+            ]
+        }
+    });
+</script>
+<!--
+sWidgetType [{$sWidgetType}] | [{$oView->getViewParameter('sWidgetType')}]
+sListType [{$sListType}] | [{$oView->getViewParameter('sListType')}]
+iIndex [{$iIndex}] | [{$oView->getIndex()}]
+listId [{$listId}] | [{$oView->getViewParameter('listId')}]
+testid [{$testid}] | [{$oView->getViewParameter('testid')}]
+-->

CHANGELOG.md

@@ -4,34 +4,13 @@ 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.3.2](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.2.2...2.3.2) - 2023-03-17
+## [1.4.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.3.1...1.4.0) - 2023-05-02
 ### Added
-- Aggrosoft-Cookie-Consent compatibility
+- "OXID Cookie Management powered by usercentrics" compatibility
-### Fixed
+- usercentrics defined script attributes
-- wrong function for pageview on thankyou page
+- cookie-manager evaluation
-### Deleted
+### Changed
-- unused files
+- genuine clean up of base-js-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.3.1](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.2.1...1.3.1) - 2023-03-17
 ### Added
@@ -41,7 +20,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [1.2.1](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.2...1.2.1) - 2023-02-22
 ### Fixed
-- price formatting view_cart
+- price formatting in view_cart
 
 ## [1.2](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.1...1.2) - 2023-02-01
 ### Added
@@ -55,7 +34,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - switched price formatting
 
-
+## [1.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.0...1.0) - 2023-01-20
-## [1.0](https://git.d3data.de/D3Public/GoogleAnalytics4/releases/tag/1.0) - 2023-01-20
 ### Added
 - publication of app features

Docs/README.md

@@ -54,7 +54,8 @@ Aktivieren Sie anschließend diese Weiche. Setzen Sie den Haken bei "Eigenen Coo
 - [aggrosoft - oxid-cookie-compliance](https://github.com/aggrosoft/oxid-cookie-compliance)
   - https://github.com/aggrosoft/oxid-cookie-compliance
   - die entsprechend gewählte Kategorie in den Moduleinstellungen des 'Google Analytics 4' unter
-  ```Einstell. > Cookie Manager Einstellungen > Cookie-ID``` eintragen
+    ```Einstell. > Cookie Manager Einstellungen > Cookie-ID``` eintragen
+  - Default-Werte sind entweder ```ANALYTICS``` oder ```MARKETING```. Bitte auf die Großschreibung achten.
 
 - [Netensio - Cookie Consent Manager](https://www.netensio.de/oxid-eshop-module/cookie-consent-manager-fuer-oxid-eshop.html)
   - Modul entsprechend konfigurieren
@@ -62,4 +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)
-  - soweit ich weiß nichts weiter?
+  - In der Usercentrics-Verwaltung einen Service für Google Analytics anlegen
+  - Den Service-Namen in den Moduleinstellungen des 'Google Analytics 4' unter
+    ```Einstell. > Cookie Manager Einstellungen > Cookie-ID``` eintragen

Modules/Core/ViewConfig.php

@@ -1,71 +1,125 @@
 <?php
 /**
- * For the full copyright and license information, please view the LICENSE
+ * This Software is the property of Data Development and is protected
- * file that was distributed with this source code.
+ * by copyright law - it is NOT Freeware.
- *
+ * Any unauthorized use of this software without a valid license
- * https://www.d3data.de
+ * is a violation of the license agreement and will be prosecuted by
- *
+ * civil and criminal law.
+ * http://www.shopmodule.com
  * @copyright (C) D3 Data Development (Inh. Thomas Dartsch)
- * @author    D3 Data Development - Daniel Seifert <info@shopmodule.com>
+ * @author        D3 Data Development - Daniel Seifert <support@shopmodule.com>
- * @link      https://www.oxidmodule.com
+ * @link          http://www.oxidmodule.com
  */
 
 namespace D3\GoogleAnalytics4\Modules\Core;
 
 use OxidEsales\Eshop\Application\Controller\FrontendController;
 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
 {
 
     // Google Tag Manager Container ID
     private $sContainerId = null;
+    private $sCookieManagerType = null;
 
     public function getGtmContainerId()
     {
         if ($this->sContainerId === null)
         {
-            $this->sContainerId = ContainerFactory::getInstance()
+
-                                                  ->getContainer()
+            $this->sContainerId = $this->getConfig()->getConfigParam('d3_gtm_sContainerID');
-                                                  ->get(ModuleSettingBridgeInterface::class)
-                                                  ->get('d3_gtm_sContainerID', 'd3googleanalytics4');
         }
         return $this->sContainerId;
     }
 
+    public function getCookieManagerType()
+    {
+        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;
+                }
+            }
+        }
+        return $this->sCookieManagerType;
+    }
+
     /**
-     * @param $sCookieID
      * @return bool
      */
-    public function D3blAcceptedCookie($sCookieID)
+    public function D3blShowGtmScript()
     {
-        $oSession = Registry::getSession();
+        $oConfig = $this->getConfig();
-        $aCookies = $oSession->getVariable("aCookieSel");
 
-        if (!is_null($aCookies) && is_array($aCookies) && array_key_exists($sCookieID, $aCookies) && $aCookies[$sCookieID] == "1") {
+        // No Cookie Manager in use
+        if (!$oConfig->getConfigParam('d3_gtm_settings_hasOwnCookieManager')) {
             return true;
         }
 
-        // Aggrosoft Cookie Consent
+        $sCookieID = $oConfig->getConfigParam('d3_gtm_settings_cookieName');
-        if (method_exists($this, "isCookieCategoryEnabled")) {
+
-            return $this->isCookieCategoryEnabled($sCookieID);
+        // Netensio Cookie Manager
+        if ($this->getCookieManagerType() == "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");
         }
 
+        // Aggrosoft Cookie Consent
+        if ($this->getCookieManagerType() == "agcookiecompliance") {
+            if (method_exists($this, "isCookieCategoryEnabled")) {
+                return $this->isCookieCategoryEnabled($sCookieID);
+            }
+        }
+
+        // UserCentrics
+        if ($this->getCookieManagerType() == "oxps_usercentrics") {
+            // Always needs the script-tags delivered to the DOM.
+            return true;
+        }
+
+        // Cookie Manager not (yet) supported
         return false;
     }
 
+    /**
+     * Get additional attributes for script tags.
+     * This is especially important for UserCentrics.
+     * @return string
+     */
+    public function getGtmScriptAttributes()
+    {
+        if ($this->getCookieManagerType() == "oxps_usercentrics") {
+            $oConfig = $this->getConfig();
+            $sCookieId = $oConfig->getConfigParam('d3_gtm_settings_cookieName');
+
+            if ($sCookieId) {
+                return 'type="text/plain" data-usercentrics="' . $sCookieId . '"';
+            }
+        }
+
+        return "";
+    }
+
     private $blGA4enabled = null;
 
     public function isGA4enabled()
     {
         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;
@@ -78,6 +132,7 @@ class ViewConfig extends ViewConfig_parent
         $oConfig = Registry::getConfig();
         $oView   = $oConfig->getTopActiveView();
         /** @var FrontendController $oShop */
+
         $oUser = $oConfig->getUser();
 
         $cl         = $this->getTopActiveClassName();

README.md

@@ -23,7 +23,7 @@ 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.

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.3.2',
+    'version'     => '1.4.0',
     'author'      => 'Data Development (Inh.: Thomas Dartsch)',
     'email'       => 'support@shopmodule.com',
     'url'         => 'https://www.oxidmodule.com/',
@@ -57,7 +57,6 @@ $aModule          = [
             'position' => 150
         ],
         // checkout
-        // view_cart
         [
             'template' => 'page/checkout/basket.tpl',
             'block'    => 'checkout_basket_main',