bump metadata && changelog

# Conflicts:
#	Modules/Core/ViewConfig.php

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.
+                                                        '
 ];

CHANGELOG.md

@@ -4,6 +4,19 @@ 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.13.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.12.0...1.13.0) - 2023-09-13
+### Added
+- extended Docs
+### Changed
+- control-param name
+- control-param function
+- adjusted check for set control-param
+- consentmanager-script-adjustments
+
+## [1.12.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.11.1...1.12.0) - 2023-09-07
+### Added
+- cookiebot functionality
+
 ## [1.11.1](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.11.0...1.11.1) - 2023-08-17
 ### Fixed
 - metadata class entry

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
@@ -54,6 +61,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
@@ -78,3 +88,6 @@ Aktivieren Sie anschließend diese Weiche. Setzen Sie den Haken bei "Eigenen Coo
       - prüfen, ob ein Cookie vorgegeben ist
       - sonst, in der Consentmanager-Oberfläche Cookie-Liste entsprechendes Cookie suchen und im Admin unter
         ```Einstell. > Cookie Manager Einstellungen > Cookie-ID``` eintragen
+  
+- [Cookiebot](https://www.cookiebot.com)
+  - Nähere Informationen folgen bald! Bis dato, besuchen Sie bitte die offizielle Webseite.

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/Core/ViewConfig.php

@@ -17,7 +17,6 @@ use D3\GoogleAnalytics4\Application\Model\ManagerTypes;
 use OxidEsales\Eshop\Application\Controller\FrontendController;
 use OxidEsales\Eshop\Core\Config;
 use OxidEsales\Eshop\Core\Registry;
-
 class ViewConfig extends ViewConfig_parent
 {
 
@@ -29,7 +28,7 @@ class ViewConfig extends ViewConfig_parent
     {
         if ($this->sContainerId === null)
         {
-            $this->sContainerId = $this->getConfig()->getConfigParam('d3_gtm_sContainerID');
+            $this->sContainerId = Registry::getConfig()->getConfigParam('d3_gtm_sContainerID');
         }
         return $this->sContainerId;
     }
@@ -70,7 +69,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) {
@@ -93,6 +92,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
         )
         {
@@ -111,9 +111,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 "";
         }
 
@@ -122,25 +122,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 "";
@@ -148,11 +143,12 @@ class ViewConfig extends ViewConfig_parent
 
     private $blGA4enabled = null;
 
+    
     public function isGA4enabled()
     {
         if ($this->blGA4enabled === null)
         {
-            $this->sContainerId = $this->getConfig()->getConfigParam('d3_gtm_blEnableGA4');
+            $this->sContainerId = Registry::getConfig()->getConfigParam('d3_gtm_blEnableGA4');
         }
 
         return $this->blGA4enabled;

metadata.php

@@ -28,7 +28,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'     => '1.11.0',
+    'version'     => '1.13.0',
     'author'      => 'Data Development (Inh.: Thomas Dartsch)',
     'email'       => 'support@shopmodule.com',
     'url'         => 'https://www.oxidmodule.com/',
@@ -134,9 +134,9 @@ $aModule          = [
         ],
         [
             'group'    => 'd3_gtm_settings_cookiemanager',
-            'name'     => 'd3_gtm_settings_cookieName',
+            'name'     => 'd3_gtm_settings_controlParameter',
             'type'     => 'str',
-            'value'    => 'example',
+            'value'    => '',
             'position' => 999
         ],
         [
@@ -144,7 +144,7 @@ $aModule          = [
             'name' => 'd3_gtm_settings_HAS_STD_MANAGER',
             'type' => 'select',
             'value' => 'none',
-            'constraints' => 'NONE|CONSENTMANAGER|USERCENTRICS|COOKIEFIRST',
+            'constraints' => 'NONE|CONSENTMANAGER|USERCENTRICS|COOKIEFIRST|COOKIEBOT',
         ],
     ]
 ];