Merge remote-tracking branch 'remotes/origin/rel_2.x'

Application/Model/ManagerHandler.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace D3\GoogleAnalytics4\Application\Model;
+
+use OxidEsales\Eshop\Core\Registry;
+use OxidEsales\Eshop\Core\ViewConfig;
+
+class ManagerHandler
+{
+    /**
+     * @return string
+     */
+    public function getCurrManager() :string
+    {
+        /** @var ManagerTypes $oManagerTypes */
+        $oManagerTypes = oxNew(ManagerTypes::class);
+
+        /** @var ViewConfig $oViewConfig */
+        $oViewConfig = oxNew(ViewConfig::class);
+
+        $aManagerList =  $oManagerTypes->getManagerList();
+
+        foreach ($aManagerList as $managerName){
+           if ($oViewConfig->isModuleActive($managerName)){
+               return $managerName;
+           }
+        }
+
+       return $this->getExplicitManager();
+    }
+
+    /**
+     * @return string
+     */
+    public function getModuleSettingExplicitManagerSelectValue() :string
+    {
+        return Registry::getConfig()->getConfigParam('d3_gtm_settings_HAS_STD_MANAGER');
+    }
+
+    /**
+     * @return string
+     */
+    public function getExplicitManager() :string
+    {
+        $sPotentialManagerName = $this->getModuleSettingExplicitManagerSelectValue();
+
+        /** @var ManagerTypes $oManagerTypes */
+        $oManagerTypes = oxNew(ManagerTypes::class);
+        return $oManagerTypes->isManagerInList($sPotentialManagerName)
+            ? $sPotentialManagerName
+            : "NONE";
+    }
+}

Application/Model/ManagerTypes.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace D3\GoogleAnalytics4\Application\Model;
+
+class ManagerTypes
+{
+    #ToDo: make own classes for each of the manager
+
+
+    const EXTERNAL_SERVICE          = "externalService";
+    const NET_COOKIE_MANAGER        = "net_cookie_manager";
+
+    /**
+     * Further information's:
+     * https://github.com/aggrosoft/oxid-cookie-compliance
+     */
+    const AGCOOKIECOMPLIANCE        = "agcookiecompliance";
+
+    /**
+     * Used the OXID Module.
+     *
+     * Further information's:
+     * https://docs.oxid-esales.com/modules/usercentrics/de/latest/einfuehrung.html
+     *
+     * Usercentrics homepage:
+     * https://usercentrics.com
+     */
+    const USERCENTRICS_MODULE       = "oxps_usercentrics";
+
+    /**
+     * manually included usercentrics script
+     */
+    const USERCENTRICS_MANUALLY     = "USERCENTRICS";
+
+    const CONSENTMANAGER            = "CONSENTMANAGER";
+
+    /**
+     * @return array
+     */
+    public function getManagerList(): array
+    {
+        return [
+            "externalService"       => self::EXTERNAL_SERVICE,
+            "agcookiecompliance"    => self::AGCOOKIECOMPLIANCE,
+            "net_cookie_manager"    => self::NET_COOKIE_MANAGER,
+            "oxps_usercentrics"     => self::USERCENTRICS_MODULE,
+            "usercentrics"          => self::USERCENTRICS_MANUALLY,
+            "consentmanager"        => self::CONSENTMANAGER
+        ];
+    }
+
+    /**
+     * @param string $sManager
+     * @return bool
+     */
+    public function isManagerInList(string $sManager) :bool
+    {
+        return in_array($sManager, $this->getManagerList(), true);
+    }
+}

CHANGELOG.md

@@ -4,6 +4,20 @@ 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.6.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.5.0...2.6.0) - 2023-05-31
+### Added
+- add settings to explicit choose an external service (usercentrics/ consentmanager)
+- position to block-extension
+- extended instructions to check for in readme
+### Fixed
+- usercentrics script
+- missing right articleList-getter
+### Changed
+- view_item_list-template block extension
+- cookieManager handling
+### Removed
+- additional check for cookieManagerType
+
 ## [2.5.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.4.0...2.5.0) - 2023-05-23
 ### Added
 - additional settings to explicitly indicate that consentmanager is used
