bump version && changelog to 2.8.0

extend Basket-Model to add method to get payment-desc

Application/Model/ManagerTypes.php

@@ -34,8 +34,6 @@ class ManagerTypes
 
     const CONSENTMANAGER            = "CONSENTMANAGER";
 
-    const COOKIEFIRST               = "COOKIEFIRST";
-
     /**
      * @return array
      */
@@ -47,8 +45,7 @@ class ManagerTypes
             "net_cookie_manager"    => self::NET_COOKIE_MANAGER,
             "oxps_usercentrics"     => self::USERCENTRICS_MODULE,
             "usercentrics"          => self::USERCENTRICS_MANUALLY,
-            "consentmanager"        => self::CONSENTMANAGER,
+            "consentmanager"        => self::CONSENTMANAGER
-            "cookiefirst"        => self::COOKIEFIRST
         ];
     }
 

Application/views/admin/de/module_options.php

@@ -31,17 +31,10 @@ $aLang = [
     // for cookie manager settings
     'SHOP_MODULE_GROUP_d3_gtm_settings_cookiemanager'   => 'Cookie Manager Einstellungen',
     'SHOP_MODULE_d3_gtm_settings_hasOwnCookieManager'   => 'Cookie Manager nutzen?',
-    'HELP_SHOP_MODULE_d3_gtm_settings_HAS_STD_MANAGER'              => 'Mehr Informationen zu den genannten Coookie-Manager finden Sie auf den folgenden Home-Pages<br><br>
-                                                                        <a href="https://consentmanager.net/">Consentmanager</a><br>
-                                                                        <a href="https://usercentrics.com/">Usercentrics</a><br>
-                                                                        <a href="https://cookiefirst.com">Cookiefirst</a><br>
-                                                                        <hr>
-                                                                        Bei weiteren Fragen stehen wir gern zur Verfügung! Kontaktieren Sie uns einfach unter <a href="https://www.d3data.de/">https://www.d3data.de/</a>',
     'SHOP_MODULE_d3_gtm_settings_HAS_STD_MANAGER'                   => 'Nutzen Sie eine der folgenden Einbindungen?<br>
                                                                         Dann wählen Sie bitte die zutreffende aus.',
     'SHOP_MODULE_d3_gtm_settings_HAS_STD_MANAGER_NONE'              => '---',
     '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',
 ];

CHANGELOG.md

@@ -4,24 +4,87 @@ 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.10.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.9.0...1.10.0) - 2023-06-27
+## [2.8.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.7.0...2.8.0) - 2023-06-23
 ### Added
+- Method to get the in order used Payment-Name
+- Method to get the current Article Category
 - Following Entries to dedicated event-templates
   - coupon
   - paymentType
   - item_list_name
   - item_category
-- Method to get the in order used Payment-Name
-- Method to get the current Article Category
 ### Changed
-- cookieManager handling
+- all used template-files have a more dedicated name
-- general template cleanup
+- general code cleanup
-- renaming the template to a more intuitive name
 
-## [1.9.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.8.0...1.9.0) - 2023-06-19
+## [2.7.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.6.0...2.7.0) - 2023-06-19
 ### Changed
 - add_to_cart event template-structure
 
+## [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
+### Fixed
+- unnecessary converting of int to str
+- missing PriceObject-bug
+### Changed
+- genuine code cleanup
+
+## [2.4.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.3.3...2.4.0) - 2023-05-02
+### Added
+- "OXID Cookie Management powered by usercentrics" compatibility
+- usercentrics defined script attributes
+- cookie-manager evaluation
+### Changed
+- genuine clean up of base-js-files
+
+## [2.3.3](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.3.2...2.3.3) - 2023-03-20
+### Fixed
+- metadata file path for view_item
+
+## [2.3.2](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.2.2...2.3.2) - 2023-03-17
+### Added
+- Aggrosoft-Cookie-Consent compatibility
+### Fixed
+- wrong function for pageview on thankyou page
+### Deleted
+- unused files
+
+## [2.2.2](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.2.1...2.2.2) - 2023-02-22
+### Fixed
+- price formatting in view_cart
+
+## [2.2.1](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.1.1...2.2.1) - 2023-02-21
+### Added
+- cookie handling
+
+## [2.1.1](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.1...2.1.1) - 2023-01-27
+### Fixed
+- add missing class import
+
+## [2.1](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.0...2.1) - 2023-01-27
+### Added
+- block section for add_to_basket js
+- template block order positions
+
+## [2.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.1...2.0) - 2023-01-20
+### Added
+- using of ContainerFactory in ViewConfig
+
 ## [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

Docs/README.md

@@ -12,7 +12,7 @@ Für den geregelten Ablauf sind folgende Blöcke nötig:
     - Datei: page/search/search.tpl
     - GA4 Event: view_search_results
 - Artikelliste
-    - Blockname: page_list_productlist
+    - Blockname: page_list_productlist (muss hinzugefügt werden)
     - Datei: page/list/list.tpl
     - GA4 Event: view_item_list
 - Detailseite
