[Bump] metadata && changelog

Syntax-Error duo to the OXID-strip that made the inline-comment cut off "})" of the code

Application/Model/Constants.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace D3\GoogleAnalytics4\Application\Model;
+
+
+class Constants
+{
+    public const OXID_MODULE_ID = 'd3googleanalytics4';
+}

Application/views/admin/de/module_options.php

@@ -27,6 +27,52 @@ $aLang = [
     'SHOP_MODULE_d3_gtm_blGA4enab'          => 'GA4 Aktivieren',
     'SHOP_MODULE_d3_gtm_blUAenabled'        => 'UA Aktivieren',
     'SHOP_MODULE_d3_gtm_blEnableDebug'      => 'Debug-Modus aktivieren',
+    'SHOP_MODULE_GROUP_d3_gtm_settings_serversidetagging'         => 'Server-Side tagging',
+    'SHOP_MODULE_d3_gtm_settings_serversidetagging_js'      => 'Servercontainer Ausführender-Code',
+    'HELP_SHOP_MODULE_d3_gtm_settings_serversidetagging_js'      => 'Diese Domain wird im <strong>aktiven</strong>-code ausgefüht. Das heißt,
+                                                                        dass es sich hierbei um das HTML-Tag <code>script</code> handelt.
+                                                                        Dieses kümmert sich darum, dass die, im data_layer
+                                                                        zusammengefassten Daten an den GTM weitergeleitet werden.<br>
+                                                                        <br>
+                                                                        <h4>Folgend eine Darstellung, was genau ausgetauscht wird</h4>
+                                                                        <pre>
+<code>
+Vorher:
+https://www.googletagmanager.com/gtm.js?id=
+
+Nachher:
+{Domain}?id=
+</code>
+                                                                        </pre>
+                                                                        Die Conatiner-ID wird weiterhin im Punkt "Einstellung" eingetragen!
+                                                                        ',
+    'SHOP_MODULE_d3_gtm_settings_serversidetagging_nojs'    => 'Servercontainer NICHT Ausführender-Code<br><br>
+    "Serverseitiges Tagging ist eine neue Möglichkeit, mit Google Tag Manager Ihre Anwendung geräteübergreifend zu verwalten.<br>
+    Servercontainer verwenden dasselbe Tag-, Trigger- und Variablenmodell, das Sie gewohnt sind.<br> 
+    Außerdem bieten sie neue Tools, mit denen Sie Nutzeraktivitäten überall messen können." <br>
+    <br>
+    - Quelle <a href="https://developers.google.com/tag-platform/tag-manager/server-side/intro">Developers-Google Server-Side tagging</a><br>
+    <br>
+    <strong>Verändern Sie die Werte nur, wenn Sie Server-Side tagging verwenden wollen!</strong>
+',
+    'HELP_SHOP_MODULE_d3_gtm_settings_serversidetagging_nojs'    => 'Diese Domain wird im <strong>passiven</strong>-code ausgefüht. Das heißt,
+                                                                        dass es sich hierbei um das HTML-Tag <code>noscript</code> handelt.
+                                                                        Dieses wird ausgeführt, wenn aus einem bestimmten Grund
+                                                                        das Javascript nicht ausgeführt wird.<br>
+                                                                        ( keine Cookies erlaubt, JavaScript-Unterbindung, ... )
+                                                                        <br>
+                                                                        <h4>Folgend eine Darstellung, was genau ausgetauscht wird</h4>
+                                                                        <pre>
+<code>
+Vorher:
+src="https://www.googletagmanager.com/ns.html?id={Container-ID}"
+
+Nachher:
+src="{Domain}?id={Container-ID}"
+</code>
+                                                                        </pre>
+                                                                        Die Conatiner-ID wird weiterhin im Punkt "Einstellung" eingetragen!
+                                                                        ',
 
     // for cookie manager settings
     'SHOP_MODULE_GROUP_d3_gtm_settings_cookiemanager'   => 'Cookie Manager Einstellungen',
@@ -49,5 +95,10 @@ $aLang = [
                                                         <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.
-                                                        '
+                                                        ',
+    'SHOP_MODULE_d3_gtm_blActivateConsentMode'            => "Google Consent Mode 'Default Values' aktivieren",
+    'HELP_SHOP_MODULE_d3_gtm_blActivateConsentMode'       => 'Diese Einstellung ist zu aktivieren, wenn Sie den Google-Consent-Mode ( Einwilligungsmodus ) verwenden wollen.
+                                                                    <hr>
+                                                                    "Im Einwilligungsmodus können Sie Google über den Cookie- oder App-ID-Einwilligungsstatus Ihrer Nutzer informieren. 
+                                                                    Mit Tags wird das Verhalten angepasst. Dabei werden die Einstellungen der Nutzer berücksichtigt." ~ <a href="https://support.google.com/google-ads/answer/10000067">Google Einwilligungsmodus</a>',
 ];

Application/views/blocks/_gtm_js.tpl

@@ -3,9 +3,28 @@
   var dataLayer = [{$oViewConf->getGtmDataLayer()}] || [];
 </script>
 
+[{assign var="d3GtmContainerIdString" value=$oViewConf->getGtmContainerId()}]
+
 [{if $oViewConf->D3blShowGtmScript()}]
-    [{if $oViewConf->getGtmContainerId()}]
+    [{if $d3GtmContainerIdString}]
         [{strip}]
+
+            [{if $oViewConf->isGtmConsentModeSetActivated()}]
+                <script type="text/javascript">
+                    function gtag() {
+                        dataLayer.push(arguments);
+                    }
+
+                    gtag("consent", "default", {
+                        ad_user_data: "denied",
+                        ad_personalization: "denied",
+                        ad_storage: "denied",
+                        analytics_storage: "denied",
+                        wait_for_update: 2000
+                    });
+                </script>
+            [{/if}]
+
             <!-- Google Tag Manager -->
             <script [{$oViewConf->getGtmScriptAttributes()}]>
               (function (w, d, s, l, i) {
@@ -13,9 +32,9 @@
                 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;
+                j.src = '[{$oViewConf->getServerSidetaggingJsDomain()}]?id=' + i + dl;
                 f.parentNode.insertBefore(j, f);
-              })(window, document, 'script', 'dataLayer', '[{$oViewConf->getGtmContainerId()}]');
+              })(window, document, 'script', 'dataLayer', '[{$d3GtmContainerIdString}]');
             </script>
             <!-- End Google Tag Manager -->
         [{/strip}]

