bump metadata and readme

Application/Model/ManagerTypes.php

@@ -36,6 +36,8 @@ class ManagerTypes
 
     const COOKIEFIRST               = "COOKIEFIRST";
 
+    const COOKIEBOT               = "COOKIEBOT";
+
     /**
      * @return array
      */
@@ -48,7 +50,8 @@ class ManagerTypes
             "oxps_usercentrics"     => self::USERCENTRICS_MODULE,
             "usercentrics"          => self::USERCENTRICS_MANUALLY,
             "consentmanager"        => self::CONSENTMANAGER,
-            "cookiefirst"        => self::COOKIEFIRST
+            "cookiefirst"           => self::COOKIEFIRST,
+            "cookiebot"             => self::COOKIEBOT,
         ];
     }
 

Application/views/admin/de/module_options.php

@@ -43,5 +43,11 @@ $aLang = [
     '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',
+    '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/purchase.tpl

@@ -1,51 +1,56 @@
 [{$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()}]
+[{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()}]
+            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}]
-            ]
-        }
-    })
-</script>
-[{/strip}]
+                            {
+                                '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

@@ -5,40 +5,46 @@
 [{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')}]',
-                        [{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}]
-                ]
-        }
-    });
-[{/capture}][{/strip}]
-[{oxscript add=$d3_ga4_view_cart}]
+[{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,31 +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. */
+[{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()}]
-        }
-      ]
-    }
-  });
-</script>
+      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

@@ -6,43 +6,47 @@
 [{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) {
-  dataLayer.push({"event": null, "eventLabel": null, "ecommerce": null});  /* Clear the previous ecommerce object. */
+[{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}]',
-        [{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
-        }
-      ]
-      }
-    });
-  });
-  [{/block}]
+        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}]
+  [{oxscript add=$d3_ga4_add_to_cart}]
+[{/block}]

Application/views/ga4/remove_from_cart.tpl

@@ -1,12 +1,13 @@
 [{$smarty.block.parent}]
 
-[{assign var="d3BasketPrice" value=$oxcmp_basket->getPrice()}]
-
-[{if $hasBeenReloaded}]
-    [{strip}]
-            [{capture assign=d3_ga4_view_cart}]
+[{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': {
@@ -36,9 +37,12 @@
                             }[{if !$smarty.foreach.gtmRemovedItems.last}],[{/if}]
                             [{/foreach}]
                         ]
-                    }
+                    }[{if $oViewConf->isDebugModeOn()}],
+                    'debug_mode': 'true'
+                    [{/if}]
                 });
-            [{/capture}]
-    [{/strip}]
-    [{oxscript add=$d3_ga4_view_cart}]
-[{/if}]
+            [{/strip}]
+        [{/capture}]
+        [{oxscript add=$d3_ga4_remove_from_cart}]
+    [{/if}]
+[{/block}]

Application/views/ga4/view_item_list.tpl

@@ -4,39 +4,43 @@
 
 [{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}]',