@@ -65,4 +65,12 @@ Aktivieren Sie anschließend diese Weiche. Setzen Sie den Haken bei "Eigenen Coo
 - [OXID Cookie Management powered by usercentrics](https://docs.oxid-esales.com/modules/usercentrics/de/latest/einfuehrung.html)
   - In der Usercentrics-Verwaltung die Services "Google Analytics" und "Google Tag Manager" anlegen
   - Den Service ```Google Tag Manager``` in den Moduleinstellungen des 'Google Analytics 4' unter
+    Google Tag Manager eintragen
+  - 
+- [Consent Management Provider](https://www.consentmanager.net/)
+  - In der Consentmanager-Oberfläche den Anbieter "Google Tag Manager" mit der ID s905 hinzufügen
+  - Im Frontend, im consentmanager-Pop-up nach dem 'Google Tag Manager' suchen
+    - 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

Modules/Core/ViewConfig.php

@@ -17,6 +17,8 @@ use D3\GoogleAnalytics4\Application\Model\ManagerTypes;
 use OxidEsales\Eshop\Application\Controller\FrontendController;
 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;
 
 class ViewConfig extends ViewConfig_parent
 {
@@ -29,7 +31,10 @@ class ViewConfig extends ViewConfig_parent
     {
         if ($this->sContainerId === null)
         {
-            $this->sContainerId = $this->getConfig()->getConfigParam('d3_gtm_sContainerID');
+            $this->sContainerId = ContainerFactory::getInstance()
+                                                  ->getContainer()
+                                                  ->get(ModuleSettingBridgeInterface::class)
+                                                  ->get('d3_gtm_sContainerID', 'd3googleanalytics4');
         }
         return $this->sContainerId;
     }
@@ -70,7 +75,7 @@ class ViewConfig extends ViewConfig_parent
 
         $this->defineCookieManagerType();
 
-        $sCookieID = trim($oConfig->getConfigParam('d3_gtm_settings_cookieName'));
+        $sCookieID = $oConfig->getConfigParam('d3_gtm_settings_cookieName');
 
         // Netensio Cookie Manager
         if ($this->sCookieManagerType === ManagerTypes::NET_COOKIE_MANAGER) {
@@ -92,7 +97,6 @@ class ViewConfig extends ViewConfig_parent
             $this->sCookieManagerType       === ManagerTypes::USERCENTRICS_MODULE
             or $this->sCookieManagerType    === ManagerTypes::USERCENTRICS_MANUALLY
             or $this->sCookieManagerType    === ManagerTypes::CONSENTMANAGER
-            or $this->sCookieManagerType    === ManagerTypes::COOKIEFIRST
             or $this->sCookieManagerType    === ManagerTypes::EXTERNAL_SERVICE
         )
         {
@@ -111,7 +115,8 @@ class ViewConfig extends ViewConfig_parent
      */
     public function getGtmScriptAttributes() :string
     {
-        $sCookieId = trim(Registry::getConfig()->getConfigParam('d3_gtm_settings_cookieName'));
+        $oConfig = Registry::getConfig();
+        $sCookieId = $oConfig->getConfigParam('d3_gtm_settings_cookieName');
 
         if (false === $this->shallUseOwnCookieManager()){
             return "";
@@ -139,10 +144,6 @@ class ViewConfig extends ViewConfig_parent
             }
         }
 
-        if ($this->sCookieManagerType === ManagerTypes::COOKIEFIRST){
-            return 'type="text/plain" data-cookiefirst-category="' . $sCookieId .'"';
-        }
-
         return "";
     }
 
@@ -152,7 +153,10 @@ class ViewConfig extends ViewConfig_parent
     {
         if ($this->blGA4enabled === null)
         {
-            $this->sContainerId = $this->getConfig()->getConfigParam('d3_gtm_blEnableGA4');
+            $this->sContainerId = ContainerFactory::getInstance()
+                                                  ->getContainer()
+                                                  ->get(ModuleSettingBridgeInterface::class)
+                                                  ->get('d3_gtm_blEnableGA4', 'd3googleanalytics4');
         }
 
         return $this->blGA4enabled;

composer.json

@@ -45,7 +45,7 @@
   },
   "require": {
     "php": ">=7.1",
-    "oxid-esales/oxideshop-ce": "v6.0 - 6.3",
+    "oxid-esales/oxideshop-ce": "^6.5",
     "google/apiclient":" ^2.0"
   },
   "autoload": {

metadata.php

@@ -22,7 +22,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.10.0',
+    'version'     => '2.8.0',
     'author'      => 'Data Development (Inh.: Thomas Dartsch)',
     'email'       => 'support@shopmodule.com',
     'url'         => 'https://www.oxidmodule.com/',
@@ -128,7 +128,7 @@ $aModule          = [
             'name' => 'd3_gtm_settings_HAS_STD_MANAGER',
             'type' => 'select',
             'value' => 'none',
-            'constraints' => 'NONE|CONSENTMANAGER|USERCENTRICS|COOKIEFIRST',
+            'constraints' => 'NONE|CONSENTMANAGER|USERCENTRICS',
         ],
     ]
 ];