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

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).
 
+## [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

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/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="' . $sControlParameter . '" type="text/plain" async=""';
-                return 'data-usercentrics="' . $sCookieId . '" type="text/plain" async=""';
-            }
         }
 
         if ($this->sCookieManagerType === ManagerTypes::CONSENTMANAGER)
         {
-            if ($sCookieId) {
+            return 'type="text/plain" class="cmplazyload" data-cmp-vendor="'.$sControlParameter.'"';
-                return 'async 
-                        type="text/plain"
-                        data-cmp-src="https://www.googletagmanager.com/gtm.js?id='.$this->getGtmContainerId().'"
-                        class="cmplazyload"
-                        data-cmp-vendor="s905"
-                        ';
-            }
         }
 
         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)

metadata.php

@@ -26,7 +26,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.11.0',
+    'version'     => '2.13.0',
     'author'      => 'Data Development (Inh.: Thomas Dartsch)',
     'email'       => 'support@shopmodule.com',
     'url'         => 'https://www.oxidmodule.com/',
@@ -131,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
         ],
         [
@@ -141,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',
         ],
     ]
 ];