-                        [{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}]
-                ]
-            }
-        });
-    </script>
-[{/strip}]
-[{/if}]
+[{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

@@ -2,38 +2,43 @@
 
 [{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()}]
-            [{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}]
-          ]
-        }
-      });
-    </script>
-  [{/strip}]
-[{/if}]
+[{block name="d3_ga4_view_search_result_block"}]
+  [{if $gtmProducts|@count}]
+    [{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,31 @@ 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.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"

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
@@ -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
@@ -73,4 +83,7 @@ Aktivieren Sie anschließend diese Weiche. Setzen Sie den Haken bei "Eigenen Coo
     - 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
+        ```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.

Modules/Application/Controller/BasketController.php

@@ -52,7 +52,8 @@ class BasketController extends BasketController_parent
 
             $sBasketItemId = Registry::getRequest()->getRequestEscapedParameter('bindex');
 
-            $aProducts[$sProductId] = ['am'           => $dAmount,
+            $aProducts[$sProductId] = [
+                'am'           => $dAmount,
                 'sel'          => $aSel,
                 'persparam'    => $aPersParam,
                 'basketitemid' => $sBasketItemId
@@ -63,9 +64,7 @@ class BasketController extends BasketController_parent
             $toRemoveArticleIdList = [];
             $artIdOnArtAmountList = [];
 
-            if (Registry::getRequest()->getRequestEscapedParameter('removeBtn') !== null
-                or Registry::getRequest()->getRequestParameter('updateBtn') !== null) {
-
+            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) {
@@ -100,4 +99,29 @@ class BasketController extends BasketController_parent
             $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/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

@@ -19,6 +19,8 @@ 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
 {
@@ -75,7 +77,7 @@ class ViewConfig extends ViewConfig_parent
 
         $this->defineCookieManagerType();
 
-        $sCookieID = trim($oConfig->getConfigParam('d3_gtm_settings_cookieName'));
+        $sCookieID = trim($oConfig->getConfigParam('d3_gtm_settings_controlParameter'));
 
         // Netensio Cookie Manager
         if ($this->sCookieManagerType === ManagerTypes::NET_COOKIE_MANAGER) {
@@ -98,6 +100,7 @@ class ViewConfig extends ViewConfig_parent
             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
         )
         {
@@ -116,9 +119,9 @@ class ViewConfig extends ViewConfig_parent
      */
     public function getGtmScriptAttributes() :string
     {
-        $sCookieId = trim(Registry::getConfig()->getConfigParam('d3_gtm_settings_cookieName'));
+        $sControlParameter = trim(Registry::getConfig()->getConfigParam('d3_gtm_settings_controlParameter'));
 
-        if (false === $this->shallUseOwnCookieManager()){
+        if (false === $this->shallUseOwnCookieManager() or ($sControlParameter === '')){
             return "";
         }
 
@@ -127,25 +130,20 @@ class ViewConfig extends ViewConfig_parent
             or $this->sCookieManagerType === ManagerTypes::USERCENTRICS_MANUALLY
         )
         {
-            if ($sCookieId) {
-                return 'data-usercentrics="' . $sCookieId . '" type="text/plain" async=""';
-            }
+            return 'data-usercentrics="' . $sControlParameter . '" type="text/plain" async=""';
         }
 
         if ($this->sCookieManagerType === ManagerTypes::CONSENTMANAGER)
         {
-            if ($sCookieId) {
-                return 'async 
-                        type="text/plain"
-                        data-cmp-src="https://www.googletagmanager.com/gtm.js?id='.$this->getGtmContainerId().'"
-                        class="cmplazyload"
-                        data-cmp-vendor="s905"
-                        ';
-            }
+            return 'type="text/plain" class="cmplazyload" data-cmp-vendor="'.$sControlParameter.'"';
         }
 
         if ($this->sCookieManagerType === ManagerTypes::COOKIEFIRST){
-            return 'type="text/plain" data-cookiefirst-category="' . $sCookieId .'"';
+            return 'type="text/plain" data-cookiefirst-category="' . $sControlParameter .'"';
+        }
+
+        if ($this->sCookieManagerType === ManagerTypes::COOKIEBOT){
+            return 'type="text/plain" data-cookieconsent="' . $sControlParameter .'"';
         }
 
         return "";
@@ -153,6 +151,10 @@ class ViewConfig extends ViewConfig_parent
 
     private $blGA4enabled = null;
 
+    /**
+     * @throws ContainerExceptionInterface
+     * @throws NotFoundExceptionInterface
+     */
     public function isGA4enabled()
     {
         if ($this->blGA4enabled === null)
@@ -203,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();

metadata.php

@@ -3,10 +3,12 @@
 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';
@@ -24,13 +26,14 @@ $aModule          = [
                       Die Entwicklung basiert auf einem Fork von Marat Bedoev - <a href='https://github.com/vanilla-thunder/oxid-module-gtm'>Github-Link</a>
                       ",
     'thumbnail'   => 'thumbnail.png',
-    'version'     => '2.10.0',
+    'version'     => '2.13.0',
     'author'      => 'Data Development (Inh.: Thomas Dartsch)',
     'email'       => 'support@shopmodule.com',
     'url'         => 'https://www.oxidmodule.com/',
     'extend'      => [
         OEViewConfig::class => ViewConfig::class,
         OECategory::class => Category::class,
+        OEManufacturer::class => Manufacturer::class,
         OEBasket::class => Basket::class,
         OEBasketController::class => BasketController::class
     ],
@@ -128,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
         ],
         [
@@ -138,7 +141,7 @@ $aModule          = [
             'name' => 'd3_gtm_settings_HAS_STD_MANAGER',
             'type' => 'select',
             'value' => 'none',
-            'constraints' => 'NONE|CONSENTMANAGER|USERCENTRICS|COOKIEFIRST',
+            'constraints' => 'NONE|CONSENTMANAGER|USERCENTRICS|COOKIEFIRST|COOKIEBOT',
         ],
     ]
 ];