bump changelog && version to 2.13.1

deny method-call on no category

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,66 @@
+<?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";
+
+    const COOKIEBOT               = "COOKIEBOT";
+
+    /**
+     * @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,
+            "cookiebot"             => self::COOKIEBOT,
+        ];
+    }
+
+    /**
+     * @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,23 @@ $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>
+                                                                        <a href="https://consentmanager.net/">Consentmanager</a><br>
+                                                                        <a href="https://usercentrics.com/">Usercentrics</a><br>
+                                                                        <a href="https://cookiefirst.com">Cookiefirst</a><br>
+                                                                        
+                                                                        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_cookieName'  => 'CookieID',
+    'SHOP_MODULE_d3_gtm_settings_HAS_STD_MANAGER_COOKIEFIRST'       => 'cookiefirst',
+    'SHOP_MODULE_d3_gtm_settings_HAS_STD_MANAGER_COOKIEBOT'         => 'Cookiebot',
+    'SHOP_MODULE_d3_gtm_settings_controlParameter'        => 'Steuerungsparameter',
+    'HELP_SHOP_MODULE_d3_gtm_settings_controlParameter'   => 'Nähere infos zum <a target="_blank" href="https://git.d3data.de/D3Public/GoogleAnalytics4/src/branch/master/Docs">"<strong>Steuerungsparameter</strong>"</a><hr>
+                                                        <strong>Beachte:</strong><br>
+                                                        Sofern Sie die <a target="_blank" href="https://consentmanager.net" style="color: blue">consentmanager</a> CMP verwenden,
+                                                        bitte ich Sie, gründlichst, die Hinweise der <a target="_blank" href="https://git.d3data.de/D3Public/GoogleAnalytics4/src/branch/master/Docs/CMP/consentmanager.md">Moduldokumentation/Consentmanager</a> zu lesen.
+                                                        '
 ];

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,56 @@
+[{$smarty.block.parent}]
+
+[{block name="d3_ga4_purchase_block"}]
+    [{capture assign=d3_ga4_purchase}]
+        [{strip}]
+            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")}]',
+                                [{if $gtmPurchaseItemCategory}]
+                                '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()}]',
+                                [{/if}]
+                                'price':            [{$gtmPurchaseItemPriceObject->getPrice()}],
+                                'quantity':         [{$gtmBasketItem->getFieldData("oxamount")}],
+                                'position':         [{$smarty.foreach.gtmArticles.iteration}]
+                            }[{if !$smarty.foreach.gtmArticles.last}],[{/if}]
+                        [{/foreach}]
+                    ]
+                }[{if $oViewConf->isDebugModeOn()}],
+                'debug_mode': 'true'
+                [{/if}]
+            })
+        [{/strip}]
+    [{/capture}]
+    [{oxscript add=$d3_ga4_purchase}]
+[{/block}]

Application/views/blocks/view_cart.tpl

@@ -0,0 +1,50 @@
+[{$smarty.block.parent}]
+
+[{*$oxcmp_basket|get_class_methods|dumpvar*}]
+
+[{assign var="d3BasketPrice" value=$oxcmp_basket->getPrice()}]
+[{assign var='gtmCartArticles' value=$oView->getBasketArticles()}]
+
+[{block name="d3_ga4_view_cart_block"}]
+    [{capture assign=d3_ga4_view_cart}]
+        [{strip}]
+            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')}]',
+                                [{if $gtmBasketItemCategory}]
+                                '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()}]',
+                                [{/if}]
+                                '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}]
+                        ]
+                }[{if $oViewConf->isDebugModeOn()}],
+                'debug_mode': 'true'
+                [{/if}]
+            });
+        [{/strip}]
+    [{/capture}]
+    [{oxscript add=$d3_ga4_view_cart}]
+[{/block}]

Application/views/blocks/view_item.tpl

@@ -3,24 +3,38 @@
 [{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>
+[{block name="d3_ga4_view_item_block"}]
+  [{capture assign=d3_ga4_view_item}]
+    [{strip}]
+      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_variant': '[{if $gtmProduct->getFieldData("oxvarselect")}][{$gtmProduct->getFieldData("oxvarselect")}][{/if}]',
+              [{if $gtmCategory}]
+              '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()}]',
+              [{/if}]
+              [{assign var="d3PriceObject" value=$gtmProduct->getPrice()}]
+              'price': [{$d3PriceObject->getPrice()}]
+            }
+          ]
+        }[{if $oViewConf->isDebugModeOn()}],
+        'debug_mode': 'true'
+        [{/if}]
+      });
+    [{/strip}]
+  [{/capture}]
+  [{oxscript add=$d3_ga4_view_item}]
+[{/block}]

Application/views/ga4/add_to_cart.tpl

@@ -1,56 +1,52 @@
 [{$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"}]
-  $("#toBasket").click(function(event) {
+[{block name="d3_ga4_add_to_cart_block"}]
+  [{capture assign=d3_ga4_add_to_cart}]
+    [{strip}]
+      $("#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
-          }
-        ]
-      }
-    });
-  });
-[{/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}]
+        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}]',
+              [{if $gtmCategory}]
+              '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()}]',
+              [{/if}]
+              'quantity': iArtQuantity
+              }
+            ]
+          }[{if $oViewConf->isDebugModeOn()}],
+          'debug_mode': 'true'
+          [{/if}]
+        });
+      });
+    [{/strip}]
+  [{/capture}]
+  [{oxscript add=$d3_ga4_add_to_cart}]
+[{/block}]

Application/views/ga4/remove_from_cart.tpl

@@ -0,0 +1,48 @@
+[{$smarty.block.parent}]
+
+[{block name="d3_ga4_remove_from_cart_block"}]
+    [{if $hasBeenReloaded}]
+        [{assign var="d3BasketPrice" value=$oxcmp_basket->getPrice()}]
+        [{capture assign=d3_ga4_remove_from_cart}]
+            [{strip}]
+                dataLayer.push({"event": null, "eventLabel": null, "ecommerce": null});  /* Clear the previous ecommerce object. */
+                dataLayer.push({
+                    'isRemoveFromCart': true,
+                    'event': 'remove_from_cart',
+                    'eventLabel':'remove_from_cart',
+                    '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=$toRemoveArticles->getArray() name=gtmRemovedItems item=rmItem  key=rmItemindex}]
+                            [{assign var="d3oItemPrice" value=$rmItem->getPrice()}]
+                            [{assign var="gtmBasketItemCategory" value=$rmItem->getCategory()}]
+                            {
+                            'item_id':          '[{$rmItem->getFieldData('oxartnum')}]',
+                            'item_name':        '[{$rmItem->getFieldData('oxtitle')}]',
+                            'item_variant':     '[{$rmItem->getFieldData('oxvarselect')}]',
+                            [{if $gtmBasketItemCategory}]
+                            '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()}]',
+                            [{/if}]
+                            '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':         '[{$rmItem->getFieldData('d3AmountThatGotRemoved')}]',
+                            'position':         [{$smarty.foreach.gtmRemovedItems.index}]
+                            }[{if !$smarty.foreach.gtmRemovedItems.last}],[{/if}]
+                            [{/foreach}]
+                        ]
+                    }[{if $oViewConf->isDebugModeOn()}],
+                    'debug_mode': 'true'
+                    [{/if}]
+                });
+            [{/strip}]
+        [{/capture}]
+        [{oxscript add=$d3_ga4_remove_from_cart}]
+    [{/if}]
+[{/block}]

