[Changed] trigger and payment receiving

false value given for important decision-making. Since the value was false, we got "false" as return for D3blShowGtmScript() which made consentmanager not send the data to GTM

Application/Model/ManagerTypes.php

@@ -7,19 +7,25 @@ use D3\GoogleAnalytics4\Application\Model\CMP\Usercentrics;
 class ManagerTypes
 {
     const EXTERNAL_SERVICE          = "eigener Service";
+    const INTERNAL_EXTERNAL_SERVICE          = "externalService";
     const NET_COOKIE_MANAGER        = "Netensio Cookie Manager";
+    const INTERNAL_NET_COOKIE_MANAGER        = "net_cookie_manager";
 
     /**
      * Further information's:
      * https://github.com/aggrosoft/oxid-cookie-compliance
      */
     const AGCOOKIECOMPLIANCE        = "Aggrosoft Cookie Compliance";
+    const INTERNAL_AGCOOKIECOMPLIANCE        = "agcookiecompliance";
 
     const CONSENTMANAGER            = "Consentmanager";
+    const INTERNAL_CONSENTMANAGER            = "cmconsentmanager";
 
     const COOKIEFIRST               = "Cookiefirst";
+    const INTERNAL_COOKIEFIRST               = "cookiefirst";
 
     const COOKIEBOT                 = "Cookiebot";
+    const INTERNAL_COOKIEBOT                 = "cookiebot";
 
     /**
      * @return array
@@ -27,14 +33,14 @@ class ManagerTypes
     public function getManagerList(): array
     {
         return [
-            "externalService"       => self::EXTERNAL_SERVICE,
-            "agcookiecompliance"    => self::AGCOOKIECOMPLIANCE,
-            "net_cookie_manager"    => self::NET_COOKIE_MANAGER,
+            self::INTERNAL_EXTERNAL_SERVICE       => self::EXTERNAL_SERVICE,
+            self::INTERNAL_AGCOOKIECOMPLIANCE    => self::AGCOOKIECOMPLIANCE,
+            self::INTERNAL_NET_COOKIE_MANAGER    => self::NET_COOKIE_MANAGER,
             Usercentrics::sModuleIncludationInternalName    => Usercentrics::sModuleIncludationPublicName,
             Usercentrics::sExternalIncludationInternalName  => Usercentrics::sExternalIncludationPublicName,
-            "cmconsentmanager"      => self::CONSENTMANAGER,
-            "cookiefirst"           => self::COOKIEFIRST,
-            "cookiebot"             => self::COOKIEBOT,
+            self::INTERNAL_CONSENTMANAGER      => self::CONSENTMANAGER,
+            self::INTERNAL_COOKIEFIRST           => self::COOKIEFIRST,
+            self::INTERNAL_COOKIEBOT             => self::COOKIEBOT,
         ];
     }
 
@@ -46,4 +52,21 @@ class ManagerTypes
     {
         return in_array($sManager, array_keys($this->getManagerList()), true);
     }
+	
+	/**
+	 * @return array
+	 *
+	 * the CMP from this method always needs the script tag delivered to the dom.
+	 */
+	public function scriptTagDeliveredByDefaultArray() :array
+	{
+		return [
+			Usercentrics::sModuleIncludationInternalName,
+			Usercentrics::sExternalIncludationInternalName,
+			ManagerTypes::INTERNAL_CONSENTMANAGER,
+			ManagerTypes::INTERNAL_COOKIEFIRST,
+			ManagerTypes::INTERNAL_COOKIEBOT,
+			ManagerTypes::INTERNAL_EXTERNAL_SERVICE
+		];
+	}
 }

Application/views/admin/tpl/d3googleanalytics4_main.tpl

@@ -80,7 +80,6 @@
                                             [{oxmultilang ident="D3CMP"}]
                                         </label>
                                         <select class="form-select w-50" name="editval[select][_HAS_STD_MANAGER]" aria-label="Default select example">
