bump version && changelog to 1.10.0

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,63 @@
+<?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";
+
+    const COOKIEFIRST               = "COOKIEFIRST";
+
+    /**
+     * @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,
+            "cookiefirst"        => self::COOKIEFIRST
+        ];
+    }
+
+    /**
+     * @param string $sManager
+     * @return bool
+     */
+    public function isManagerInList(string $sManager) :bool
+    {
+        return in_array($sManager, $this->getManagerList(), true);
+    }
+}

Application/views/admin/de/module_options.php

@@ -31,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}]
+    [{if $oViewConf->getGtmContainerId()}]
-    <!-- Google Tag Manager -->
+        [{strip}]
-    <script [{$oViewConf->getGtmScriptAttributes()}]>
+            <!-- Google Tag Manager -->
-      (function (w, d, s, l, i) {
+            <script [{$oViewConf->getGtmScriptAttributes()}]>
-        w[l] = w[l] || [];
+              (function (w, d, s, l, i) {
-        w[l].push({'gtm.start': new Date().getTime(), event: 'gtm.js'});
+                w[l] = w[l] || [];
-        var f = d.getElementsByTagName(s)[0], j = d.createElement(s), dl = l != 'dataLayer' ? '&l=' + l : '';
+                w[l].push({'gtm.start': new Date().getTime(), event: 'gtm.js'});
-        j.async = true;
+                var f = d.getElementsByTagName(s)[0], j = d.createElement(s), dl = l != 'dataLayer' ? '&l=' + l : '';
-        j.src = 'https://www.googletagmanager.com/gtm.js?id=' + i + dl;
+                j.async = true;
-        f.parentNode.insertBefore(j, f);
+                j.src = 'https://www.googletagmanager.com/gtm.js?id=' + i + dl;
-      })(window, document, 'script', 'dataLayer', '[{$oViewConf->getGtmContainerId()}]');
+                f.parentNode.insertBefore(j, f);
-    </script>
+              })(window, document, 'script', 'dataLayer', '[{$oViewConf->getGtmContainerId()}]');
-    <!-- End Google Tag Manager -->
+            </script>
-
+            <!-- End Google Tag Manager -->
-    [{if $oViewConf->getTopActionClassName() === "alist" }]
+        [{/strip}]
-    [{* 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/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

@@ -11,8 +11,6 @@
   $("#toBasket").click(function(event) {
   dataLayer.push({"event": null, "eventLabel": null, "ecommerce": null});  /* Clear the previous ecommerce object. */
 
-  let itemCategories = '[{if $gtmCategory}][{$gtmCategory->getLink()|parse_url:5|ltrim:"/"|rtrim:"/"}][{else}]no category[{/if}]'.split('/');
-
   [{*** Debug cases ***}]
   [{*event.preventDefault();*}]
 
@@ -32,10 +30,11 @@
         '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':  '[{$gtmCategory->getSplitCategoryArray(0)}]',
-        'item_category_2':itemCategories[1] || '',
+        'item_category_2':'[{$gtmCategory->getSplitCategoryArray(1)}]',
-        'item_category_3':itemCategories[2] || '',
+        'item_category_3':'[{$gtmCategory->getSplitCategoryArray(2)}]',
-        'item_category_4':itemCategories[3] || '',
+        'item_category_4':'[{$gtmCategory->getSplitCategoryArray(3)}]',
+        'item_list_name':'[{$gtmCategory->getSplitCategoryArray()}]',
         'quantity': iArtQuantity
         }
       ]

Application/views/ga4/view_item_list.tpl

@@ -1,5 +1,6 @@
 [{$smarty.block.parent}]
 [{assign var="gtmProducts" value=$oView->getArticleList()}]
+[{assign var="gtmCategory" value=$oView->getActiveCategory()}]
 
 [{assign var="breadCrumb" value=''}]
 
@@ -12,8 +13,8 @@
             'event':'view_item_list',
             'event_name': 'view_item_list',
             'ecommerce': {
-              'item_list_id': '[{$oView->getCategoryId()}]',
+                'item_list_id': '[{$oView->getCategoryId()}]',
-              'item_list_name': '[{foreach from=$oView->getBreadCrumb() item=sCrum}][{if $sCrum.title }][{$breadCrumb|cat:$sCrum.title|cat:" > "}][{/if}][{/foreach}]',
+                'item_list_name': '[{foreach from=$oView->getBreadCrumb() item=sCrum}][{if $sCrum.title }][{$breadCrumb|cat:$sCrum.title|cat:" > "}][{/if}][{/foreach}]',
                 'items': [
                     [{foreach from=$gtmProducts name="gtmProducts" item="gtmProduct"}]
                     [{assign var="d3PriceObject" value=$gtmProduct->getPrice()}]
@@ -24,7 +25,10 @@
                         '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)}]',
                         'quantity': 1
                     }[{if !$smarty.foreach.gtmProducts.last}],[{/if}]
                     [{/foreach}]

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,6 +4,20 @@ 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).
 
+## [1.10.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.9.0...1.10.0) - 2023-06-27
+### Added
+- 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
+- cookieManager handling
+- general template cleanup
+- renaming the template to a more intuitive name
+
 ## [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

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

@@ -12,6 +12,8 @@
 
 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;
@@ -33,53 +35,22 @@ class ViewConfig extends ViewConfig_parent
     }
 
     /**
-     * @return mixed
+     * @return void
      */
-    public function getModuleSettingExplicitManagerSelectValue()
+    public function defineCookieManagerType() :void
-    {
-        return Registry::getConfig()->getConfigParam('d3_gtm_settings_HAS_STD_MANAGER');
-    }
-
-    /**
-     * @return false|mixed
-     */
-    public function getExplicitManager()
-    {
-        $sManagerName = $this->getModuleSettingExplicitManagerSelectValue();
-        return $sManagerName === "NONE" ? false : $sManagerName;
-    }
-
-    public function getCookieManagerType()
     {
         if ($this->sCookieManagerType === null)
         {
-            $this->sCookieManagerType = false;
+            /** @var ManagerHandler $oManagerHandler */
-
+            $oManagerHandler = oxNew(ManagerHandler::class);
-            $allowedManagerTypes = [
+            $this->sCookieManagerType = $oManagerHandler->getCurrManager();
-                'net_cookie_manager',
-                'agcookiecompliance',
-                'oxps_usercentrics'
-            ];
-
-            foreach ($allowedManagerTypes as $type) {
-                if ($this->isModuleActive($type)) {
-                    $this->sCookieManagerType = $type;
-                    break;
-                }
-            }
         }
-
-        if ($this->sCookieManagerType === false and $this->getExplicitManager()){
-            return "externalService";
-        }
-
-        return $this->sCookieManagerType;
     }
 
     /**
      * @return bool
      */
-    public function shallUseOwnCookieManager()
+    public function shallUseOwnCookieManager() :bool
     {
         return (bool) Registry::getConfig()->getConfigParam('d3_gtm_settings_hasOwnCookieManager');
     }
@@ -93,33 +64,43 @@ class ViewConfig extends ViewConfig_parent
         $oConfig = Registry::getConfig();
 
         // No Cookie Manager in use
-        if (false === $this->shallUseOwnCookieManager()) {
+        if (!$this->shallUseOwnCookieManager()) {
             return true;
         }
 
-        $sCookieID = $oConfig->getConfigParam('d3_gtm_settings_cookieName');
+        $this->defineCookieManagerType();
+
+        $sCookieID = trim($oConfig->getConfigParam('d3_gtm_settings_cookieName'));
 
         // Netensio Cookie Manager
-        if ($this->getCookieManagerType() == "net_cookie_manager") {
+        if ($this->sCookieManagerType === ManagerTypes::NET_COOKIE_MANAGER) {
             $oSession = Registry::getSession();
             $aCookies = $oSession->getVariable("aCookieSel");
 
-            return (!is_null($aCookies) && is_array($aCookies) && array_key_exists($sCookieID, $aCookies) && $aCookies[$sCookieID] == "1");
+            return (is_array($aCookies) && array_key_exists($sCookieID, $aCookies) && $aCookies[$sCookieID] == "1");
         }
 
         // Aggrosoft Cookie Consent
-        if ($this->getCookieManagerType() == "agcookiecompliance") {
+        if ($this->sCookieManagerType === ManagerTypes::AGCOOKIECOMPLIANCE) {
             if (method_exists($this, "isCookieCategoryEnabled")) {
                 return $this->isCookieCategoryEnabled($sCookieID);
             }
         }
 
         // UserCentrics or consentmanager
-        if ($this->getCookieManagerType() === "oxps_usercentrics" or $this->getCookieManagerType() === 'externalService') {
+        if (
+            $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
+        )
+        {
             // Always needs the script-tags delivered to the DOM.
             return true;
         }
 
+        // Cookie Manager not (yet) supported
         return false;
     }
 
@@ -128,25 +109,26 @@ class ViewConfig extends ViewConfig_parent
      * This is especially important for UserCentrics.
      * @return string
      */
-    public function getGtmScriptAttributes()
+    public function getGtmScriptAttributes() :string
     {
-        $oConfig = Registry::getConfig();
+        $sCookieId = trim(Registry::getConfig()->getConfigParam('d3_gtm_settings_cookieName'));
 
         if (false === $this->shallUseOwnCookieManager()){
             return "";
         }
 
-        if ($this->getCookieManagerType() === "oxps_usercentrics" or $this->getExplicitManager() === 'USERCENTRICS') {
+        if (
-            $sCookieId = $oConfig->getConfigParam('d3_gtm_settings_cookieName');
+            $this->sCookieManagerType === ManagerTypes::USERCENTRICS_MODULE
-
+            or $this->sCookieManagerType === ManagerTypes::USERCENTRICS_MANUALLY
+        )
+        {
             if ($sCookieId) {
                 return 'data-usercentrics="' . $sCookieId . '" type="text/plain" async=""';
             }
         }
 
-        if ($this->getCookieManagerType() === "externalService" and $this->getExplicitManager() === 'CONSENTMANAGER') {
+        if ($this->sCookieManagerType === ManagerTypes::CONSENTMANAGER)
-            $sCookieId = $oConfig->getConfigParam('d3_gtm_settings_cookieName');
+        {
-
             if ($sCookieId) {
                 return 'async 
                         type="text/plain"
@@ -157,6 +139,10 @@ class ViewConfig extends ViewConfig_parent
             }
         }
 
+        if ($this->sCookieManagerType === ManagerTypes::COOKIEFIRST){
+            return 'type="text/plain" data-cookiefirst-category="' . $sCookieId .'"';
+        }
+
         return "";
     }
 

README.md

@@ -23,16 +23,16 @@ 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!
+### Wichtig!
-> Bitte stellen Sie sicher, dass die nötigen Blöcke im OXID-Shop zur Verfügung stehen.
+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"!
+Lesen Sie mehr in der [technischen Doku](./Docs/README.md) unter "Blöcke"!
 
 ## Verwendung
 ### Grundfunktionalität

composer.json

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