@@ -72,6 +86,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - genuine code cleanup
 - usercentrics includation script
 
+## [1.8.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.7.0...1.8.0) - 2023-05-31
+### Fixed
+- bug in explicit manager selection
+
+## [1.7.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.6.0...1.7.0) - 2023-05-31
+### Added
+- extended call to read the technical documentation
+### Changed
+- block-extension for view_item_list
+- way of getting list-articles in view_item_list
+
+## [1.6.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.5.0...1.6.0) - 2023-05-30
+### Added
+- possibility to choose between consentmanager && usercentrics
+- position to block extension
+### Changed
+- genuine code cleanup
+- usercentrics includation script
+
 ## [1.5.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.4.0...1.5.0) - 2023-05-23
 ### Added
 - additional settings to explicitly indicate that consentmanager is used

Modules/Core/ViewConfig.php

@@ -12,6 +12,8 @@
 
 namespace D3\GoogleAnalytics4\Modules\Core;
 
+use D3\GoogleAnalytics4\Application\Model\ManagerHandler;
+use D3\GoogleAnalytics4\Application\Model\ManagerTypes;
 use OxidEsales\Eshop\Application\Controller\FrontendController;
 use OxidEsales\Eshop\Core\Config;
 use OxidEsales\Eshop\Core\Registry;
@@ -38,47 +40,23 @@ class ViewConfig extends ViewConfig_parent
     }
 
     /**
-     * @return mixed
+     * @return void
      */