Application/views/blocks/_gtm_nojs.tpl

@@ -2,7 +2,7 @@
     [{if $oViewConf->getGtmContainerId()}][{strip}]
     <!-- Google Tag Manager (noscript) -->
     <noscript>
-        <iframe src="https://www.googletagmanager.com/ns.html?id=[{$oViewConf->getGtmContainerId()}]"
+        <iframe src="[{$oViewConf->getServerSidetaggingNoJsDomain()}]?id=[{$oViewConf->getGtmContainerId()}]"
                 height="0" width="0" style="display:none;visibility:hidden"></iframe>
     </noscript>
 <!-- End Google Tag Manager (noscript) -->

Application/views/event/add_to_cart.tpl

@@ -1,5 +1,5 @@
 
-[{if $d3CmpBasket->getAddToBasketDecision() && $d3CmpBasket->d3GtmRequestedArticleLoadedByAnid() !== null}]
+[{if $d3CmpBasket && $d3CmpBasket->getAddToBasketDecision() && $d3CmpBasket->d3GtmRequestedArticleLoadedByAnid() !== null}]
   [{assign var="oGtmProduct"              value=$d3CmpBasket->d3GtmRequestedArticleLoadedByAnid()}]
   [{assign var="oGtmAmountArticlesAdded"  value=$d3CmpBasket->getD3GtmAddToCartAmountArticles()}]
   [{*$smarty.block.parent*}]

