bump metadata && changelog

deny method-call on no category

.gitignore

@@ -1 +0,0 @@
-.idea

Application/views/admin/de/module_options.php

@@ -31,11 +31,11 @@ $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>
+    'HELP_SHOP_MODULE_d3_gtm_settings_HAS_STD_MANAGER'              => 'Mehr Informationen zu den genannten Coookie-Manager finden Sie auf den folgenden Home-Pages<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.',

Application/views/ga4/view_item_list.tpl

@@ -1,46 +1,46 @@
-[{$smarty.block.parent}]
-[{assign var="gtmProducts" value=$oView->getArticleList()}]
-[{assign var="gtmCategory" value=$oView->getActiveCategory()}]
-
-[{assign var="breadCrumb" value=''}]
-
-[{block name="d3_ga4_view_item_list_block"}]
-    [{if $gtmProducts|@count}]
-        [{capture assign=d3_ga4_view_item_list}]
-            [{strip}]
-                dataLayer.push({ecommerce: null});
-                dataLayer.push({
-                    'event':'view_item_list',
-                    'event_name': 'view_item_list',
-                    'ecommerce': {
-                        'item_list_id': '[{$oView->getCategoryId()}]',
-                        'item_list_name': '[{foreach from=$oView->getBreadCrumb() item=sCrum}][{if $sCrum.title }][{$breadCrumb|cat:$sCrum.title|cat:" > "}][{/if}][{/foreach}]',
-                        'items': [
-                            [{foreach from=$gtmProducts name="gtmProducts" item="gtmProduct"}]
-                            [{assign var="d3PriceObject" value=$gtmProduct->getPrice()}]
-                            [{assign var="gtmManufacturer" value=$gtmProduct->getManufacturer()}]
-                            [{if !$gtmCategory}][{assign var="gtmCategory" value=$gtmProduct->getCategory()}][{/if}]
-                            {
-                                'item_id': '[{$gtmProduct->getFieldData("oxartnum")}]',
-                                'item_name': '[{$gtmProduct->getFieldData("oxtitle")}]',
-                                'price': [{$d3PriceObject->getPrice()}],
-                                'item_brand': '[{if $gtmManufacturer}][{$gtmManufacturer->oxmanufacturers__oxtitle->value}][{/if}]',
-                                [{if $gtmCategory}]
-                                'item_category':  '[{$gtmCategory->getSplitCategoryArray(0)}]',
-                                'item_category_2':'[{$gtmCategory->getSplitCategoryArray(1)}]',
-                                'item_category_3':'[{$gtmCategory->getSplitCategoryArray(2)}]',
-                                'item_category_4':'[{$gtmCategory->getSplitCategoryArray(3)}]',
-                                [{/if}]
-                                'quantity': 1
-                            }[{if !$smarty.foreach.gtmProducts.last}],[{/if}]
-                            [{/foreach}]
-                        ]
-                    }[{if $oViewConf->isDebugModeOn()}],
-                    'debug_mode': 'true'
-                    [{/if}]
-                });
-            [{/strip}]
-        [{/capture}]
-        [{oxscript add=$d3_ga4_view_item_list}]
-    [{/if}]
+[{$smarty.block.parent}]
+[{assign var="gtmProducts" value=$oView->getArticleList()}]
+[{assign var="gtmCategory" value=$oView->getActiveCategory()}]
+
+[{assign var="breadCrumb" value=''}]
+
+[{block name="d3_ga4_view_item_list_block"}]
+    [{if $gtmProducts|@count}]
+        [{capture assign=d3_ga4_view_item_list}]
+            [{strip}]
+                dataLayer.push({ecommerce: null});
+                dataLayer.push({
+                    'event':'view_item_list',
+                    'event_name': 'view_item_list',
+                    'ecommerce': {
+                        'item_list_id': '[{$oView->getCategoryId()}]',
+                        'item_list_name': '[{foreach from=$oView->getBreadCrumb() item=sCrum}][{if $sCrum.title }][{$breadCrumb|cat:$sCrum.title|cat:" > "}][{/if}][{/foreach}]',
+                        'items': [
+                            [{foreach from=$gtmProducts name="gtmProducts" item="gtmProduct"}]
+                            [{assign var="d3PriceObject" value=$gtmProduct->getPrice()}]
+                            [{assign var="gtmManufacturer" value=$gtmProduct->getManufacturer()}]
+                            [{if !$gtmCategory}][{assign var="gtmCategory" value=$gtmProduct->getCategory()}][{/if}]
+                            {
+                                'item_id': '[{$gtmProduct->getFieldData("oxartnum")}]',
+                                'item_name': '[{$gtmProduct->getFieldData("oxtitle")}]',
+                                'price': [{$d3PriceObject->getPrice()}],
+                                'item_brand': '[{if $gtmManufacturer}][{$gtmManufacturer->oxmanufacturers__oxtitle->value}][{/if}]',
+                                [{if $gtmCategory}]
+                                'item_category':  '[{$gtmCategory->getSplitCategoryArray(0)}]',
+                                'item_category_2':'[{$gtmCategory->getSplitCategoryArray(1)}]',
+                                'item_category_3':'[{$gtmCategory->getSplitCategoryArray(2)}]',
+                                'item_category_4':'[{$gtmCategory->getSplitCategoryArray(3)}]',
+                                [{/if}]
+                                'quantity': 1
+                            }[{if !$smarty.foreach.gtmProducts.last}],[{/if}]
+                            [{/foreach}]
+                        ]
+                    }[{if $oViewConf->isDebugModeOn()}],
+                    'debug_mode': 'true'
+                    [{/if}]
+                });
+            [{/strip}]
+        [{/capture}]
+        [{oxscript add=$d3_ga4_view_item_list}]
+    [{/if}]
 [{/block}]

