[Bump] Metadata && Changelog

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/Component/Widget/d3GtmStartWidget.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace D3\GoogleAnalytics4\Application\Component\Widget;
+
+class d3GtmStartWidget extends \OxidEsales\Eshop\Application\Component\Widget\WidgetController
+{
+    public function render()
+    {
+        parent::render();
+
+        return '';
+    }
+}

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

@@ -36,7 +36,7 @@
                     'item_category_4':  '[{$gtmBasketItemCategory->getSplitCategoryArray(3, true)}]',
                     'item_list_name':   '[{$gtmBasketItemCategory->getSplitCategoryArray()}]',
                     [{/if}]
-                    'price':            [{$gtmItemPriceObject->getPrice()}],
+                    [{oxhasrights ident="SHOWARTICLEPRICE"}]'price':            [{$gtmItemPriceObject->getPrice()}],[{/oxhasrights}]
                     '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}]

Application/views/event/add_to_cart.tpl

@@ -37,7 +37,7 @@
             {
               'item_id':        '[{$oGtmProduct->getFieldData('oxartnum')}]',
               'item_name':      '[{$oGtmProduct->getFieldData('oxtitle')}]',
-              'price':          [{$d3PriceObject->getPrice()}],
+              [{oxhasrights ident="SHOWARTICLEPRICE"}]'price':          [{$d3PriceObject->getPrice()}],[{/oxhasrights}]
               'item_brand':     '[{if $gtmManufacturer}][{$gtmManufacturer->oxmanufacturers__oxtitle->value}][{/if}]',
               'item_variant':   '[{if $oGtmProduct->getFieldData('oxvarselect')}][{$oGtmProduct->getFieldData('oxvarselect')}][{/if}]',
               [{if $gtmCategory}]

Application/views/event/begin_checkout.tpl

@@ -3,6 +3,7 @@
 [{assign var="d3BasketPrice" value=$oxcmp_basket->getPrice()}]
 [{assign var="d3BasketObject" value=$oxcmp_basket}]
 [{assign var='gtmCartArticles' value=$d3BasketObject->getBasketArticles()}]
+[{assign var="gtmCurrency"      value=$oView->getActCurrency()}]
 
 [{block name="d3_ga4_begin_checkout_block"}]
     [{capture name="d3_ga4_begin_checkout"}]
@@ -14,7 +15,7 @@
             'ecommerce':
             {
             'actionField': "Begin",
-            'currency': "[{$currency->name}]",
+            'currency': "[{$gtmCurrency->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':
@@ -34,7 +35,7 @@
             'item_category_4':  '[{$gtmBasketItemCategory->getSplitCategoryArray(3, true)}]',
             'item_list_name':   '[{$gtmBasketItemCategory->getSplitCategoryArray()}]',
             [{/if}]
-            'price':            [{$d3oItemPrice->getPrice()}],
+            [{oxhasrights ident="SHOWARTICLEPRICE"}]'price':            [{$d3oItemPrice->getPrice()}],[{/oxhasrights}]
             '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}]

Application/views/event/purchase.tpl

@@ -40,7 +40,7 @@
                             'item_category_4':  '[{$gtmPurchaseItemCategory->getSplitCategoryArray(3, true)}]',
                             'item_list_name':   '[{$gtmPurchaseItemCategory->getSplitCategoryArray()}]',
                             [{/if}]
-                            'price':            [{$gtmPurchaseItemPriceObject->getPrice()}],
+                            [{oxhasrights ident="SHOWARTICLEPRICE"}]'price':            [{$gtmPurchaseItemPriceObject->getPrice()}],[{/oxhasrights}]
                             'quantity':         [{$gtmBasketItem->getFieldData("oxamount")}],
                             'position':         [{$smarty.foreach.gtmArticles.iteration}]
                         }[{if !$smarty.foreach.gtmArticles.last}],[{/if}]

Application/views/event/remove_from_cart.tpl

@@ -28,7 +28,7 @@
                             'item_category_4':  '[{$gtmBasketItemCategory->getSplitCategoryArray(3, true)}]',
                             'item_list_name':   '[{$gtmBasketItemCategory->getSplitCategoryArray()}]',
                             [{/if}]
-                            'price':            [{$d3oItemPrice->getPrice()}],
+                            [{oxhasrights ident="SHOWARTICLEPRICE"}]'price':            [{$d3oItemPrice->getPrice()}],[{/oxhasrights}]
                             '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}]

Application/views/event/view_cart.tpl

@@ -33,7 +33,7 @@
                             'item_category_4':  '[{$gtmBasketItemCategory->getSplitCategoryArray(3, true)}]',
                             'item_list_name':   '[{$gtmBasketItemCategory->getSplitCategoryArray()}]',
                             [{/if}]
-                            'price':            [{$d3oItemPrice->getPrice()}],
+                            [{oxhasrights ident="SHOWARTICLEPRICE"}]'price':            [{$d3oItemPrice->getPrice()}],[{/oxhasrights}]
                             '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}]

Application/views/event/view_item.tpl

@@ -28,7 +28,7 @@
                                 'item_list_name':'[{$gtmCategory->getSplitCategoryArray()}]',
                                 [{/if}]
                                 [{assign var="d3PriceObject" value=$gtmProduct->getPrice()}]
-                                'price': [{$d3PriceObject->getPrice()}]
+                                [{oxhasrights ident="SHOWARTICLEPRICE"}]'price': [{$d3PriceObject->getPrice()}][{/oxhasrights}]
                             }
                         ]
                 }[{if $oViewConf->isDebugModeOn()}],