Application/views/ga4/search.tpl

@@ -1,33 +0,0 @@
-[{$smarty.block.parent}]
-
-[{assign var="gtmProducts" value=$oView->getArticleList()}]
-
-[{if $gtmProducts|@count}]
-  [{strip}]
-    <script>
-      dataLayer.push({"event": null, "eventLabel": null, "ecommerce": null});  /* Clear the previous ecommerce object. */
-      dataLayer.push({
-        'event': 'view_search_result',
-        'eventLabel':'view_search_result',
-        'ecommerce': {
-          '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': [{$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}]
-[{/if}]

Application/views/ga4/view_item_list.tpl

@@ -1,36 +1,46 @@
-[{$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}]
-[{/if}]
+[{$smarty.block.parent}]
+[{assign var="gtmProducts" value=$oView->getArticleList()}]
+[{assign var="gtmCategory" value=$oView->getActiveCategory()}]
+
+[{assign var="breadCrumb" value=''}]
+
+[{block name="d3_ga4_view_item_list_block"}]
+    [{if $gtmProducts|@count}]
+        [{capture assign=d3_ga4_view_item_list}]
+            [{strip}]
+                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}]',
+                                [{if $gtmCategory}]
+                                'item_category':  '[{$gtmCategory->getSplitCategoryArray(0)}]',
+                                'item_category_2':'[{$gtmCategory->getSplitCategoryArray(1)}]',
+                                'item_category_3':'[{$gtmCategory->getSplitCategoryArray(2)}]',
+                                'item_category_4':'[{$gtmCategory->getSplitCategoryArray(3)}]',
+                                [{/if}]
+                                'quantity': 1
+                            }[{if !$smarty.foreach.gtmProducts.last}],[{/if}]
+                            [{/foreach}]
+                        ]
+                    }[{if $oViewConf->isDebugModeOn()}],
+                    'debug_mode': 'true'
+                    [{/if}]
+                });
+            [{/strip}]
+        [{/capture}]
+        [{oxscript add=$d3_ga4_view_item_list}]
+    [{/if}]
+[{/block}]