CHANGELOG.md

@@ -4,18 +4,115 @@ 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.11.1](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.11.0...1.11.1) - 2023-08-17
-### Fixed
-- metadata class entry
-
-## [1.11.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.10.0...1.11.0) - 2023-08-16
+## [2.11.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.10.1...2.11.0) - 2023-08-23
 ### Added
-- remove_from_cart
-- auto debug_mode setter
-- manufacturer extension for breadcrumb
+- manufacturer extension
+- working debug_mode
 ### Changed
+- check for 'article has been removed'
 - general template cleanup
 
+## [2.10.1](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.10.0...2.10.1) - 2023-08-03
+### Added
+- missing param to identify the event
+
+## [2.10.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.9.2...2.10.0) - 2023-08-02
+### Added
+- new Event "remove_from_cart"
+
+## [2.9.2](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.9.1...2.9.2) - 2023-06-29
+### Fixed
+- wrong variable for category-object check
+
+## [2.9.1](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.9.0...2.9.1) - 2023-06-27
+### Fixed
+- deny method call on no category
+
+## [2.9.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/2.8.0...2.9.0) - 2023-06-27
+### Added
+- Cookiefirst usability
+
+## [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
+### Changed
+- all used template-files have a more dedicated name
+- general code cleanup
+
+## [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.10.0](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.9.0...1.10.0) - 2023-06-27
 ### Added
 - Following Entries to dedicated event-templates

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
@@ -23,10 +23,6 @@ Für den geregelten Ablauf sind folgende Blöcke nötig:
     - Blockname: details_productmain_tobasket
     - Datei: page/details/inc/productmain.tpl
     - GA4 Event: add_to_cart
-- aus dem WK entfernen
-    - Blockname: checkout_basket_main
-    - Datei: page/checkout/basket.tpl
-    - GA4 Event: remove_from_cart
 - Warenkorb
     - Blockname: checkout_basket_main
     - Datei: page/checkout/basket.tpl

IntelliSenseHelper.php

@@ -24,5 +24,4 @@ namespace D3\GoogleAnalytics4\Modules\Application\Model{
 
 namespace D3\GoogleAnalytics4\Modules\Application\Controller{
     class BasketController_parent extends \OxidEsales\Eshop\Application\Controller\BasketController {}
-    class ThankYouController_parent extends \OxidEsales\Eshop\Application\Controller\ThankYouController {}
 }

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/Application/Controller/ThankYouController.php

@@ -1,22 +0,0 @@
-<?php
-
-namespace D3\GoogleAnalytics4\Modules\Application\Controller;
-
-use OxidEsales\Eshop\Application\Model\Country;
-
-class ThankYouController extends ThankYouController_parent
-{
-    /**
-     * @return Country
-     */
-    public function d3GAGetUserCountry()
-    {
-        $sCountryId = $this->getOrder()->getFieldData('oxbillcountryid');
-
-        /** @var Country $oCountry */
-        $oCountry = oxNew(Country::class);
-        $oCountry->load($sCountryId);
-
-        return $oCountry;
-    }
-}

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;
     }
@@ -152,7 +157,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

