bump version && changelog to 1.10.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/ManagerTypes.php

@@ -34,6 +34,8 @@ class ManagerTypes
 
     const CONSENTMANAGER            = "CONSENTMANAGER";
 
+    const COOKIEFIRST               = "COOKIEFIRST";
+
     /**
      * @return array
      */
@@ -45,7 +47,8 @@ class ManagerTypes
             "net_cookie_manager"    => self::NET_COOKIE_MANAGER,
             "oxps_usercentrics"     => self::USERCENTRICS_MODULE,
             "usercentrics"          => self::USERCENTRICS_MANUALLY,
-            "consentmanager"        => self::CONSENTMANAGER
+            "consentmanager"        => self::CONSENTMANAGER,
+            "cookiefirst"        => self::COOKIEFIRST
         ];
     }
 

Application/views/admin/de/module_options.php

@@ -31,10 +31,17 @@ $aLang = [
     // for cookie manager settings
     'SHOP_MODULE_GROUP_d3_gtm_settings_cookiemanager'   => 'Cookie Manager Einstellungen',
     'SHOP_MODULE_d3_gtm_settings_hasOwnCookieManager'   => 'Cookie Manager nutzen?',
+    'HELP_SHOP_MODULE_d3_gtm_settings_HAS_STD_MANAGER'              => 'Mehr Informationen zu den genannten Coookie-Manager finden Sie auf den folgenden Home-Pages<br><br>
+                                                                        <a href="https://consentmanager.net/">Consentmanager</a><br>
+                                                                        <a href="https://usercentrics.com/">Usercentrics</a><br>
+                                                                        <a href="https://cookiefirst.com">Cookiefirst</a><br>
+                                                                        <hr>
+                                                                        Bei weiteren Fragen stehen wir gern zur Verfügung! Kontaktieren Sie uns einfach unter <a href="https://www.d3data.de/">https://www.d3data.de/</a>',
     '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_HAS_STD_MANAGER_COOKIEFIRST'       => 'cookiefirst',
     'SHOP_MODULE_d3_gtm_settings_cookieName'  => 'CookieID',
 ];

Application/views/blocks/_gtm_js.tpl

@@ -4,28 +4,22 @@
 </script>
 
 [{if $oViewConf->D3blShowGtmScript()}]