Application/views/event/view_item_list.tpl

@@ -22,7 +22,7 @@
                             {
                                 'item_id': '[{$gtmProduct->getFieldData("oxartnum")}]',
                                 'item_name': '[{$gtmProduct->getFieldData("oxtitle")}]',
-                                'price': [{$d3PriceObject->getPrice()}],
+                                [{oxhasrights ident="SHOWARTICLEPRICE"}]'price': [{$d3PriceObject->getPrice()}],[{/oxhasrights}]
                                 'item_brand': '[{if $gtmManufacturer}][{$gtmManufacturer->oxmanufacturers__oxtitle->value}][{/if}]',
                                 [{if $gtmCategory}]
                                 'item_category':  '[{$gtmCategory->getSplitCategoryArray(0, true)}]',

Application/views/event/view_search_result.tpl

@@ -18,7 +18,7 @@
               {
                 'item_id': '[{$gtmProduct->getFieldData("oxartnum")}]',
                 'item_name': '[{$gtmProduct->getFieldData("oxtitle")}]',
-                'price': [{$d3PriceObject->getPrice()}],
+                [{oxhasrights ident="SHOWARTICLEPRICE"}]'price': [{$d3PriceObject->getPrice()}],[{/oxhasrights}]
                 'item_brand': '[{if $gtmManufacturer}][{$gtmManufacturer->oxmanufacturers__oxtitle->value}][{/if}]',
                 [{if $gtmCategory}]
                 'item_category':  '[{$gtmCategory->getSplitCategoryArray(0, true)}]',

Application/views/ga4/remove_from_cart.tpl

@@ -30,7 +30,7 @@
                             'item_category_4':  '[{$gtmBasketItemCategory->getSplitCategoryArray(3)}]',
                             'item_list_name':   '[{$gtmBasketItemCategory->getSplitCategoryArray()}]',
                             [{/if}]
-                            'price':            [{$d3oItemPrice->getPrice()}],
+                            [{oxhasrights ident="SHOWARTICLEPRICE"}]'price':            [{$d3oItemPrice->getPrice()}],[{/oxhasrights}]
                             '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}]

Application/views/ga4/view_search_result.tpl

@@ -20,7 +20,7 @@
               {
                 'item_id': '[{$gtmProduct->getFieldData("oxartnum")}]',
                 'item_name': '[{$gtmProduct->getFieldData("oxtitle")}]',
-                'price': [{$d3PriceObject->getPrice()}],
+                [{oxhasrights ident="SHOWARTICLEPRICE"}]'price': [{$d3PriceObject->getPrice()}],[{/oxhasrights}]
                 'item_brand': '[{if $gtmManufacturer}][{$gtmManufacturer->oxmanufacturers__oxtitle->value}][{/if}]',
                 [{if $gtmCategory}]
                 'item_category':  '[{$gtmCategory->getSplitCategoryArray(0)}]',

CHANGELOG.md

@@ -4,8 +4,28 @@ 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).
 
-## [unreleased](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.17.2...rel_2.x) - 2024-x
+## [unreleased](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.22.0...rel_2.x) - 2024-x
+### Added
+- data layer doesn't contain prices if current user hasn't "show price" rights
 
+## [2.23.0.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.22.0...2.23.0.0) - 2024-12-21
+### Added
+- another tag-versioning position
+- additional global variables, if given
+
+## [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
+
+## [2.20.1](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.20.0...2.20.1) - 2024-09-11
+### Fixed
+- missing currency name in begin_checkout template
 ## [2.20.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.19.0...2.20.0) - 2024-08-20
 ### Added
 - new event "begin_checkout"

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 .'"';
         }
 
@@ -210,9 +208,33 @@ class ViewConfig extends ViewConfig_parent
             //'httpref'   => $_SERVER["HTTP_REFERER"] ?? "unknown"
         ];
 		