Application/views/ga4/view_search_result.tpl

@@ -0,0 +1,44 @@
+[{$smarty.block.parent}]
+
+[{assign var="gtmProducts" value=$oView->getArticleList()}]
+
+[{block name="d3_ga4_view_search_result_block"}]
+  [{if $gtmProducts}]
+    [{capture assign=d3_ga4_view_search_result}]
+      [{strip}]
+        dataLayer.push({"event": null, "eventLabel": null, "ecommerce": null});  /* Clear the previous ecommerce object. */
+        dataLayer.push({
+          'event': 'view_search_result',
+          'eventLabel':'view_search_result[{if $oViewConf->isDebugModeOn()}]_test[{/if}]',
+          'ecommerce': {
+            'search_term': '[{$searchparamforhtml}]',
+            'items': [
+              [{foreach from=$gtmProducts name="gtmProducts" item="gtmProduct"}]
+              [{assign var="d3PriceObject" value=$gtmProduct->getPrice()}]
+              [{assign var="gtmManufacturer" value=$gtmProduct->getManufacturer()}]
+              [{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}]',
+                [{if $gtmCategory}]
+                '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()}]',
+                [{/if}]
+                'quantity': 1
+              }[{if !$smarty.foreach.gtmProducts.last}],[{/if}]
+              [{/foreach}]
+            ]
+          }[{if $oViewConf->isDebugModeOn()}],
+          'debug_mode': 'true'
+          [{/if}]
+        });
+      [{/strip}]
+    [{/capture}]
+    [{oxscript add=$d3_ga4_view_search_result}]
+  [{/if}]
+[{/block}]

CHANGELOG.md

@@ -4,6 +4,150 @@ 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.13.1](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.13.0...2.13.1) - 2023-01-03
+## Fixed
+- error on array-count at zero entries
+
+## [2.13.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.12.0...2.13.0) - 2023-09-13
+### Added
+- extended Docs
+### Changed
+- control-param name
+- control-param function
+- adjusted check for set control-param
+- consentmanager-script-adjustments
+
+## [2.12.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.11.1...2.12.0) - 2023-09-07
+### Added
+- cookiebot functionality
+
+## [2.11.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.10.1...2.11.0) - 2023-08-23
+### Added
+- manufacturer extension
+- working debug_mode
+### Changed
+- check for 'article has been removed'
+- general template cleanup
+
+## [2.10.1](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.10.0...2.10.1) - 2023-08-03
+### Added
+- missing param to identify the event
+
+## [2.10.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.9.2...2.10.0) - 2023-08-02
+### Added
+- new Event "remove_from_cart"
+
+## [2.9.2](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.9.1...2.9.2) - 2023-06-29
+### Fixed
+- wrong variable for category-object check
+
+## [2.9.1](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.9.0...2.9.1) - 2023-06-27
+### Fixed
+- deny method call on no category
+
+## [2.9.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.8.0...2.9.0) - 2023-06-27
+### Added
+- Cookiefirst usability
+
+## [2.8.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.7.0...2.8.0) - 2023-06-23
+### Added
+- Method to get the in order used Payment-Name
+- Method to get the current Article Category
+- Following Entries to dedicated event-templates
+  - coupon
+  - paymentType
+  - item_list_name
+  - item_category
+### Changed
+- all used template-files have a more dedicated name
+- general code cleanup
+
+## [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.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
+
 ## [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