-    [{if $oViewConf->getGtmContainerId()}][{strip}]
-    <!-- Google Tag Manager -->
-    <script [{$oViewConf->getGtmScriptAttributes()}]>
-      (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}]
+    [{if $oViewConf->getGtmContainerId()}]
+        [{strip}]
+            <!-- Google Tag Manager -->
+            <script [{$oViewConf->getGtmScriptAttributes()}]>
+              (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 -->
+        [{/strip}]
     [{/if}]
+[{/if}]
 
 [{$smarty.block.parent}]

Application/views/blocks/checkout_s1.tpl

@@ -1,33 +0,0 @@
-[{$smarty.block.parent}]
-
-[{*$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}]
-    dataLayer.push({"event": null, "eventLabel": null, "ecommerce": null});  /* Clear the previous ecommerce object. */
-    dataLayer.push({
-        'event': 'view_cart',
-        'eventLabel':'Checkout Step 1',
-        'ecommerce': {
-            'actionField': "step: 1",
-            'currency': "[{$currency->name}]",
-            'value': [{$d3BasketPrice->getPrice()}],
-            'items': [
-                [{foreach from=$oxcmp_basket->getContents() item=basketitem name=gtmCartContents  key=basketindex}]
-                [{assign var="d3oItemPrice" value=$basketitem->getPrice()}]
-                {
-                    'item_id': '[{$gtmCartArticles[$basketindex]->getFieldData('oxartnum')}]',
-                    'item_name': '[{$gtmCartArticles[$basketindex]->getFieldData('oxtitle')}]',
-                    'item_variant': '[{$gtmCartArticles[$basketindex]->getFieldData('oxvarselect')}]',
-                    'price': [{$d3oItemPrice->getPrice()}],
-                    'quantity':[{$basketitem->getAmount()}],
-                    'position':[{$smarty.foreach.gtmCartContents.index}]
-                }[{if !$smarty.foreach.gtmCartContents.last}],[{/if}]
-                [{/foreach}]
-                ]
-        }
-    });
-[{/capture}][{/strip}]
-[{oxscript add=$d3_ga4_view_cart}]

Application/views/blocks/checkout_s5.tpl

@@ -1,36 +0,0 @@
-[{$smarty.block.parent}]
-
-[{strip}]
-<script>
-    dataLayer.push({"event": null, "eventLabel": null, "ecommerce": null});  /* Clear the previous ecommerce object. */
-    [{assign var="_gtmOrder" value=$oView->getOrder()}]
-    [{assign var="_gtmArticles" value=$_gtmOrder->getOrderArticles()}]
-    
-    dataLayer.push({
-        'event': 'purchase',
-        'eventLabel':'Checkout Step 5',
-        'ecommerce': {
-          'transaction_id': '[{$_gtmOrder->getFieldData("oxordernr")}]',
-          'affiliation':    '[{$oxcmp_shop->getFieldData("oxname")}]',
-          'value':          [{$_gtmOrder->getTotalOrderSum()}],
-          'tax':            [{math equation="x+y" x=$_gtmOrder->getFieldData("oxartvatprice1") y=$_gtmOrder->getFieldData("oxartvatprice2") }],
-          'shipping':       [{$_gtmOrder->getFieldData("oxdelcost")}],
-          'currency':       '[{$_gtmOrder->getFieldData('oxcurrency')}]',
-          'items':
-              [
-                [{foreach from=$_gtmArticles item="d3BasketArticle" name="gtmArticles"}]
-                  [{assign var="d3oArticlePrice" value=$d3BasketArticle->getPrice()}]
-                {
-                    'id':       '[{$d3BasketArticle->getFieldData("oxartnum")}]',
-                    'name':     '[{$d3BasketArticle->getFieldData("oxtitle")}]',
-                    'variant':  '[{$d3BasketArticle->getFieldData("oxselvariant")}]',
-                    'price':    [{$d3oArticlePrice->getPrice()}],
-                    'quantity': [{$d3BasketArticle->getFieldData("oxamount")}],
-                    'position': [{$smarty.foreach.gtmArticles.iteration}]
-                }[{if !$smarty.foreach.gtmArticles.last}],[{/if}]
-                [{/foreach}]
-              ]
-        }
-    })
-</script>
-[{/strip}]

Application/views/blocks/purchase.tpl

@@ -0,0 +1,49 @@
+[{$smarty.block.parent}]
+
+[{strip}]
+<script>
+    dataLayer.push({"event": null, "eventLabel": null, "ecommerce": null});  /* Clear the previous ecommerce object. */
+    [{assign var="gtmOrder"         value=$oView->getOrder()}]
+    [{assign var="gtmBasket"         value=$oView->getBasket()}]
+    [{assign var="gtmArticles"      value=$gtmOrder->getOrderArticles()}]
+    [{assign var="gtmOrderVouchers"  value=$gtmOrder->getVoucherNrList()}]
+
+    dataLayer.push({
+        'event': 'purchase',
+        'eventLabel':'Checkout Step 5',
+        'ecommerce': {
+            'transaction_id': '[{$gtmOrder->getFieldData("oxordernr")}]',
+            'affiliation':    '[{$oxcmp_shop->getFieldData("oxname")}]',
+            'value':          [{$gtmOrder->getTotalOrderSum()}],
+            'tax':            [{math equation="x+y" x=$gtmOrder->getFieldData("oxartvatprice1") y=$gtmOrder->getFieldData("oxartvatprice2") }],
+            'shipping':       [{$gtmOrder->getFieldData("oxdelcost")}],
+            'currency':       '[{$gtmOrder->getFieldData('oxcurrency')}]',
+            'coupon':         '[{foreach from=$gtmOrderVouchers item="gtmOrderVoucher" name="gtmOrderVoucherIteration"}][{$gtmOrderVoucher}][{if !$smarty.foreach.gtmOrderVoucherIteration.last}], [{/if}][{/foreach}]',
+            'paymentType':    '[{$gtmBasket->getPaymentOnPaymentId()}]',
+            'items': [
+                [{foreach from=$gtmArticles item="gtmBasketItem" name="gtmArticles"}]
+                    [{assign var="gtmPurchaseItemPriceObject"   value=$gtmBasketItem->getPrice()}]
+                    [{assign var="gtmPurchaseItem"              value=$gtmBasketItem->getArticle()}]
+                    [{assign var="gtmPurchaseItemCategory"      value=$gtmPurchaseItem->getCategory()}]
+
+                    {
+                        'item_id':          '[{$gtmBasketItem->getFieldData("oxartnum")}]',
+                        'item_name':        '[{$gtmBasketItem->getFieldData("oxtitle")}]',
+                        'affiliation':      '[{$gtmBasketItem->getFieldData("oxtitle")}]',
+                        'coupon':           '[{foreach from=$gtmOrderVouchers item="gtmOrderVoucher" name="gtmOrderVoucherIteration"}][{$gtmOrderVoucher}][{if !$smarty.foreach.gtmOrderVoucherIteration.last}], [{/if}][{/foreach}]',
+                        'item_variant':     '[{$gtmBasketItem->getFieldData("oxselvariant")}]',
+                        'item_category':    '[{$gtmPurchaseItemCategory->getSplitCategoryArray(0)}]',
+                        'item_category_2':  '[{$gtmPurchaseItemCategory->getSplitCategoryArray(1)}]',
+                        'item_category_3':  '[{$gtmPurchaseItemCategory->getSplitCategoryArray(2)}]',
+                        'item_category_4':  '[{$gtmPurchaseItemCategory->getSplitCategoryArray(3)}]',
+                        'item_list_name':   '[{$gtmPurchaseItemCategory->getSplitCategoryArray()}]',
+                        'price':            [{$gtmPurchaseItemPriceObject->getPrice()}],
+                        'quantity':         [{$gtmBasketItem->getFieldData("oxamount")}],
+                        'position':         [{$smarty.foreach.gtmArticles.iteration}]
+                    }[{if !$smarty.foreach.gtmArticles.last}],[{/if}]
+                [{/foreach}]
+            ]
+        }
+    })
+</script>
+[{/strip}]

Application/views/blocks/view_cart.tpl

@@ -0,0 +1,42 @@
+[{$smarty.block.parent}]
+
+[{*$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}]
+    dataLayer.push({"event": null, "eventLabel": null, "ecommerce": null});  /* Clear the previous ecommerce object. */
+    dataLayer.push({
+        'event': 'view_cart',
+        'eventLabel':'Checkout Step 1',
+        'ecommerce': {
+            'actionField': "step: 1",
+            'currency': "[{$currency->name}]",
+            'value': [{$d3BasketPrice->getPrice()}],
+            'coupon':         '[{foreach from=$oxcmp_basket->getVouchers() item=sVoucher key=key name=Voucher}][{$sVoucher->sVoucherNr}][{if !$smarty.foreach.Voucher.last}], [{/if}][{/foreach}]',
+            'items': [
+                [{foreach from=$oxcmp_basket->getContents() item=basketitem name=gtmCartContents  key=basketindex}]
+                    [{assign var="d3oItemPrice" value=$basketitem->getPrice()}]
+                    [{assign var="gtmBasketItem" value=$basketitem->getArticle()}]
+                    [{assign var="gtmBasketItemCategory" value=$gtmBasketItem->getCategory()}]
+                    {
+                        'item_id':          '[{$gtmCartArticles[$basketindex]->getFieldData('oxartnum')}]',
+                        'item_name':        '[{$gtmCartArticles[$basketindex]->getFieldData('oxtitle')}]',
+                        'item_variant':     '[{$gtmCartArticles[$basketindex]->getFieldData('oxvarselect')}]',
+                        'item_category':    '[{$gtmBasketItemCategory->getSplitCategoryArray(0)}]',
+                        'item_category_2':  '[{$gtmBasketItemCategory->getSplitCategoryArray(1)}]',
+                        'item_category_3':  '[{$gtmBasketItemCategory->getSplitCategoryArray(2)}]',
+                        'item_category_4':  '[{$gtmBasketItemCategory->getSplitCategoryArray(3)}]',
+                        'item_list_name':   '[{$gtmBasketItemCategory->getSplitCategoryArray()}]',
+                        'price':            [{$d3oItemPrice->getPrice()}],
+                        'coupon':           '[{foreach from=$oxcmp_basket->getVouchers() item=sVoucher key=key name=Voucher}][{$sVoucher->sVoucherNr}][{if !$smarty.foreach.Voucher.last}], [{/if}][{/foreach}]',
+                        'quantity':         [{$basketitem->getAmount()}],
+                        'position':         [{$smarty.foreach.gtmCartContents.index}]
+                    }[{if !$smarty.foreach.gtmCartContents.last}],[{/if}]
+                [{/foreach}]
+                ]
+        }
+    });
+[{/capture}][{/strip}]
+[{oxscript add=$d3_ga4_view_cart}]

Application/views/blocks/view_item.tpl

@@ -5,6 +5,7 @@
 
 <script>
   dataLayer.push({"event": null, "eventLabel": null, "ecommerce": null});  /* Clear the previous ecommerce object. */
+
   dataLayer.push({
     'event': 'view_item',
     'eventLabel':'Product View',
@@ -15,8 +16,12 @@
           '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}]',
+          'item_category':  '[{$gtmCategory->getSplitCategoryArray(0)}]',
+          'item_category_2':'[{$gtmCategory->getSplitCategoryArray(1)}]',
+          'item_category_3':'[{$gtmCategory->getSplitCategoryArray(2)}]',
+          'item_category_4':'[{$gtmCategory->getSplitCategoryArray(3)}]',
+          'item_list_name':'[{$gtmCategory->getSplitCategoryArray()}]',
           [{assign var="d3PriceObject" value=$gtmProduct->getPrice()}]
           'price': [{$d3PriceObject->getPrice()}]
         }

Application/views/ga4/add_to_cart.tpl

@@ -1,56 +1,46 @@
 [{$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. */
 
-    [{*** Debug cases ***}]
-    [{*event.preventDefault();*}]
+  [{*** Debug cases ***}]
+  [{*event.preventDefault();*}]
 
-    let iArtQuantity = $("#amountToBasket").val();
+  let iArtQuantity = $("#amountToBasket").val();
 
-    dataLayer.push({
-        'isAddToBasket': true,
-      'event':'add_to_cart',
-      'eventLabel': 'add_to_cart',
-      'ecommerce': {
-        'currency':   "[{$currency->name}]",
-        'value':      iArtQuantity*[{$d3PriceObject->getPrice()}],
-        'items':      [
-          {
-            'item_id':        '[{$gtmProduct->getFieldData('oxartnum')}]',
-            'item_name':      '[{$gtmProduct->getFieldData('oxtitle')}]',
-            'price':          [{$d3PriceObject->getPrice()}],
-            'item_brand':     '[{if $gtmManufacturer}][{$gtmManufacturer->oxmanufacturers__oxtitle->value}][{/if}]',
-            'item_variant':   '[{if $gtmProduct->getFieldData('oxvarselect')}][{$gtmProduct->getFieldData('oxvarselect')}][{/if}]',
-            'item_category':  itemCategories[0] || 'no category',
-            'item_category_2':itemCategories[1] || '',
-            'item_category_3':itemCategories[2] || '',
-            'item_category_4':itemCategories[3] || '',
-            'quantity': iArtQuantity
-          }
-        ]
+  dataLayer.push({
+    'isAddToBasket': true,
+    'event':'add_to_cart',
+    'eventLabel': 'add_to_cart',
+    'ecommerce': {
+      'currency':   "[{$currency->name}]",
+      'value':      iArtQuantity*[{$d3PriceObject->getPrice()}],
+      'items':      [
+        {
+        'item_id':        '[{$gtmProduct->getFieldData('oxartnum')}]',
+        'item_name':      '[{$gtmProduct->getFieldData('oxtitle')}]',
+        'price':          [{$d3PriceObject->getPrice()}],
+        'item_brand':     '[{if $gtmManufacturer}][{$gtmManufacturer->oxmanufacturers__oxtitle->value}][{/if}]',
+        'item_variant':   '[{if $gtmProduct->getFieldData('oxvarselect')}][{$gtmProduct->getFieldData('oxvarselect')}][{/if}]',
+        'item_category':  '[{$gtmCategory->getSplitCategoryArray(0)}]',
+        'item_category_2':'[{$gtmCategory->getSplitCategoryArray(1)}]',
+        'item_category_3':'[{$gtmCategory->getSplitCategoryArray(2)}]',
+        'item_category_4':'[{$gtmCategory->getSplitCategoryArray(3)}]',
+        'item_list_name':'[{$gtmCategory->getSplitCategoryArray()}]',
+        'quantity': iArtQuantity
+        }
+      ]
       }
     });
   });
-[{/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}]
+  [{/block}]
+  [{/capture}]
+[{oxscript add=$d3_ga4_add_to_cart}]

Application/views/ga4/view_item_list.tpl

@@ -1,36 +1,40 @@
-[{$smarty.block.parent}]
-[{assign var="gtmProducts" value=$oView->getArticleList()}]
-
-[{assign var="breadCrumb" value=''}]
-
-[{if $gtmProducts|@count}]
-[{strip}]
-    <script>
-        /* ga4 */
-        dataLayer.push({ecommerce: null});
-        dataLayer.push({
-            'event':'view_item_list',
-            'event_name': 'view_item_list',
-            'ecommerce': {
-              'item_list_id': '[{$oView->getCategoryId()}]',
-              'item_list_name': '[{foreach from=$oView->getBreadCrumb() item=sCrum}][{if $sCrum.title }][{$breadCrumb|cat:$sCrum.title|cat:" > "}][{/if}][{/foreach}]',
-                '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': [{$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
-                    }[{if !$smarty.foreach.gtmProducts.last}],[{/if}]
-                    [{/foreach}]
-                ]
-            }
-        });
-    </script>
-[{/strip}]
+[{$smarty.block.parent}]
+[{assign var="gtmProducts" value=$oView->getArticleList()}]
+[{assign var="gtmCategory" value=$oView->getActiveCategory()}]
+
+[{assign var="breadCrumb" value=''}]
+
+[{if $gtmProducts|@count}]
+[{strip}]
+    <script>
+        /* ga4 */
+        dataLayer.push({ecommerce: null});
+        dataLayer.push({
+            'event':'view_item_list',
+            'event_name': 'view_item_list',
+            'ecommerce': {
+                'item_list_id': '[{$oView->getCategoryId()}]',
+                'item_list_name': '[{foreach from=$oView->getBreadCrumb() item=sCrum}][{if $sCrum.title }][{$breadCrumb|cat:$sCrum.title|cat:" > "}][{/if}][{/foreach}]',
+                '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': [{$d3PriceObject->getPrice()}],
+                        'item_brand': '[{if $gtmManufacturer}][{$gtmManufacturer->oxmanufacturers__oxtitle->value}][{/if}]',
+                        'item_category':  '[{$gtmCategory->getSplitCategoryArray(0)}]',
+                        'item_category_2':'[{$gtmCategory->getSplitCategoryArray(1)}]',
+                        'item_category_3':'[{$gtmCategory->getSplitCategoryArray(2)}]',
+                        'item_category_4':'[{$gtmCategory->getSplitCategoryArray(3)}]',
+                        'quantity': 1
+                    }[{if !$smarty.foreach.gtmProducts.last}],[{/if}]
+                    [{/foreach}]
+                ]
+            }
+        });
+    </script>
+[{/strip}]
 [{/if}]

Application/views/ga4/view_search_result.tpl

@@ -15,13 +15,17 @@
             [{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}]
+            [{assign var="gtmCategory" value=$gtmProduct->getCategory()}]
             {
               'item_id': '[{$gtmProduct->getFieldData("oxartnum")}]',
               'item_name': '[{$gtmProduct->getFieldData("oxtitle")}]',
               '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}]',
+              'item_category':  '[{$gtmCategory->getSplitCategoryArray(0)}]',
+              'item_category_2':'[{$gtmCategory->getSplitCategoryArray(1)}]',
+              'item_category_3':'[{$gtmCategory->getSplitCategoryArray(2)}]',
+              'item_category_4':'[{$gtmCategory->getSplitCategoryArray(3)}]',
+              'item_list_name':'[{$gtmCategory->getSplitCategoryArray()}]',
               'quantity': 1
             }[{if !$smarty.foreach.gtmProducts.last}],[{/if}]
             [{/foreach}]

CHANGELOG.md

@@ -4,69 +4,42 @@ 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.6.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.5.0...2.6.0) - 2023-05-31
+## [1.10.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.9.0...1.10.0) - 2023-06-27
 ### 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
+- Following Entries to dedicated event-templates
+  - coupon
+  - paymentType
+  - item_list_name
+  - item_category
+- Method to get the in order used Payment-Name
+- Method to get the current Article Category
 ### Changed
-- view_item_list-template block extension
 - cookieManager handling
-### Removed
-- additional check for cookieManagerType
+- general template cleanup
+- renaming the template to a more intuitive name
 
-## [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
+## [1.9.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.8.0...1.9.0) - 2023-06-19
+### Changed
+- add_to_cart event template-structure
+
+## [1.8.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.7.0...1.8.0) - 2023-05-31
 ### Fixed
-- unnecessary converting of int to str
-- missing PriceObject-bug
+- 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
-
-## [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
+- usercentrics includation script
 
 ## [1.5.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.4.0...1.5.0) - 2023-05-23
 ### Added

Docs/README.md

@@ -12,7 +12,7 @@ Für den geregelten Ablauf sind folgende Blöcke nötig:
     - Datei: page/search/search.tpl
     - GA4 Event: view_search_results
 - Artikelliste
-    - Blockname: page_list_productlist (muss hinzugefügt werden)
+    - Blockname: page_list_productlist
     - Datei: page/list/list.tpl
     - GA4 Event: view_item_list
 - Detailseite

IntelliSenseHelper.php

@@ -15,4 +15,9 @@
 
 namespace D3\GoogleAnalytics4\Modules\Core{
     class ViewConfig_parent extends \OxidEsales\Eshop\Core\ViewConfig{}
+}
+
+namespace D3\GoogleAnalytics4\Modules\Application\Model{
+    class Category_parent extends \OxidEsales\Eshop\Application\Model\Category {}
+    class Basket_parent extends \OxidEsales\Eshop\Application\Model\Basket {}
 }

Modules/Application/Model/Basket.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace D3\GoogleAnalytics4\Modules\Application\Model;
+
+use OxidEsales\Eshop\Application\Model\Payment;
+
+class Basket extends Basket_parent
+{
+    /**
+     * @return void
+     */
+    public function getPaymentOnPaymentId() :string
+    {
+        if ($this->getPaymentId()){
+            $oPayment = oxNew(Payment::class);
+            if ($oPayment->load($this->getPaymentId())){
+                return $oPayment->getFieldData('oxdesc');
+            }
+        }
+
+        return "couldn't load payment!";
+    }
+}

Modules/Application/Model/Category.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace D3\GoogleAnalytics4\Modules\Application\Model;
+
+class Category extends Category_parent
+{
+    /**
+     * @param int $indexOfArray
+     * @return string
+     */
+    public function getSplitCategoryArray(int $indexOfArray = -1) :string
+    {
+        if ($indexOfArray > -1){
+            $splitCatArray =
+                array_values(
+                    array_filter(
+                        explode(
+                            '/',
+                            trim(
+                                parse_url(
+                                    $this->getLink(),
+                                    5
+                                )
+                            )
+                        )
+                    )
+                );
+
+            if ($splitCatArray[$indexOfArray]){
+                return $splitCatArray[$indexOfArray];
+            }else{
+                return "";
+            }
+        }
+
+        return
+            trim(
+                parse_url(
+                    $this->getLink(),
+                    5
+                )
+            );
+    }
+}

Modules/Core/ViewConfig.php

@@ -17,8 +17,6 @@ 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
 {
@@ -31,10 +29,7 @@ class ViewConfig extends ViewConfig_parent
     {
         if ($this->sContainerId === null)
         {
-            $this->sContainerId = ContainerFactory::getInstance()
-                                                  ->getContainer()
-                                                  ->get(ModuleSettingBridgeInterface::class)
-                                                  ->get('d3_gtm_sContainerID', 'd3googleanalytics4');
+            $this->sContainerId = $this->getConfig()->getConfigParam('d3_gtm_sContainerID');
         }
         return $this->sContainerId;
     }
@@ -75,7 +70,7 @@ class ViewConfig extends ViewConfig_parent
 
         $this->defineCookieManagerType();
 
-        $sCookieID = $oConfig->getConfigParam('d3_gtm_settings_cookieName');
+        $sCookieID = trim($oConfig->getConfigParam('d3_gtm_settings_cookieName'));
 
         // Netensio Cookie Manager
         if ($this->sCookieManagerType === ManagerTypes::NET_COOKIE_MANAGER) {
@@ -97,6 +92,7 @@ class ViewConfig extends ViewConfig_parent
             $this->sCookieManagerType       === ManagerTypes::USERCENTRICS_MODULE
             or $this->sCookieManagerType    === ManagerTypes::USERCENTRICS_MANUALLY
             or $this->sCookieManagerType    === ManagerTypes::CONSENTMANAGER
+            or $this->sCookieManagerType    === ManagerTypes::COOKIEFIRST
             or $this->sCookieManagerType    === ManagerTypes::EXTERNAL_SERVICE
         )
         {
@@ -115,8 +111,7 @@ class ViewConfig extends ViewConfig_parent
      */
     public function getGtmScriptAttributes() :string
     {
-        $oConfig = Registry::getConfig();
-        $sCookieId = $oConfig->getConfigParam('d3_gtm_settings_cookieName');
+        $sCookieId = trim(Registry::getConfig()->getConfigParam('d3_gtm_settings_cookieName'));
 
         if (false === $this->shallUseOwnCookieManager()){
             return "";
@@ -144,6 +139,10 @@ class ViewConfig extends ViewConfig_parent
             }
         }
 
+        if ($this->sCookieManagerType === ManagerTypes::COOKIEFIRST){
+            return 'type="text/plain" data-cookiefirst-category="' . $sCookieId .'"';
+        }
+
         return "";
     }
 
@@ -153,10 +152,7 @@ class ViewConfig extends ViewConfig_parent
     {
         if ($this->blGA4enabled === null)
         {
-            $this->sContainerId = ContainerFactory::getInstance()
-                                                  ->getContainer()
-                                                  ->get(ModuleSettingBridgeInterface::class)
-                                                  ->get('d3_gtm_blEnableGA4', 'd3googleanalytics4');
+            $this->sContainerId = $this->getConfig()->getConfigParam('d3_gtm_blEnableGA4');
         }
 
         return $this->blGA4enabled;

composer.json

@@ -1,56 +1,56 @@
-{
-  "name": "d3/google-analytics4",
-  "description": "Google Tag Manager with new Google Analytics 4 for OXID eShop v6",
-  "type": "oxideshop-module",
-  "keywords": [
-    "oxid",
-    "modules",
-    "eShop",
-    "d3",
-    "google",
-    "ga4",
-    "googleanalytics",
-    "gtm",
-    "configuration"
-  ],
-  "homepage": "https://www.d3data.de",
-  "license": [
-    "GPL-3.0"
-  ],
-  "authors": [
-    {
-      "name": "Marat Bedoev",
-      "email": "hello@mb-dev.pro"
-    },
-    {
-      "name": "D3 Data Development (Inh. Thomas Dartsch)",
-      "email": "info@shopmodule.com",
-      "homepage": "https://www.d3data.de"
-    }
-  ],
-  "support": {
-    "email": "support@shopmodule.com"
-  },
-  "extra": {
-    "oxideshop": {
-      "blacklist-filter": [
-        "*.md",
-        "composer.json",
-        ".php-cs-fixer.php",
-        "*.xml",
-        "*.neon"
-      ],
-      "target-directory": "d3/googleanalytics4"
-    }
-  },
-  "require": {
-    "php": ">=7.1",
-    "oxid-esales/oxideshop-ce": "^6.5",
-    "google/apiclient":" ^2.0"
-  },
-  "autoload": {
-    "psr-4": {
-      "D3\\GoogleAnalytics4\\": "../../../source/modules/d3/googleanalytics4"
-    }
-  }
+{
+  "name": "d3/google-analytics4",
+  "description": "Google Tag Manager with new Google Analytics 4 for OXID eShop v6",
+  "type": "oxideshop-module",
+  "keywords": [
+    "oxid",
+    "modules",
+    "eShop",
+    "d3",
+    "google",
+    "ga4",
+    "googleanalytics",
+    "gtm",
+    "configuration"
+  ],
+  "homepage": "https://www.d3data.de",
+  "license": [
+    "GPL-3.0"
+  ],
+  "authors": [
+    {
+      "name": "Marat Bedoev",
+      "email": "hello@mb-dev.pro"
+    },
+    {
+      "name": "D3 Data Development (Inh. Thomas Dartsch)",
+      "email": "info@shopmodule.com",
+      "homepage": "https://www.d3data.de"
+    }
+  ],
+  "support": {
+    "email": "support@shopmodule.com"
+  },
+  "extra": {
+    "oxideshop": {
+      "blacklist-filter": [
+        "*.md",
+        "composer.json",
+        ".php-cs-fixer.php",
+        "*.xml",
+        "*.neon"
+      ],
+      "target-directory": "d3/googleanalytics4"
+    }
+  },
+  "require": {
+    "php": ">=7.1",
+    "oxid-esales/oxideshop-ce": "v6.0 - 6.3",
+    "google/apiclient":" ^2.0"
+  },
+  "autoload": {
+    "psr-4": {
+      "D3\\GoogleAnalytics4\\": "../../../source/modules/d3/googleanalytics4"
+    }
+  }
 }

metadata.php

@@ -1,5 +1,10 @@
 <?php
+
+use D3\GoogleAnalytics4\Modules\Application\Model\Basket as Basket;
+use D3\GoogleAnalytics4\Modules\Application\Model\Category as Category;
 use D3\GoogleAnalytics4\Modules\Core\ViewConfig;
+use OxidEsales\Eshop\Application\Model\Basket as OEBasket;
+use OxidEsales\Eshop\Application\Model\Category as OECategory;
 use OxidEsales\Eshop\Core\ViewConfig as OEViewConfig;
 
 $sMetadataVersion = '2.1';
@@ -17,19 +22,16 @@ $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.6.0',
+    'version'     => '1.10.0',
     'author'      => 'Data Development (Inh.: Thomas Dartsch)',
     'email'       => 'support@shopmodule.com',
     'url'         => 'https://www.oxidmodule.com/',
     'extend'      => [
-        OEViewConfig::class => ViewConfig::class
-    ],
-    'templates'   => [
-        // GA4 events
-        'ga4_add_to_cart.tpl'      => 'd3/googleanalytics4/Application/views/ga4/add_to_cart.tpl',
-        'ga4_search.tpl'           => 'd3/googleanalytics4/Application/views/ga4/search.tpl',
-        'ga4_view_item_list.tpl'   => 'd3/googleanalytics4/Application/views/ga4/view_item_list.tpl',
+        OEViewConfig::class => ViewConfig::class,
+        OECategory::class => Category::class,
+        OEBasket::class => Basket::class
     ],
+    'templates'   => [],
     'blocks'      => [
         // tag manager js
         [
@@ -55,12 +57,12 @@ $aModule          = [
         [
             'template' => 'page/checkout/basket.tpl',
             'block'    => 'checkout_basket_main',
-            'file'     => '/Application/views/blocks/checkout_s1.tpl'
+            'file'     => '/Application/views/blocks/view_cart.tpl'
         ],
         [
             'template' => 'page/checkout/thankyou.tpl',
             'block'    => 'checkout_thankyou_main',
-            'file'     => '/Application/views/blocks/checkout_s5.tpl'
+            'file'     => '/Application/views/blocks/purchase.tpl'
         ],
         // Lists
         // view_item_list
@@ -74,7 +76,7 @@ $aModule          = [
         [
             'template' => 'page/search/search.tpl',
             'block'    => 'search_results',
-            'file'     => '/Application/views/ga4/search.tpl',
+            'file'     => '/Application/views/ga4/view_search_result.tpl',
             'position' => 150
         ],
         // add_to_cart
@@ -126,7 +128,7 @@ $aModule          = [
             'name' => 'd3_gtm_settings_HAS_STD_MANAGER',
             'type' => 'select',
             'value' => 'none',
-            'constraints' => 'NONE|CONSENTMANAGER|USERCENTRICS',
+            'constraints' => 'NONE|CONSENTMANAGER|USERCENTRICS|COOKIEFIRST',
         ],
     ]
 ];