-                                            <option value="NONE" selected>[{oxmultilang ident="D3NONE"}]</option>
                                             [{foreach from=$d3ManagerTypeArray key="sInternalName" item="sPublicName" name="editval[aCmpNameArray]"}]
                                             <option value="[{$sInternalName}]" [{if $sInternalName === $d3CurrentCMP}]SELECTED[{/if}]>[{$sPublicName}]</option>
                                             [{/foreach}]

Application/views/event/add_payment_info.tpl

@@ -3,49 +3,54 @@
 [{assign var="gtmBasketPrice" value=$oxcmp_basket->getPrice()}]
 [{assign var="gtmBasketObject" value=$oxcmp_basket}]
 [{assign var='gtmCartArticles' value=$gtmBasketObject->getBasketArticles()}]
-[{assign var="gtmPaymentObject" value=$oView->getPayment()}]
 
 [{block name="gtm_ga4_add_payment_info_block"}]
     [{capture name="gtm_ga4_add_payment_info"}]
         [{strip}]
-            dataLayer.push({"event": null, "eventLabel": null, "ecommerce": null});  /* Clear the previous ecommerce object. */
-            dataLayer.push({
-            'event': 'add_payment_info',
-            'eventLabel':'Checkout - Payment info',
-            'payment_type':'[{$gtmPaymentObject->gtmGetSelectedPaymentName()}]',
-            'ecommerce':
-            {
-                'actionField': "Payment-Info",
-                'currency': "[{$currency->name}]",
-                'value': [{$gtmBasketPrice->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="gtmItemPriceObject" value=$basketitem->getPrice()}]
-                    [{assign var="gtmBasketItem" value=$basketitem->getArticle()}]
-                    [{assign var="gtmBasketItemCategory" value=$gtmBasketItem->getCategory()}]
+            $(document).ready(function() {
+                $('#orderStep, #paymentNextStepBottom').on('click', function() {
+                    let selectedPaymentMethod = document.querySelector('input[type="radio"]:checked');
+
+                    dataLayer.push({"event": null, "eventLabel": null, "ecommerce": null});  /* Clear the previous ecommerce object. */
+                    dataLayer.push({
+                    'event': 'add_payment_info',
+                    'eventLabel':'Checkout - Payment info',
+                    'payment_type': selectedPaymentMethod.value,
+                    'ecommerce':
                     {
-                    '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, true)}]',
-                    'item_category_2':  '[{$gtmBasketItemCategory->getSplitCategoryArray(1, true)}]',
-                    'item_category_3':  '[{$gtmBasketItemCategory->getSplitCategoryArray(2, true)}]',
-                    'item_category_4':  '[{$gtmBasketItemCategory->getSplitCategoryArray(3, true)}]',
-                    'item_list_name':   '[{$gtmBasketItemCategory->getSplitCategoryArray()}]',
+                        'actionField': "Payment-Info",
+                        'currency': "[{$currency->name}]",
+                        'value': [{$gtmBasketPrice->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="gtmItemPriceObject" 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, true)}]',
+                            'item_category_2':  '[{$gtmBasketItemCategory->getSplitCategoryArray(1, true)}]',
+                            'item_category_3':  '[{$gtmBasketItemCategory->getSplitCategoryArray(2, true)}]',
+                            'item_category_4':  '[{$gtmBasketItemCategory->getSplitCategoryArray(3, true)}]',
+                            'item_list_name':   '[{$gtmBasketItemCategory->getSplitCategoryArray()}]',
+                            [{/if}]
+                            'price':            [{$gtmItemPriceObject->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}]
-                    'price':            [{$gtmItemPriceObject->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}]

CHANGELOG.md

@@ -6,6 +6,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [unreleased](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.17.2...rel_2.x) - 2024-x
 
+## [2.22.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.21.0...2.22.0) - 2024-09-21
+### Fixed
+- Consentmanager didn't get delivered
+### Changed
+- write "internal_names" of CMP to constants
+
 ## [2.21.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.20.1...2.21.0) - 2024-09-19
 ### Fixed
 - missing parameters for widget.php call

Modules/Core/ViewConfig.php

@@ -88,7 +88,7 @@ class ViewConfig extends ViewConfig_parent
         $sCookieID = trim($this->d3GetModuleConfigParam('_sControlParameter'));
 
         // Netensio Cookie Manager
-        if ($this->sCookieManagerType === ManagerTypes::NET_COOKIE_MANAGER) {
+        if ($this->sCookieManagerType === ManagerTypes::INTERNAL_NET_COOKIE_MANAGER) {
             $oSession = Registry::getSession();
             $aCookies = $oSession->getVariable("aCookieSel");
 
@@ -96,20 +96,18 @@ class ViewConfig extends ViewConfig_parent
         }
 
         // Aggrosoft Cookie Consent
-        if ($this->sCookieManagerType === ManagerTypes::AGCOOKIECOMPLIANCE) {
+        if ($this->sCookieManagerType === ManagerTypes::INTERNAL_AGCOOKIECOMPLIANCE) {
             if (method_exists($this, "isCookieCategoryEnabled")) {
                 return $this->isCookieCategoryEnabled($sCookieID);
             }
         }
-
-        // UserCentrics or consentmanager
+		
         if (
-            $this->sCookieManagerType       === Usercentrics::sModuleIncludationInternalName
-            or $this->sCookieManagerType    === Usercentrics::sExternalIncludationInternalName
-            or $this->sCookieManagerType    === ManagerTypes::CONSENTMANAGER
-            or $this->sCookieManagerType    === ManagerTypes::COOKIEFIRST
-            or $this->sCookieManagerType    === ManagerTypes::COOKIEBOT
-            or $this->sCookieManagerType    === ManagerTypes::EXTERNAL_SERVICE
+	        in_array
+	        (
+				$this->sCookieManagerType,
+				(oxNew(ManagerTypes::class)->scriptTagDeliveredByDefaultArray())
+	        )
         )
         {
             // Always needs the script-tags delivered to the DOM.
@@ -141,16 +139,16 @@ class ViewConfig extends ViewConfig_parent
             return 'data-usercentrics="' . $sControlParameter . '" type="text/plain" async=""';
         }
 
-        if ($this->sCookieManagerType === ManagerTypes::CONSENTMANAGER)
+        if ($this->sCookieManagerType === ManagerTypes::INTERNAL_CONSENTMANAGER)
         {
             return 'type="text/plain" class="cmplazyload" data-cmp-vendor="'.$sControlParameter.'"';
         }
 
-        if ($this->sCookieManagerType === ManagerTypes::COOKIEFIRST){
+        if ($this->sCookieManagerType === ManagerTypes::INTERNAL_COOKIEFIRST){
             return 'type="text/plain" data-cookiefirst-category="' . $sControlParameter .'"';
         }
 
-        if ($this->sCookieManagerType === ManagerTypes::COOKIEBOT){
+        if ($this->sCookieManagerType === ManagerTypes::INTERNAL_COOKIEBOT){
             return 'type="text/plain" data-cookieconsent="' . $sControlParameter .'"';
         }
 

metadata.php

@@ -52,7 +52,7 @@ $aModule = [
                       Die Entwicklung basiert auf einem Fork von Marat Bedoev - <a href='https://github.com/vanilla-thunder/oxid-module-gtm'>Github-Link</a>
                       ",
     'thumbnail' => 'thumbnail.png',
-    'version' => '2.21.0',
+    'version' => '2.22.0',
     'author' => 'Data Development (Inh.: Thomas Dartsch)',
     'email' => 'support@shopmodule.com',
     'url' => 'https://www.oxidmodule.com/',
@@ -193,8 +193,8 @@ $aModule = [
         // We add it into checkout_order_main ( checkout/order.tpl ) to make sure a payment is actually added;
         // we'll also do it like that in the future for add_shipping_info ( not planed yet )
         [
-            'template' => 'page/checkout/order.tpl',
-            'block' => 'checkout_order_main',
+	        'template' => 'page/checkout/payment.tpl',
+	        'block' => 'checkout_payment_main',
             'file' => '/Application/views/blocks/add_payment_info.tpl',
             'position' => 150
         ],