+		$dataLayer = $this->d3AdditionalGlobalAnalyticsVariables($dataLayer);
+
         return json_encode([$dataLayer], JSON_PRETTY_PRINT);
     }
 	
+	/**
+	 * @param array $dataLayerGlobals
+	 * @return array
+	 */
+	public function d3AdditionalGlobalAnalyticsVariables(array $dataLayerGlobals) :array
+	{
+		/** @var User $oUser */
+		$oUser  = Registry::getSession()->getUser();
+		if ($oUser and $oUser->getFieldData('OXUSERNAME')){
+			$sUsername 	= $oUser->getFieldData('OXUSERNAME') ?: "";
+			$iCustNr 			= $oUser->getFieldData('OXCUSTNR') ?: "";
+			$iZipCode 		= $oUser->getFieldData('OXZIP') ?: "";
+			
+			return array_merge($dataLayerGlobals, [
+				'custnr'		=> $iCustNr,
+				'email' 		=> $sUsername,
+				'zipcode' 	=> $iZipCode
+			]);
+		}
+		return $dataLayerGlobals;
+	}
+	
     public function isDebugModeOn() :bool
     {
         return $this->d3GetModuleConfigParam("_blEnableDebug")?: false;

Modules/Core/WidgetControl.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace D3\GoogleAnalytics4\Modules\Core;
+
+use OxidEsales\EshopCommunity\Core\Registry;
+
+class WidgetControl extends WidgetControl_parent{
+    protected function getFrontendStartControllerKey() // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore
+    {
+        /*
+         * array (
+          'force_sid' => '2pistlaubiq58qtg3moudei0la',
+          'lang' => '0',
+          'actcontrol' => 'details',
+          'anid' => '064471',
+          'cl' => 'oxwarticledetails',
+          'cnid' => '159dd0f2fb2bd6e24ace53a0f1913797',
+          'listtype' => 'list',
+          'nocookie' => '1',
+          'oxwparent' => 'details',
+          'sid' => '2pistlaubiq58qtg3moudei0la',
+          'stoken' => 'A22D0F9E',
+          'varselid' =>
+          array (
+            0 => 'b842982bf522aa839bd88221f562fce8',
+          ),
+        )
+         */
+        $sScriptName = $_SERVER['SCRIPT_NAME'];
+        if($sScriptName !== '/widget.php')
+        {
+            return parent::getFrontendStartControllerKey();
+        }
+
+        $aParameter = $_GET;
+        if(is_null($aParameter['actcontrol']) and is_null($aParameter['oxwparent']))
+        {
+            return 'D3\GoogleAnalytics4\Application\Component\Widget\d3GtmStartWidget';
+        }
+
+        return parent::getFrontendStartControllerKey();
+    }
+}

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.20.0',
+    'version' => '2.23.0.0',
     'author' => 'Data Development (Inh.: Thomas Dartsch)',
     'email' => 'support@shopmodule.com',
     'url' => 'https://www.oxidmodule.com/',
@@ -61,7 +61,8 @@ $aModule = [
     ],
     'extend' => [
         // Core
-        OEViewConfig::class => ViewConfig::class,
+        OEViewConfig::class                     => ViewConfig::class,
+        \OxidEsales\Eshop\Core\WidgetControl::class                     => \D3\GoogleAnalytics4\Modules\Core\WidgetControl::class,
 
         // Model
         OECategory::class => Category::class,