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

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

Application/views/blocks/_gtm_nojs.tpl

@@ -1,8 +1,12 @@
-[{if $oViewConf->getGtmContainerId()}][{strip}]
+[{if $oViewConf->D3blShowGtmScript()}]
+    [{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/checkout_s1.tpl

@@ -2,10 +2,10 @@
 
 [{*$oxcmp_basket|get_class_methods|dumpvar*}]
 
+[{assign var="d3BasketPrice" value=$oxcmp_basket->getPrice()}]
+
 [{assign var='gtmCartArticles' value=$oView->getBasketArticles()}]
 [{strip}][{capture assign=d3_ga4_view_cart}]
-    let iPrice = "[{oxprice price=$oxcmp_basket->getPrice()}]";
-
     dataLayer.push({"event": null, "eventLabel": null, "ecommerce": null});  /* Clear the previous ecommerce object. */
     dataLayer.push({
         'event': 'view_cart',
@@ -13,15 +13,15 @@
         'ecommerce': {
             'actionField': "step: 1",
             'currency': "[{$currency->name}]",
-            'value': iPrice.replace("€", ""),
+            'value': [{$d3BasketPrice->getPrice()}],
             'items': [
                 [{foreach from=$oxcmp_basket->getContents() item=basketitem name=gtmCartContents  key=basketindex}]
-                [{assign var='_price' value=$basketitem->getUnitPrice()}]
+                [{assign var="d3oItemPrice" value=$basketitem->getPrice()}]
                 {
-                    'item_id': '[{$gtmCartArticles[$basketindex]->oxarticles__oxartnum->value}]',
+                    'item_id': '[{$gtmCartArticles[$basketindex]->getFieldData('oxartnum')}]',
-                    'item_name': '[{$gtmCartArticles[$basketindex]->oxarticles__oxtitle->value}]',
+                    'item_name': '[{$gtmCartArticles[$basketindex]->getFieldData('oxtitle')}]',
-                    'item_variant': '[{$gtmCartArticles[$basketindex]->oxarticles__oxvarselect->value}]',
+                    'item_variant': '[{$gtmCartArticles[$basketindex]->getFieldData('oxvarselect')}]',
-                    'price': [{$_price->getPrice()}],
+                    'price': [{$d3oItemPrice->getPrice()}],
                     'quantity':[{$basketitem->getAmount()}],
                     'position':[{$smarty.foreach.gtmCartContents.index}]
                 }[{if !$smarty.foreach.gtmCartContents.last}],[{/if}]

Application/views/blocks/checkout_s5.tpl

@@ -10,21 +10,22 @@
         'event': 'purchase',
         'eventLabel':'Checkout Step 5',
         'ecommerce': {
-          'transaction_id': '[{$_gtmOrder->oxorder__oxordernr->value}]',
+          'transaction_id': '[{$_gtmOrder->getFieldData("oxordernr")}]',
-          'affiliation':    '[{$oxcmp_shop->oxshops__oxname->value}]',
+          'affiliation':    '[{$oxcmp_shop->getFieldData("oxname")}]',
-          'value':          '[{$_gtmOrder->oxorder__oxtotalordersum->value}]',
+          'value':          [{$_gtmOrder->getTotalOrderSum()}],
-          'tax':            '[{math equation="x+y" x=$_gtmOrder->oxorder__oxartvatprice1->value y=$_gtmOrder->oxorder__oxartvatprice2->value }]',
+          'tax':            [{math equation="x+y" x=$_gtmOrder->getFieldData("oxartvatprice1") y=$_gtmOrder->getFieldData("oxartvatprice2") }],
-          'shipping':       '[{$_gtmOrder->oxorder__oxdelcost->value}]',
+          'shipping':       [{$_gtmOrder->getFieldData("oxdelcost")}],
           'currency':       '[{$_gtmOrder->getFieldData('oxcurrency')}]',
           'items':
               [
-                [{foreach from=$_gtmArticles item="_gtmArticle" name="gtmArticles"}]
+                [{foreach from=$_gtmArticles item="d3BasketArticle" name="gtmArticles"}]
+                  [{assign var="d3oArticlePrice" value=$d3BasketArticle->getPrice()}]
                 {
-                    'id':       '[{$_gtmArticle->oxorderarticles__oxartnum->value}]',
+                    'id':       '[{$d3BasketArticle->getFieldData("oxartnum")}]',
-                    'name':     '[{$_gtmArticle->oxorderarticles__oxtitle->value}]',
+                    'name':     '[{$d3BasketArticle->getFieldData("oxtitle")}]',
-                    'variant':  '[{$_gtmArticle->oxorderarticles__oxselvariant->value}]',
+                    'variant':  '[{$d3BasketArticle->getFieldData("oxselvariant")}]',
-                    'price':    [{$_gtmArticle->oxorderarticles__oxprice->value}],
+                    'price':    [{$d3oArticlePrice->getPrice()}],
-                    'quantity': [{$_gtmArticle->oxorderarticles__oxamount->value}],
+                    'quantity': [{$d3BasketArticle->getFieldData("oxamount")}],
                     'position': [{$smarty.foreach.gtmArticles.iteration}]
                 }[{if !$smarty.foreach.gtmArticles.last}],[{/if}]
                 [{/foreach}]

Application/views/blocks/detail.tpl

@@ -1,25 +0,0 @@
-[{$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/view_item.tpl

@@ -0,0 +1,26 @@
+[{$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->getFieldData("oxtitle")}]',
+          'item_id': '[{$gtmProduct->getFieldData("oxartnum")}]',
+          '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->getFieldData("oxvarselect")}][{$gtmProduct->getFieldData("oxvarselect")}][{/if}]',
+          [{assign var="d3PriceObject" value=$gtmProduct->getPrice()}]
+          'price': [{$d3PriceObject->getPrice()}]
+        }
+      ]
+    }
+  });
+</script>

Application/views/blocks/widget_product_list.tpl

@@ -1,35 +0,0 @@
-[{$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')}]
--->

Application/views/ga4/add_to_cart.tpl

@@ -1,59 +1,47 @@
 [{$smarty.block.parent}]
 
-[{*$gtmProduct|get_class_methods|dumpvar*}]
+[{* 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) {
-    [{*event.preventDefault();*}]
+  dataLayer.push({"event": null, "eventLabel": null, "ecommerce": null});  /* Clear the previous ecommerce object. */
 
-    let iArtQuantity = $("#amountToBasket").val();
+  let itemCategories = '[{if $gtmCategory}][{$gtmCategory->getLink()|parse_url:5|ltrim:"/"|rtrim:"/"}][{else}]no category[{/if}]'.split('/');
 
-    dataLayer.push({
+  [{*** Debug cases ***}]
-        'isAddToBasket': true,
+  [{*event.preventDefault();*}]
-      'event':'add_to_cart',
+
-      'eventLabel': 'add_to_cart',
+  let iArtQuantity = $("#amountToBasket").val();
-      'ecommerce': {
+
-        'currency':   "[{$currency->name}]",
+  dataLayer.push({
-        'value':      iArtQuantity*[{$gtmProduct->getFieldData('oxprice')}],
+    'isAddToBasket': true,
-        'items':      [
+    'event':'add_to_cart',
-          {
+    'eventLabel': 'add_to_cart',
-            'item_id':        '[{$gtmProduct->getFieldData('oxartnum')}]',
+    'ecommerce': {
-            'item_name':      '[{$gtmProduct->getFieldData('oxtitle')}]',
+      'currency':   "[{$currency->name}]",
-            'price':          '[{$gtmProduct->getFieldData('oxprice')}]',
+      'value':      iArtQuantity*[{$d3PriceObject->getPrice()}],
-            'item_brand':     '[{if $gtmManufacturer}][{$gtmManufacturer->oxmanufacturers__oxtitle->value}][{/if}]',
+      'items':      [
-            'item_variant':   '[{if $gtmProduct->getFieldData('oxvarselect')}][{$gtmProduct->getFieldData('oxvarselect')}][{/if}]',
+        {
-            'item_category':  itemCategories[0] || 'no category',
+        'item_id':        '[{$gtmProduct->getFieldData('oxartnum')}]',
-            'item_category_2':itemCategories[1] || '',
+        'item_name':      '[{$gtmProduct->getFieldData('oxtitle')}]',
-            'item_category_3':itemCategories[2] || '',
+        'price':          [{$d3PriceObject->getPrice()}],
-            'item_category_4':itemCategories[3] || '',
+        'item_brand':     '[{if $gtmManufacturer}][{$gtmManufacturer->oxmanufacturers__oxtitle->value}][{/if}]',
-            [{if false}]
+        'item_variant':   '[{if $gtmProduct->getFieldData('oxvarselect')}][{$gtmProduct->getFieldData('oxvarselect')}][{/if}]',
-            [{* ??? what *}]
+        'item_category':  itemCategories[0] || 'no category',
-            'item_list_name': 'Search Results',  // If associated with a list selection.
+        'item_category_2':itemCategories[1] || '',
-            'item_list_id': 'SR123',  // If associated with a list selection.
+        'item_category_3':itemCategories[2] || '',
-            'index': 1,  // If associated with a list selection.
+        'item_category_4':itemCategories[3] || '',
-            [{/if}]
+        'quantity': iArtQuantity
-            'quantity': iArtQuantity
+        }
-          }
+      ]
-        ]
       }
     });
   });
-[{/block}]
+  [{/block}]
-[{/capture}]
+  [{/capture}]
-[{oxscript add=$d3_ga4_add_to_cart}]
+[{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/search.tpl

@@ -13,12 +13,13 @@
           'search_term': '[{$searchparamforhtml}]',
           'items': [
             [{foreach from=$gtmProducts name="gtmProducts" item="gtmProduct"}]
+            [{assign var="d3PriceObject" value=$gtmProduct->getPrice()}]
             [{assign var="gtmManufacturer" value=$gtmProduct->getManufacturer()}]
             [{if !$gtmCategory}][{assign var="gtmCategory" value=$gtmProduct->getCategory()}][{/if}]
             {
               'item_id': '[{$gtmProduct->getFieldData("oxartnum")}]',
               'item_name': '[{$gtmProduct->getFieldData("oxtitle")}]',
-              'price': [{$gtmProduct->oxarticles__oxprice->value|default:'0'}],
+              'price': [{$d3PriceObject->getPrice()}],
               'item_brand': '[{if $gtmManufacturer}][{$gtmManufacturer->oxmanufacturers__oxtitle->value}][{/if}]',
               'item_category': '[{if $gtmCategory}][{$gtmCategory->getLink()|parse_url:5|ltrim:"/"|rtrim:"/"}][{else}]-[{/if}]',
               'quantity': 1

Application/views/ga4/view_item_list.tpl

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

CHANGELOG.md

@@ -4,6 +4,110 @@ 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
+### Fixed
+- unnecessary converting of int to str
+- missing PriceObject-bug
+### Changed
+- genuine code cleanup
+
+## [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
+- usercentrics defined script attributes
+- cookie-manager evaluation
+### Changed
+- genuine clean up of base-js-files
+
 ## [1.3.1](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.2.1...1.3.1) - 2023-03-17
 ### Added
 - Aggrosoft-Cookie-Consent 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 (muss hinzugefügt werden)
-    - Datei: widget/product/list.tpl
+    - Datei: page/list/list.tpl
     - GA4 Event: view_item_list
 - Detailseite
     - Blockname: details_productmain_title
@@ -54,12 +54,23 @@ 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
   - CookieID des angelegten Cookies in den Moduleinstellungen des 'Google Analytics 4' unter
     ```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 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

@@ -1,65 +1,162 @@
 <?php
 /**
- * This Software is the property of Data Development and is protected
+ * For the full copyright and license information, please view the LICENSE
- * by copyright law - it is NOT Freeware.
+ * file that was distributed with this source code.
- * Any unauthorized use of this software without a valid license
+ *
- * is a violation of the license agreement and will be prosecuted by
+ * https://www.d3data.de
- * civil and criminal law.
+ *
- * http://www.shopmodule.com
  * @copyright (C) D3 Data Development (Inh. Thomas Dartsch)
- * @author        D3 Data Development - Daniel Seifert <support@shopmodule.com>
+ * @author    D3 Data Development - Daniel Seifert <info@shopmodule.com>
- * @link          http://www.oxidmodule.com
+ * @link      https://www.oxidmodule.com
  */
 
 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
 {
 
     // Google Tag Manager Container ID
     private $sContainerId = null;
+    private $sCookieManagerType = null;
 
     public function getGtmContainerId()
     {
         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;
     }
 
     /**
-     * @param $sCookieID
+     * @return void
+     */
+    public function defineCookieManagerType() :void
+    {
+        if ($this->sCookieManagerType === null)
+        {
+            /** @var ManagerHandler $oManagerHandler */
+            $oManagerHandler = oxNew(ManagerHandler::class);
+            $this->sCookieManagerType = $oManagerHandler->getCurrManager();
+        }
+    }
+
+    /**
      * @return bool
      */
-    public function D3blAcceptedCookie($sCookieID)
+    public function shallUseOwnCookieManager() :bool
     {
-        $oSession = Registry::getSession();
+        return (bool) Registry::getConfig()->getConfigParam('d3_gtm_settings_hasOwnCookieManager');
-        $aCookies = $oSession->getVariable("aCookieSel");
+    }
 
-        if (!is_null($aCookies) && is_array($aCookies) && array_key_exists($sCookieID, $aCookies) && $aCookies[$sCookieID] == "1") {
+    /**
+     * @return bool
+     */
+    public function D3blShowGtmScript()
+    {
+        /** @var Config $oConfig */
+        $oConfig = Registry::getConfig();
+
+        // No Cookie Manager in use
+        if (!$this->shallUseOwnCookieManager()) {
             return true;
         }
 
-        // Aggrosoft Cookie Consent
+        $this->defineCookieManagerType();
-        if (method_exists($this, "isCookieCategoryEnabled")) {
+
-            return $this->isCookieCategoryEnabled($sCookieID);
+        $sCookieID = $oConfig->getConfigParam('d3_gtm_settings_cookieName');
+
+        // Netensio Cookie Manager
+        if ($this->sCookieManagerType === ManagerTypes::NET_COOKIE_MANAGER) {
+            $oSession = Registry::getSession();
+            $aCookies = $oSession->getVariable("aCookieSel");
+
+            return (is_array($aCookies) && array_key_exists($sCookieID, $aCookies) && $aCookies[$sCookieID] == "1");
         }
 
+        // Aggrosoft Cookie Consent
+        if ($this->sCookieManagerType === ManagerTypes::AGCOOKIECOMPLIANCE) {
+            if (method_exists($this, "isCookieCategoryEnabled")) {
+                return $this->isCookieCategoryEnabled($sCookieID);
+            }
+        }
+
+        // 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;
+        }
+
+        // Cookie Manager not (yet) supported
         return false;
     }
 
+    /**
+     * Get additional attributes for script tags.
+     * This is especially important for UserCentrics.
+     * @return string
+     */
+    public function getGtmScriptAttributes() :string
+    {
+        $oConfig = Registry::getConfig();
+        $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 'data-usercentrics="' . $sCookieId . '" type="text/plain" async=""';
+            }
+        }
+
+        if ($this->sCookieManagerType === ManagerTypes::CONSENTMANAGER)
+        {
+            if ($sCookieId) {
+                return 'async 
+                        type="text/plain"
+                        data-cmp-src="https://www.googletagmanager.com/gtm.js?id='.$this->getGtmContainerId().'"
+                        class="cmplazyload"
+                        data-cmp-vendor="s905"
+                        ';
+            }
+        }
+
+        return "";
+    }
+
     private $blGA4enabled = null;
 
     public function isGA4enabled()
     {
         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;
@@ -72,7 +169,6 @@ class ViewConfig extends ViewConfig_parent
         $oConfig = Registry::getConfig();
         $oView   = $oConfig->getTopActiveView();
         /** @var FrontendController $oShop */
-
         $oUser = $oConfig->getUser();
 
         $cl         = $this->getTopActiveClassName();

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.3.1',
+    '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
         [
@@ -43,17 +44,11 @@ $aModule          = [
             'block'    => 'theme_svg_icons',
             'file'     => '/Application/views/blocks/_gtm_nojs.tpl'
         ],
-        // widget_product_list
-        [
-            'template' => 'widget/product/list.tpl',
-            'block'    => 'widget_product_list',
-            'file'     => '/Application/views/blocks/widget_product_list.tpl'
-        ],
         // details
         [
             'template' => 'page/details/inc/productmain.tpl',
             'block'    => 'details_productmain_title',
-            'file'     => '/Application/views/blocks/detail.tpl',
+            'file'     => '/Application/views/blocks/view_item.tpl',
             'position' => 150
         ],
         // checkout
@@ -70,8 +65,8 @@ $aModule          = [
         // Lists
         // view_item_list
         [
-            'template' => 'widget/product/list.tpl',
+            'template' => 'page/list/list.tpl',
-            'block'    => 'd3Ga4_view_item_list',
+            'block'    => 'page_list_productlist',
             'file'     => '/Application/views/ga4/view_item_list.tpl',
             'position' => 150
         ],
@@ -126,5 +121,12 @@ $aModule          = [
             'value'    => 'example',
             'position' => 999
         ],
+        [
+            'group' => 'd3_gtm_settings_cookiemanager',
+            'name' => 'd3_gtm_settings_HAS_STD_MANAGER',
+            'type' => 'select',
+            'value' => 'none',
+            'constraints' => 'NONE|CONSENTMANAGER|USERCENTRICS',
+        ],
     ]
 ];