-    public function getModuleSettingExplicitManagerSelectValue()
+    public function defineCookieManagerType() :void
-    {
-        return Registry::getConfig()->getConfigParam('d3_gtm_settings_HAS_STD_MANAGER');
-    }
-
-    /**
-     * @return false|mixed
-     */
-    public function getExplicitManager()
-    {
-        $sManagerName = $this->getModuleSettingExplicitManagerSelectValue();
-        return $sManagerName === "NONE" ? false : $sManagerName;
-    }
-
-    public function getCookieManagerType()
     {
         if ($this->sCookieManagerType === null)
         {
-            $this->sCookieManagerType = false;
+            /** @var ManagerHandler $oManagerHandler */
-
+            $oManagerHandler = oxNew(ManagerHandler::class);
-            $allowedManagerTypes = [
+            $this->sCookieManagerType = $oManagerHandler->getCurrManager();
-                'net_cookie_manager',
-                'agcookiecompliance',
-                'oxps_usercentrics'
-            ];
-
-            foreach ($allowedManagerTypes as $type) {
-                if ($this->isModuleActive($type)) {
-                    $this->sCookieManagerType = $type;
-                    break;
-                }
-            }
         }
-
+    }
-        if ($this->sCookieManagerType === false and $this->getExplicitManager()){
+    /**
-            return "externalService";
+     * @return bool
-        }
+     */
-
+    public function shallUseOwnCookieManager() :bool
-        return $this->sCookieManagerType;
+    {
+        return (bool) Registry::getConfig()->getConfigParam('d3_gtm_settings_hasOwnCookieManager');
     }
 
     /**
@@ -98,29 +76,37 @@ class ViewConfig extends ViewConfig_parent
         $oConfig = Registry::getConfig();
 
         // No Cookie Manager in use
-        if (false === $this->shallUseOwnCookieManager()) {
+        if (!$this->shallUseOwnCookieManager()) {
             return true;
         }
 
+        $this->defineCookieManagerType();
+
         $sCookieID = $oConfig->getConfigParam('d3_gtm_settings_cookieName');
 
         // Netensio Cookie Manager
-        if ($this->getCookieManagerType() == "net_cookie_manager") {
+        if ($this->sCookieManagerType === ManagerTypes::NET_COOKIE_MANAGER) {
             $oSession = Registry::getSession();
             $aCookies = $oSession->getVariable("aCookieSel");
 
-            return (!is_null($aCookies) && is_array($aCookies) && array_key_exists($sCookieID, $aCookies) && $aCookies[$sCookieID] == "1");
+            return (is_array($aCookies) && array_key_exists($sCookieID, $aCookies) && $aCookies[$sCookieID] == "1");
         }
 
         // Aggrosoft Cookie Consent
-        if ($this->getCookieManagerType() == "agcookiecompliance") {
+        if ($this->sCookieManagerType === ManagerTypes::AGCOOKIECOMPLIANCE) {
             if (method_exists($this, "isCookieCategoryEnabled")) {
                 return $this->isCookieCategoryEnabled($sCookieID);
             }
         }
 
         // UserCentrics or consentmanager
-        if ($this->getCookieManagerType() === "oxps_usercentrics" or $this->getCookieManagerType() === 'externalService') {
+        if (
+            $this->sCookieManagerType       === ManagerTypes::USERCENTRICS_MODULE
+            or $this->sCookieManagerType    === ManagerTypes::USERCENTRICS_MANUALLY
+            or $this->sCookieManagerType    === ManagerTypes::CONSENTMANAGER
+            or $this->sCookieManagerType    === ManagerTypes::EXTERNAL_SERVICE
+        )
+        {
             // Always needs the script-tags delivered to the DOM.
             return true;
         }
@@ -133,24 +119,27 @@ class ViewConfig extends ViewConfig_parent
      * This is especially important for UserCentrics.
      * @return string
      */
-    public function getGtmScriptAttributes()
+    public function getGtmScriptAttributes() :string
     {
         $oConfig = Registry::getConfig();
+        $sCookieId = $oConfig->getConfigParam('d3_gtm_settings_cookieName');
 
         if (false === $this->shallUseOwnCookieManager()){
             return "";
         }
 
-        if ($this->getCookieManagerType() === "oxps_usercentrics" or $this->getExplicitManager() === 'USERCENTRICS') {
+        if (
-            $sCookieId = $oConfig->getConfigParam('d3_gtm_settings_cookieName');
+            $this->sCookieManagerType === ManagerTypes::USERCENTRICS_MODULE
-
+            or $this->sCookieManagerType === ManagerTypes::USERCENTRICS_MANUALLY
+        )
+        {
             if ($sCookieId) {
                 return 'data-usercentrics="' . $sCookieId . '" type="text/plain" async=""';
             }
         }
-        if ($this->getCookieManagerType() === "externalService" and $this->getExplicitManager() === 'CONSENTMANAGER') {
-            $sCookieId = $oConfig->getConfigParam('d3_gtm_settings_cookieName');
 
+        if ($this->sCookieManagerType === ManagerTypes::CONSENTMANAGER)
+        {
             if ($sCookieId) {
                 return 'async 
                         type="text/plain"

README.md

@@ -30,9 +30,9 @@ Sofern nötig, bestätigen Sie bitte, dass Sie `package-name` erlauben, Code aus
 
 Aktivieren Sie das Modul im Shopadmin unter "Erweiterungen -> Module".
 
-> ### Wichtig!
+### Wichtig!
-> Bitte stellen Sie sicher, dass die nötigen Blöcke im OXID-Shop zur Verfügung stehen.
+Bitte stellen Sie sicher, dass die nötigen Template-Blöcke im OXID-Shop zur Verfügung stehen. 
-> Lesen Sie mehr in der [technischen Doku](./Docs/README.md) unter "Blöcke"!
+Lesen Sie mehr in der [technischen Doku](./Docs/README.md) unter "Blöcke"!
 
 ## Verwendung
 ### Grundfunktionalität

metadata.php

@@ -17,7 +17,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.8.0',
+    'version'     => '2.6.0',
     'author'      => 'Data Development (Inh.: Thomas Dartsch)',
     'email'       => 'support@shopmodule.com',
     'url'         => 'https://www.oxidmodule.com/',