@@ -1,56 +1,56 @@
-{
-  "name": "d3/google-analytics4",
-  "description": "Google Tag Manager with new Google Analytics 4 for OXID eShop v6",
-  "type": "oxideshop-module",
-  "keywords": [
-    "oxid",
-    "modules",
-    "eShop",
-    "d3",
-    "google",
-    "ga4",
-    "googleanalytics",
-    "gtm",
-    "configuration"
-  ],
-  "homepage": "https://www.d3data.de",
-  "license": [
-    "GPL-3.0"
-  ],
-  "authors": [
-    {
-      "name": "Marat Bedoev",
-      "email": "hello@mb-dev.pro"
-    },
-    {
-      "name": "D3 Data Development (Inh. Thomas Dartsch)",
-      "email": "info@shopmodule.com",
-      "homepage": "https://www.d3data.de"
-    }
-  ],
-  "support": {
-    "email": "support@shopmodule.com"
-  },
-  "extra": {
-    "oxideshop": {
-      "blacklist-filter": [
-        "*.md",
-        "composer.json",
-        ".php-cs-fixer.php",
-        "*.xml",
-        "*.neon"
-      ],
-      "target-directory": "d3/googleanalytics4"
-    }
-  },
-  "require": {
-    "php": ">=7.1",
-    "oxid-esales/oxideshop-ce": "v6.0 - 6.3",
-    "google/apiclient":" ^2.0"
-  },
-  "autoload": {
-    "psr-4": {
-      "D3\\GoogleAnalytics4\\": "../../../source/modules/d3/googleanalytics4"
-    }
-  }
+{
+  "name": "d3/google-analytics4",
+  "description": "Google Tag Manager with new Google Analytics 4 for OXID eShop v6",
+  "type": "oxideshop-module",
+  "keywords": [
+    "oxid",
+    "modules",
+    "eShop",
+    "d3",
+    "google",
+    "ga4",
+    "googleanalytics",
+    "gtm",
+    "configuration"
+  ],
+  "homepage": "https://www.d3data.de",
+  "license": [
+    "GPL-3.0"
+  ],
+  "authors": [
+    {
+      "name": "Marat Bedoev",
+      "email": "hello@mb-dev.pro"
+    },
+    {
+      "name": "D3 Data Development (Inh. Thomas Dartsch)",
+      "email": "info@shopmodule.com",
+      "homepage": "https://www.d3data.de"
+    }
+  ],
+  "support": {
+    "email": "support@shopmodule.com"
+  },
+  "extra": {
+    "oxideshop": {
+      "blacklist-filter": [
+        "*.md",
+        "composer.json",
+        ".php-cs-fixer.php",
+        "*.xml",
+        "*.neon"
+      ],
+      "target-directory": "d3/googleanalytics4"
+    }
+  },
+  "require": {
+    "php": ">=7.1",
+    "oxid-esales/oxideshop-ce": "^6.5",
+    "google/apiclient":" ^2.0"
+  },
+  "autoload": {
+    "psr-4": {
+      "D3\\GoogleAnalytics4\\": "../../../source/modules/d3/googleanalytics4"
+    }
+  }
 }

metadata.php

@@ -1,13 +1,11 @@
 <?php
 
 use D3\GoogleAnalytics4\Modules\Application\Controller\BasketController;
-use D3\GoogleAnalytics4\Modules\Application\Controller\ThankYouController;
 use D3\GoogleAnalytics4\Modules\Application\Model\Basket as Basket;
 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\Controller\BasketController as OEBasketController;
-use OxidEsales\Eshop\Application\Controller\ThankYouController as OEThankYouController;
 use OxidEsales\Eshop\Application\Model\Basket as OEBasket;
 use OxidEsales\Eshop\Application\Model\Category as OECategory;
 use OxidEsales\Eshop\Application\Model\Manufacturer as OEManufacturer;
@@ -28,17 +26,16 @@ $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'     => '2.11.0',
     'author'      => 'Data Development (Inh.: Thomas Dartsch)',
     'email'       => 'support@shopmodule.com',
     'url'         => 'https://www.oxidmodule.com/',
     'extend'      => [
         OEViewConfig::class => ViewConfig::class,
         OECategory::class => Category::class,
-        OEBasket::class => Basket::class,
-        OEBasketController::class => BasketController::class,
         OEManufacturer::class => Manufacturer::class,
-        OEThankYouController::class => ThankYouController::class
+        OEBasket::class => Basket::class,
+        OEBasketController::class => BasketController::class
     ],
     'templates'   => [],
     'blocks'      => [