Docs/CMP/consentmanager.md

@@ -0,0 +1,18 @@
+# Consentmanager
+## 1. Steuerungsparameter
+Tragen Sie hier die gewünschte ID des zu prüfenden Anbieters (Vendor-ID) ein.<br>
+Diese ID finden Sie in Ihrem Consentmanager-Dashboard, links, unter "CMP > Anbieter".
+
+Nähere Informationen hierzu suchen Sie bitte auf der offiziellen Webseite von [app.consentmanager](https://help.consentmanager.de/books/cmp/page/4-configuring-vendors-and-cookies).
+
+## 2. Gebräuchliche ID's
+- s26 (Google Analytics/ GA/ GA4)
+- s905 (Google Tag Manager/ GTM)
+
+## 3. Einrichtung GTM
+Die von Ihnen eingetragene ID muss oder ist schlussendlich die ID, auf die im GTM-Umfeld geprüft wird.  
+Das heißt, dass sich die Eintragung nach GTM, oder umgekehrt, richtet.
+
+### Unterstützung benötigt?
+Kein Problem!  
+Kontaktieren Sie uns gern unter [d3data.de](https://www.d3data.de)

Docs/README.md

@@ -5,6 +5,13 @@ Die Einbindung dieser Event-Templates erfolgt über TPL-Blöcke unter `source/mo
 *Hinweis: nicht alle templates sind bereits gefüllt. Wünschen Sie die Implementierung eines unausgefüllten templates?
 Kommen Sie auf uns zu unter https://www.d3data.de/
 
+## Steuerungsparameter
+Tragen Sie hier im Normalfall die ID des zu prüfenden Cookies ein.  
+In bestimmten Fällen, müssen Sie hier alternative Werte eintragen. Diese Fälle sind bedingt
+nach der gewählten CMP (Consent Manager Platform).  
+  
+> nähere Infos unter [CMP](#consent-manager-platform-cmp)  
+
 ## Blöcke
 Für den geregelten Ablauf sind folgende Blöcke nötig:
 - Suchergebnisse
@@ -12,7 +19,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
+    - Blockname: page_list_productlist (muss hinzugefügt werden)
     - Datei: page/list/list.tpl
     - GA4 Event: view_item_list
 - Detailseite
@@ -50,6 +57,9 @@ Dann tragen Sie in den Folgeeinstellungen unter "Cookie Manager Einstellungen",
 die Cookie-ID des zugehörigen Cookies ein.  
 Aktivieren Sie anschließend diese Weiche. Setzen Sie den Haken bei "Eigenen Cookie Manager nutzen?".
 
+## Consent Manager Platform (CMP)
+- [Consentmanager](https://git.d3data.de/D3Public/GoogleAnalytics4/src/branch/master/Docs/CMP/consentmanager.md)
+
 ### Unterstützung für
 - [aggrosoft - oxid-cookie-compliance](https://github.com/aggrosoft/oxid-cookie-compliance)
   - https://github.com/aggrosoft/oxid-cookie-compliance
@@ -65,4 +75,15 @@ Aktivieren Sie anschließend diese Weiche. Setzen Sie den Haken bei "Eigenen Coo
 - [OXID Cookie Management powered by usercentrics](https://docs.oxid-esales.com/modules/usercentrics/de/latest/einfuehrung.html)
   - 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
-    ```Einstell. > Cookie Manager Einstellungen > Cookie-ID``` eintragen
+    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
+      
+- [Cookiebot](https://www.cookiebot.com)
+  - Nähere Informationen folgen bald! Bis dato, besuchen Sie bitte die offizielle Webseite.

IntelliSenseHelper.php

@@ -15,4 +15,13 @@
 
 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 {}
+}
+
+namespace D3\GoogleAnalytics4\Modules\Application\Controller{
+    class BasketController_parent extends \OxidEsales\Eshop\Application\Controller\BasketController {}
 }

Modules/Application/Controller/BasketController.php

@@ -0,0 +1,127 @@
+<?php
+
+namespace D3\GoogleAnalytics4\Modules\Application\Controller;
+
+use OxidEsales\Eshop\Application\Component\BasketComponent;
+use OxidEsales\Eshop\Application\Model\Article;
+use OxidEsales\Eshop\Application\Model\ArticleList;
+use OxidEsales\Eshop\Core\Registry;
+use oxSystemComponentException;
+
+class BasketController extends BasketController_parent
+{
+    /**
+     * @throws oxSystemComponentException
+     */
+    public function render()
+    {
+        $return = parent::render();
+
+        $this->d3GA4getRemovedArticlesListObject();
+
+        return $return;
+    }
+
+    /**
+     * @return void
+     * @throws oxSystemComponentException
+     */
+    public function d3GA4getRemovedArticlesListObject() :void
+    {
+        $this->addTplParam('hasBeenReloaded', false);
+        // collecting items to add
+        $aProducts = Registry::getRequest()->getRequestEscapedParameter('aproducts');
+
+        // collecting specified item
+        $sProductId = $sProductId ?? Registry::getRequest()->getRequestEscapedParameter('aid');
+        if ($sProductId) {
+            // additionally fetching current product info
+            $dAmount = $dAmount ?? Registry::getRequest()->getRequestEscapedParameter('am');
+
+            // select lists
+            $aSel = $aSel ?? Registry::getRequest()->getRequestEscapedParameter('sel');
+
+            // persistent parameters
+            if (empty($aPersParam)) {
+
+                /** @var BasketComponent $oBasketComponent */
+                $oBasketComponent = $this->getComponent('oxcmp_basket');
+
+                $aPersParam = $oBasketComponent->__call('getPersistedParameters', []);
+            }
+
+            $sBasketItemId = Registry::getRequest()->getRequestEscapedParameter('bindex');
+
+            $aProducts[$sProductId] = [
+                'am'           => $dAmount,
+                'sel'          => $aSel,
+                'persparam'    => $aPersParam,
+                'basketitemid' => $sBasketItemId
+            ];
+        }
+
+        if (is_array($aProducts) && count($aProducts)) {
+            $toRemoveArticleIdList = [];
+            $artIdOnArtAmountList = [];
+
+            if ($this->isArticleRemovedState($aProducts)) {
+                //setting amount to 0 if removing article from basket
+                foreach ($aProducts as $sProductId => $aProduct) {
+                    if ((isset($aProduct['remove']) && $aProduct['remove']) or intval($aProduct['am']) === 0) {
+                        if (!in_array($aProduct, $toRemoveArticleIdList)) {
+                            $toRemoveArticleIdList[] = $aProduct['aid'];
+                            $artIdOnArtAmountList[$aProduct['aid']] = $aProduct['am'];
+                        }
+
+                        $aProducts[$sProductId]['am'] = 0;
+                        #for GA4 Event
+                        $this->addTplParam('hasBeenReloaded', true);
+                    } else {
+                        unset($aProducts[$sProductId]);
+                    }
+                }
+            }
+
+            $oArtList = oxNew(ArticleList::class);
+            $oArtList->loadIds($toRemoveArticleIdList);
+
+            #dumpVar($this->getBasketArticles());
+
+            /** @var Article $item */
+            foreach ($oArtList->getArray() as $item){
+                foreach ($artIdOnArtAmountList as $artId => $artAmount){
+                    if ($item->getId() === $artId){
+                        $item->assign(['d3AmountThatGotRemoved' => $artAmount]);
+                    }
+                }
+            }
+
+            $this->addTplParam('toRemoveArticles', $oArtList);
+        }
+    }
+
+    /**
+     * @return bool
+     *
+     * checks, if we're in the short state of "an Article has been removed"
+     * We check by looking for the "'removeBtn' is not null", as a sign for it has been triggered/ clicked
+     * if that doesn't work, we check if there's an Article in the Products array, that has "'am' = 0"
+     * Which also shows we're in that state rn
+     */
+    protected function isArticleRemovedState(array $productsArray) :bool
+    {
+        if (Registry::getRequest()->getRequestEscapedParameter('removeBtn')
+            or Registry::getRequest()->getRequestEscapedParameter('updateBtn')
+        ){
+            return true;
+        }else{
+            foreach ($productsArray as $aProduct) {
+                if (intval($aProduct['am']) === 0) {
+                    return true;
+                }
+            }
+        }
+
+        return false;
+    }
+}

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/Application/Model/Manufacturer.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace D3\GoogleAnalytics4\Modules\Application\Model;
+
+class Manufacturer extends Manufacturer_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,9 +12,15 @@
 
 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;
+use Psr\Container\ContainerExceptionInterface;
+use Psr\Container\NotFoundExceptionInterface;
 
 class ViewConfig extends ViewConfig_parent
 {
@@ -27,59 +33,31 @@ class ViewConfig extends ViewConfig_parent
     {
         if ($this->sContainerId === null)
         {
-            $this->sContainerId = $this->getConfig()->getConfigParam('d3_gtm_sContainerID');
+            $this->sContainerId = ContainerFactory::getInstance()
+                                                  ->getContainer()
+                                                  ->get(ModuleSettingBridgeInterface::class)
+                                                  ->get('d3_gtm_sContainerID', 'd3googleanalytics4');
         }
         return $this->sContainerId;
     }
 
     /**
-     * @return mixed
+     * @return void
      */
-    public function getModuleSettingExplicitManagerSelectValue()
-    {
-        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()
+    public function defineCookieManagerType() :void
     {
         if ($this->sCookieManagerType === null)
         {
-            $this->sCookieManagerType = false;
-
-            $allowedManagerTypes = [
-                'net_cookie_manager',
-                'agcookiecompliance',
-                'oxps_usercentrics'
-            ];
-
-            foreach ($allowedManagerTypes as $type) {
-                if ($this->isModuleActive($type)) {
-                    $this->sCookieManagerType = $type;
-                    break;
-                }
-            }
+            /** @var ManagerHandler $oManagerHandler */
+            $oManagerHandler = oxNew(ManagerHandler::class);
+            $this->sCookieManagerType = $oManagerHandler->getCurrManager();
         }
-
-        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 +71,44 @@ 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_controlParameter'));
 
         // 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::COOKIEBOT
+            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,33 +117,33 @@ class ViewConfig extends ViewConfig_parent
      * This is especially important for UserCentrics.
      * @return string
      */
-    public function getGtmScriptAttributes()
+    public function getGtmScriptAttributes() :string
     {
-        $oConfig = Registry::getConfig();
+        $sControlParameter = trim(Registry::getConfig()->getConfigParam('d3_gtm_settings_controlParameter'));
 
-        if (false === $this->shallUseOwnCookieManager()){
+        if (false === $this->shallUseOwnCookieManager() or ($sControlParameter === '')){
             return "";
         }
 
-        if ($this->getCookieManagerType() === "oxps_usercentrics" or $this->getExplicitManager() === 'USERCENTRICS') {
-            $sCookieId = $oConfig->getConfigParam('d3_gtm_settings_cookieName');
-
-            if ($sCookieId) {
-                return 'data-usercentrics="' . $sCookieId . '" type="text/plain" async=""';
-            }
+        if (
+            $this->sCookieManagerType === ManagerTypes::USERCENTRICS_MODULE
+            or $this->sCookieManagerType === ManagerTypes::USERCENTRICS_MANUALLY
+        )
+        {
+            return 'data-usercentrics="' . $sControlParameter . '" type="text/plain" async=""';
         }
 
-        if ($this->getCookieManagerType() === "externalService" and $this->getExplicitManager() === 'CONSENTMANAGER') {
-            $sCookieId = $oConfig->getConfigParam('d3_gtm_settings_cookieName');
+        if ($this->sCookieManagerType === ManagerTypes::CONSENTMANAGER)
+        {
+            return 'type="text/plain" class="cmplazyload" data-cmp-vendor="'.$sControlParameter.'"';
+        }
 
-            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"
-                        ';
-            }
+        if ($this->sCookieManagerType === ManagerTypes::COOKIEFIRST){
+            return 'type="text/plain" data-cookiefirst-category="' . $sControlParameter .'"';
+        }
+
+        if ($this->sCookieManagerType === ManagerTypes::COOKIEBOT){
+            return 'type="text/plain" data-cookieconsent="' . $sControlParameter .'"';
         }
 
         return "";
@@ -162,11 +151,18 @@ class ViewConfig extends ViewConfig_parent
 
     private $blGA4enabled = null;
 
+    /**
+     * @throws ContainerExceptionInterface
+     * @throws NotFoundExceptionInterface
+     */
     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;
@@ -209,6 +205,11 @@ class ViewConfig extends ViewConfig_parent
         return json_encode([$dataLayer], JSON_PRETTY_PRINT);
     }
 
+    public function isDebugModeOn() :bool
+    {
+        return Registry::getConfig()->getConfigParam('d3_gtm_blEnableDebug');
+    }
+
     public function isPromotionList($listId)
     {
         $oConfig           = Registry::getConfig();

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

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

@@ -1,5 +1,14 @@
 <?php
+
+use D3\GoogleAnalytics4\Modules\Application\Controller\BasketController;
+use D3\GoogleAnalytics4\Modules\Application\Model\Basket as Basket;
+use D3\GoogleAnalytics4\Modules\Application\Model\Category as Category;
+use D3\GoogleAnalytics4\Modules\Application\Model\Manufacturer as Manufacturer;
 use D3\GoogleAnalytics4\Modules\Core\ViewConfig;
+use OxidEsales\Eshop\Application\Controller\BasketController as OEBasketController;
+use OxidEsales\Eshop\Application\Model\Basket as OEBasket;
+use OxidEsales\Eshop\Application\Model\Category as OECategory;
+use OxidEsales\Eshop\Application\Model\Manufacturer as OEManufacturer;
 use OxidEsales\Eshop\Core\ViewConfig as OEViewConfig;
 
 $sMetadataVersion = '2.1';
@@ -17,19 +26,18 @@ $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.8.0',
+    'version'     => '2.13.1',
     '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,
+        OEManufacturer::class => Manufacturer::class,
+        OEBasket::class => Basket::class,
+        OEBasketController::class => BasketController::class
     ],
+    'templates'   => [],
     'blocks'      => [
         // tag manager js
         [
@@ -55,12 +63,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 +82,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
@@ -83,6 +91,13 @@ $aModule          = [
             'block'    => 'details_productmain_tobasket',
             'file'     => '/Application/views/ga4/add_to_cart.tpl',
             'position' => 150
+        ],
+        // remove_from_cart
+        [
+            'template' => 'page/checkout/basket.tpl',
+            'block'    => 'checkout_basket_main',
+            'file'     => '/Application/views/ga4/remove_from_cart.tpl',
+            'position' => 150
         ]
     ],
     'settings'    => [
@@ -116,9 +131,9 @@ $aModule          = [
         ],
         [
             'group'    => 'd3_gtm_settings_cookiemanager',
-            'name'     => 'd3_gtm_settings_cookieName',
+            'name'     => 'd3_gtm_settings_controlParameter',
             'type'     => 'str',
-            'value'    => 'example',
+            'value'    => '',
             'position' => 999
         ],
         [
@@ -126,7 +141,7 @@ $aModule          = [
             'name' => 'd3_gtm_settings_HAS_STD_MANAGER',
             'type' => 'select',
             'value' => 'none',
-            'constraints' => 'NONE|CONSENTMANAGER|USERCENTRICS',
+            'constraints' => 'NONE|CONSENTMANAGER|USERCENTRICS|COOKIEFIRST|COOKIEBOT',
         ],
     ]
 ];