CHANGELOG.md

@@ -4,6 +4,26 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.17.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.16.0...1.17.0) - 2024-04-11
+### Added
+- multilang translations
+- GA4 consent-mode default values
+
+### Changed
+- metadataID centralized
+
+## [1.16.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.15.1...1.16.0) - 2024-04-11
+### Added
+- ( Google ) Server-Side tagging usability
+
+## [1.15.1](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.15.0...1.15.1) - 2024-04-11
+### Fixed
+- false processing of template during missing necessary-component
+
+## [1.15.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.14.0...1.15.0) - 2024-01-25
+### Fixed
+- missing Component-ArticleDetails extension, missing ManufacturerListController extension
+
 ## [1.14.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.13.0...1.14.0) - 2024-01-03
 ### Added
 - add_to_cart Event to several new shop-pages (landing-page, Account, category article-list, start)

IntelliSenseHelper.php

@@ -28,6 +28,7 @@ namespace D3\GoogleAnalytics4\Modules\Application\Controller{
     use OxidEsales\Eshop\Application\Controller\AccountNoticeListController;
     use OxidEsales\Eshop\Application\Controller\AccountRecommlistController;
     use OxidEsales\Eshop\Application\Controller\AccountWishlistController;
+    use OxidEsales\Eshop\Application\Controller\Admin\ManufacturerController;
     use OxidEsales\Eshop\Application\Controller\ArticleListController;
     use OxidEsales\Eshop\Application\Controller\SearchController;
     use OxidEsales\Eshop\Application\Controller\StartController;
@@ -48,6 +49,8 @@ namespace D3\GoogleAnalytics4\Modules\Application\Controller{
     class d3GtmStartController_parent extends StartController {}
 
     class d3GtmSearchController_parent extends SearchController {}
+
+    class d3GtmManufacturerListController_parent extends ManufacturerController {}
 }
 
 namespace D3\GoogleAnalytics4\Modules\Application\Component{
@@ -55,4 +58,11 @@ namespace D3\GoogleAnalytics4\Modules\Application\Component{
     use OxidEsales\Eshop\Application\Component\BasketComponent;
 
     class d3GtmBasketComponentExtension_parent extends BasketComponent {}
+}
+
+namespace D3\GoogleAnalytics4\Modules\Application\Component\Widget{
+
+    use OxidEsales\Eshop\Application\Component\Widget\ArticleDetails;
+
+    class d3GtmWidgetArticleDetails_parent extends ArticleDetails {}
 }

Modules/Application/Component/Widget/d3GtmWidgetArticleDetails.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace D3\GoogleAnalytics4\Modules\Application\Component\Widget;
+
+
+class d3GtmWidgetArticleDetails extends d3GtmWidgetArticleDetails_parent
+{
+    public function render()
+    {
+        $return = parent::render();
+
+        $this->addTplParam('d3CmpBasket', $this->getComponent('oxcmp_basket'));
+
+        return $return;
+    }
+}

Modules/Application/Controller/d3GtmManufacturerListController.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace D3\GoogleAnalytics4\Modules\Application\Controller;
+
+
+class d3GtmManufacturerListController extends d3GtmManufacturerListController_parent
+{
+    public function render()
+    {
+        $return = parent::render();
+
+        $this->addTplParam('d3CmpBasket', $this->getComponent('oxcmp_basket'));
+
+        return $return;
+    }
+}

Modules/Core/ViewConfig.php

@@ -144,7 +144,10 @@ class ViewConfig extends ViewConfig_parent
 
     private $blGA4enabled = null;
 
-    
+
+    /**
+     * @return null
+     */
     public function isGA4enabled()
     {
         if ($this->blGA4enabled === null)
@@ -155,6 +158,17 @@ class ViewConfig extends ViewConfig_parent
         return $this->blGA4enabled;
     }
 
+    /**
+     * @return bool
+     */
+    public function isGtmConsentModeSetActivated() :bool
+    {
+        return Registry::getConfig()->getConfigParam('d3_gtm_blActivateConsentMode');
+    }
+
+    /**
+     * @return false|string
+     */
     public function getGtmDataLayer()
     {
         if (!$this->getGtmContainerId()) return "[]";
@@ -193,14 +207,37 @@ class ViewConfig extends ViewConfig_parent
         return json_encode([$dataLayer], JSON_PRETTY_PRINT);
     }
 
+    /**
+     * @return bool
+     */
     public function isDebugModeOn() :bool
     {
         return Registry::getConfig()->getConfigParam('d3_gtm_blEnableDebug');
     }
 
+    /**
+     * @param $listId
+     * @return void
+     */
     public function isPromotionList($listId)
     {
         $oConfig           = Registry::getConfig();
         $aPromotionListIds = $oConfig->getConfigParam("") ?? ['bargainItems', 'newItems', 'topBox', 'alsoBought', 'accessories', 'cross'];
     }
+
+    /**
+     * @return string
+     */
+    public function getServerSidetaggingJsDomain() :string
+    {
+        return Registry::getConfig()->getConfigParam('d3_gtm_settings_serversidetagging_js');
+    }
+
+    /**
+     * @return string
+     */
+    public function getServerSidetaggingNoJsDomain() :string
+    {
+        return Registry::getConfig()->getConfigParam('d3_gtm_settings_serversidetagging_nojs');
+    }
 }

metadata.php

@@ -1,12 +1,15 @@
 <?php
 
+use D3\GoogleAnalytics4\Application\Model\Constants as Constants;
 use D3\GoogleAnalytics4\Modules\Application\Component\d3GtmBasketComponentExtension;
+use D3\GoogleAnalytics4\Modules\Application\Component\Widget\d3GtmWidgetArticleDetails as d3GtmWidgetArticleDetails;
 use D3\GoogleAnalytics4\Modules\Application\Controller\ArticleDetailsController;
 use D3\GoogleAnalytics4\Modules\Application\Controller\ArticleListController_AddToCartHelpMethods;
 use D3\GoogleAnalytics4\Modules\Application\Controller\BasketController;
 use D3\GoogleAnalytics4\Modules\Application\Controller\d3GtmAccountNoticeListController;
 use D3\GoogleAnalytics4\Modules\Application\Controller\d3GtmAccountRecommlistController;
 use D3\GoogleAnalytics4\Modules\Application\Controller\d3GtmAccountWishlistController;
+use D3\GoogleAnalytics4\Modules\Application\Controller\d3GtmManufacturerListController as d3GtmManufacturerListController;
 use D3\GoogleAnalytics4\Modules\Application\Controller\d3GtmSearchController;
 use D3\GoogleAnalytics4\Modules\Application\Controller\d3GtmStartController;
 use D3\GoogleAnalytics4\Modules\Application\Controller\ThankYouController;
@@ -15,12 +18,14 @@ 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\Component\BasketComponent as OEBasketComponent;
+use OxidEsales\Eshop\Application\Component\Widget\ArticleDetails as OEArticleDetails;
 use OxidEsales\Eshop\Application\Controller\AccountNoticeListController as OEAccountNoticeListController;
 use OxidEsales\Eshop\Application\Controller\AccountRecommlistController as OEAccountRecommlistController;
 use OxidEsales\Eshop\Application\Controller\AccountWishlistController as OEAccountWishlistController;
 use OxidEsales\Eshop\Application\Controller\ArticleDetailsController as OEArticleDetailsController;
 use OxidEsales\Eshop\Application\Controller\ArticleListController as OEArticleListController;
 use OxidEsales\Eshop\Application\Controller\BasketController as OEBasketController;
+use OxidEsales\Eshop\Application\Controller\ManufacturerListController as OEManufacturerListController;
 use OxidEsales\Eshop\Application\Controller\SearchController as OESearchController;
 use OxidEsales\Eshop\Application\Controller\StartController as OEStartController;
 use OxidEsales\Eshop\Application\Controller\ThankYouController as OEThankYouController;
@@ -31,7 +36,7 @@ use OxidEsales\Eshop\Core\ViewConfig as OEViewConfig;
 
 $sMetadataVersion = '2.1';
 $aModule          = [
-    'id'          => 'd3googleanalytics4',
+    'id'          => Constants::OXID_MODULE_ID,
     'title'       => 'Google Analytics 4',
     'description' => "Dieses Modul bietet die Möglichkeit in Ihrem OXID eShop (6.x) die neue 'Property' 
                       Google Analytics 4 (GA4) von Google zu integrieren.<br>
@@ -44,25 +49,34 @@ $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.14.0',
+    'version'     => '1.17.0',
     'author'      => 'Data Development (Inh.: Thomas Dartsch)',
     'email'       => 'support@shopmodule.com',
     'url'         => 'https://www.oxidmodule.com/',
     'extend'      => [
+        // Core
         OEViewConfig::class                     => ViewConfig::class,
+
+        // Model
         OECategory::class                       => Category::class,
         OEBasket::class                         => Basket::class,
-        OEBasketController::class               => BasketController::class,
         OEManufacturer::class                   => Manufacturer::class,
+
+        // Controller
+        OEBasketController::class               => BasketController::class,
         OEThankYouController::class             => ThankYouController::class,
         OEArticleListController::class          => ArticleListController_AddToCartHelpMethods::class,
-        OEBasketComponent::class                => d3GtmBasketComponentExtension::class,
         OEArticleDetailsController::class       => ArticleDetailsController::class,
         OEAccountNoticeListController::class    => d3GtmAccountNoticeListController::class,
         OEAccountRecommlistController::class    => d3GtmAccountRecommlistController::class,
         OEAccountWishlistController::class      => d3GtmAccountWishlistController::class,
         OEStartController::class                => d3GtmStartController::class,
-        OESearchController::class               => d3GtmSearchController::class
+        OESearchController::class               => d3GtmSearchController::class,
+        OEManufacturerListController::class     => d3GtmManufacturerListController::class,
+
+        // Component
+        OEArticleDetails::class                 => d3GtmWidgetArticleDetails::class,
+        OEBasketComponent::class                => d3GtmBasketComponentExtension::class,
     ],
     'templates'   => [
         // Event files that store the GA4 Event-Information
@@ -176,6 +190,13 @@ $aModule          = [
             'value'    => false,
             'position' => 999
         ],
+        [
+            'group'    => 'd3_gtm_settings',
+            'name'     => 'd3_gtm_blActivateConsentMode',
+            'type'     => 'bool',
+            'value'    => false,
+            'position' => 999
+        ],
         [
             'group'    => 'd3_gtm_settings_cookiemanager',
             'name'     => 'd3_gtm_settings_hasOwnCookieManager',
@@ -197,5 +218,18 @@ $aModule          = [
             'value' => 'none',
             'constraints' => 'NONE|CONSENTMANAGER|USERCENTRICS|COOKIEFIRST|COOKIEBOT',
         ],
+        // OST929760 - Erweiterung für Serverside Tagging
+        [
+            'group' => 'd3_gtm_settings_serversidetagging',
+            'name' => 'd3_gtm_settings_serversidetagging_js',
+            'type'     => 'str',
+            'value'    => 'https://www.googletagmanager.com/gtm.js',
+        ],
+        [
+            'group' => 'd3_gtm_settings_serversidetagging',
+            'name' => 'd3_gtm_settings_serversidetagging_nojs',
+            'type'     => 'str',
+            'value'    => 'https://www.googletagmanager.com/ns.html',
+        ],
     ]
 ];