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

Application/views/admin/de/module_options.php

@@ -30,7 +30,6 @@ $aLang = [
 
     // for cookie manager settings
     'SHOP_MODULE_GROUP_d3_gtm_settings_cookiemanager'   => 'Cookie Manager Einstellungen',
-    'SHOP_MODULE_d3_gtm_settings_hasOwnCookieManager'   => 'Eigenen Cookie Manager nutzen?
-                                                            <strong style="color: red">Hinweis (Fragezeichen) lesen!</strong>',
-    'SHOP_MODULE_d3_gtm_settings_cookieName'            => 'Cookie-Name',
+    'SHOP_MODULE_d3_gtm_settings_hasOwnCookieManager'   => 'Cookie Manager nutzen?',
+    'SHOP_MODULE_d3_gtm_settings_cookieName'            => 'CookieID',
 ];

Application/views/blocks/_impression.tpl

@@ -1,66 +0,0 @@
-[{$smarty.block.parent}]
-[{*
-[{strip}]
-    [{assign var="gtmProduct" value=$oView->getProduct()}]
-    [{assign var="gtmCategory" value=$gtmProduct->getCategory()}]
-    [{assign var="gtmManufacturer" value=$gtmProduct->getManufacturer()}]
-
-    [{if !$head }]
-        [{assign var=$head value=$oView->getViewParameter('head')}]
-    [{/if}]
-    <script>
-        var gtmItem = {
-            'id': '[{$gtmProduct->oxarticles__oxartnum->value}]',
-            'item_id': '[{$gtmProduct->oxarticles__oxartnum->value}]',
-
-            'name': '[{$gtmProduct->oxarticles__oxtitle->value}]',
-            'item_name': '[{$gtmProduct->oxarticles__oxtitle->value}]',
-
-            'variant': '[{if $gtmProduct->oxarticles__oxvarselect->value}][{$gtmProduct->oxarticles__oxvarselect->value}][{/if}]',
-            'item_variant': '[{if $gtmProduct->oxarticles__oxvarselect->value}][{$gtmProduct->oxarticles__oxvarselect->value}][{/if}]',
-
-            'brand': '[{if $gtmManufacturer}][{$gtmManufacturer->oxmanufacturers__oxtitle->value}][{/if}]',
-            'item_brand': '[{if $gtmManufacturer}][{$gtmManufacturer->oxmanufacturers__oxtitle->value}][{/if}]',
-
-            'price': [{$gtmProduct->oxarticles__oxprice->value}],
-
-            'category': '[{if $gtmCategory}][{$gtmCategory->getLink()|parse_url:5|ltrim:"/"|rtrim:"/"}][{else}]no category[{/if}]',
-            'item_category': '[{if $gtmCategory}][{$gtmCategory->getLink()|parse_url:5|ltrim:"/"|rtrim:"/"}][{else}]no category[{/if}]',
-
-            [{if $listId == 'productList' || $listId == 'categoryList'}]
-                /* category list */
-                'list': '[{$listId}]',
-                'item_list_id': '[{$listId}]',
-                'item_list_name': '[{$head}]',
-            [{elseif $listId}]
-                /* category list */
-                'list': '[{$listId}]',
-                'promotion_id': '[{$listId}]',
-                'promotion_name': '[{$head}]',
-            [{/if}]
-            'position': [{$iIndex}],
-            'index': [{$iIndex}],
-            'quantity': '1'
-        };
-        /* UA */
-        dataLayer.push({ ecommerce: null });
-        dataLayer.push({
-            'event': 'UA_event',
-            'event_name': 'Impression',
-            'ecommerce': {
-                'currencyCode': '[{$currency->name}]',
-                'impressions': [gtmItem]
-            }
-        });
-        /* GA4 */
-        dataLayer.push({ ecommerce: null });
-        dataLayer.push({
-            'event': 'GA4_event',
-            'event_name': 'view_item_list',
-            'ecommerce': {
-                'items': [gtmItem]
-            }
-        });
-    </script>
-[{/strip}]
-*}]

Application/views/blocks/add_to_cart.tpl

@@ -1,5 +0,0 @@
-[{if $oxcmp_basket->isNewItemAdded() && $smarty.session._newitem}]
-    <!-- [{$smarty.session._newitem|@var_dump}] -->
-    [{* include file="ga4_add_to_cart.tpl" gtmProduct=$smarty.session._newitem *}]
-[{/if}]
-[{$smarty.block.parent}]

Application/views/blocks/checkout_s2.tpl

@@ -1,18 +0,0 @@
-[{strip}]
-<script>
-    dataLayer.push({"event": null, "eventLabel": null, "ecommerce": null});  /* Clear the previous ecommerce object. */
-    dataLayer.push({
-        'event':'ee.checkout',
-        'eventLabel':'Checkout Step 2',
-        'ecommerce': {
-            'checkout': {
-                'actionField': {
-                    'step': 2,
-                    'option':'[{oxmultilang ident="vt_GTM_EE_LOGINOPTION"|cat:$oView->getLoginOption()}]'
-                }
-            }
-        }
-    });
-</script>
-[{/strip}]
-[{$smarty.block.parent}]

Application/views/blocks/checkout_s3.tpl

@@ -1,9 +0,0 @@
-<script>
-    dataLayer.push({"event": null, "eventLabel": null, "ecommerce": null});  /* Clear the previous ecommerce object. */
-    dataLayer.push({
-        'event': 'ee.checkout',
-        'eventLabel': 'Checkout Step 3',
-        'ecommerce': {'checkout': {'actionField': {'step': 3}}}
-    });
-</script>
-[{$smarty.block.parent}]

Application/views/blocks/checkout_s4.tpl

@@ -1,9 +0,0 @@
-<script>
-    dataLayer.push({"event": null, "eventLabel": null, "ecommerce": null});  /* Clear the previous ecommerce object. */
-    dataLayer.push({
-        "event": "ee.checkout",
-        'eventLabel': 'Checkou Step 4',
-        "ecommerce": {"checkout": {"actionField": {"step": 4}}}
-    });
-</script>
-[{$smarty.block.parent}]

Application/views/blocks/detail.tpl

@@ -1,25 +0,0 @@
-[{$smarty.block.parent}]
-[{assign var="gtmProduct" value=$oView->getProduct()}]
-[{assign var="gtmCategory" value=$gtmProduct->getCategory()}]
-[{assign var="gtmManufacturer" value=$gtmProduct->getManufacturer()}]
-
-<script>
-    dataLayer.push({"event": null, "eventLabel": null, "ecommerce": null});  /* Clear the previous ecommerce object. */
-    dataLayer.push({
-        'event': 'view_item',
-        'eventLabel':'Product View',
-        'ecommerce': {
-            'currency': '[{$currency->name}]',
-            'items': [
-                {
-                    'item_name': '[{$gtmProduct->oxarticles__oxtitle->value}]',
-                    'item_id': '[{$gtmProduct->oxarticles__oxartnum->value}]',
-                    'item_brand': '[{if $gtmManufacturer}][{$gtmManufacturer->oxmanufacturers__oxtitle->value}][{/if}]',
-                    'item_category': '[{if $gtmCategory}][{$gtmCategory->getLink()|parse_url:5|ltrim:"/"|rtrim:"/"}][{else}]-[{/if}]',
-                    'item_variant': '[{if $gtmProduct->oxarticles__oxvarselect->value}][{$gtmProduct->oxarticles__oxvarselect->value}][{/if}]',
-                    'price': [{$gtmProduct->oxarticles__oxprice->value}]
-                }
-            ]
-        }
-    });
-</script>

Application/views/blocks/widget_product_list.tpl

@@ -1,37 +0,0 @@
-[{$smarty.block.parent}]
-[{assign var="gtmProduct" value=$oView->getProduct()}]
-[{if $gtmProduct}]
-    [{assign var="gtmCategory" value=$gtmProduct->getCategory()}]
-    [{assign var="gtmManufacturer" value=$gtmProduct->getManufacturer()}]
-    <script>
-      dataLayer.push({"event": null, "eventLabel": null, "ecommerce": null});  /* Clear the previous ecommerce object. */
-      dataLayer.push({
-        'event': 'ee.impression',
-        'eventLabel':'Impression',
-        'ecommerce': {
-          'currencyCode': '[{$currency->name}]',
-          'impressions': [
-            {
-              'name': '[{$gtmProduct->getFieldData('oxtitle')}]',
-              'id': '[{$gtmProduct->getFieldData('oxartnum')}]',
-              'price': [{$gtmProduct->getFieldData('oxprice')}],
-              'brand': '[{if $gtmManufacturer}][{$gtmManufacturer->getFieldData('oxtitle')}][{/if}]',
-              'category': '[{if $gtmCategory}][{$gtmCategory->getLink()|parse_url:5|ltrim:"/"|rtrim:"/"}][{else}]-[{/if}]',
-              'variant': '[{if $gtmProduct->getFieldData('oxvarselect')}][{$gtmProduct->getFieldData('oxvarselect')}][{/if}]'
-                  [{if $list && $position}],
-              'list': '[{$list}]',
-              'position': [{"_"|str_replace:"":$position}]
-                  [{/if}]
-            }
-          ]
-        }
-      });
-    </script>
-<!--
-sWidgetType [{$sWidgetType}] | [{$oView->getViewParameter('sWidgetType')}]
-sListType [{$sListType}] | [{$oView->getViewParameter('sListType')}]
-iIndex [{$iIndex}] | [{$oView->getViewParameter('iIndex')}]
-listId [{$listId}] | [{$oView->getViewParameter('listId')}]
-testid [{$testid}] | [{$oView->getViewParameter('testid')}]
--->
-[{/if}]

Application/views/ga4/purchase.tpl

@@ -1,36 +0,0 @@
-[{strip}]
-    <script type="text/javascript">
-      window.dataLayer = window.dataLayer || [];
-      dataLayer.push({ ecommerce: null });
-      dataLayer.push({
-        [{assign var="oBasket" value=$order->getBasket()}]
-        [{assign var="iVat" value=0}]
-
-        'event':'purchase',
-        'ecommerce':{
-          'purchase':{
-            'actionField':{
-              'id': [{$order->getFieldData('oxordernr')}],
-              'ordernr': [{$order->getFieldData('oxtotalordersum')}],
-              'tax': [{$order->d3GetSumOrderVat()}],
-              'shipping': [{$order->getFieldData('oxdelcost')}],
-              'currency': "[{$order->getFieldData('oxcurrency')}]"
-            },
-            'products':[
-              [{foreach from=$order->getOrderArticles() item=listItem}]
-                  [{assign var="orderArticle" value=$listItem->getArticle()}]
-              {
-                'item_id':    "[{$listItem->getFieldData('oxartnum')}]",
-                'item_name':  "[{$listItem->getFieldData('oxtitle')}]",
-                'currency':   "[{$order->getFieldData('oxcurrency')}]",
-                'articleVat':   [{$orderArticle->getArticleVat()}],
-                'price':      [{$orderArticle->getBasePrice()}],
-                'quantity':   [{$listItem->getFieldData('oxamount')}]
-              },
-              [{/foreach}]
-            ]
-          }
-        }
-      });
-    </script>
-[{/strip}]

Application/views/ga4/view_item.tpl

@@ -1,26 +0,0 @@
-[{strip}]
-    [{* variable $gtmProduct is passed from parent tempalte *}]
-    [{assign var="gtmCurrency" value=$oView->getActCurrency()}]
-    [{assign var="gtmManufacturer" value=$gtmProduct->getManufacturer()}]
-    [{assign var="gtmCategory" value=$gtmProduct->getCategory()}]
-    <script type="text/javascript">
-        dataLayer.push({ecommerce: null});
-        dataLayer.push({
-            'event':'GA4_event',
-            'event_name': 'view_item',
-            'ecommerce': {
-                'items': [
-                    {
-                        'item_id': '[{$gtmProduct->getFieldData("oxartnum")}]',
-                        'item_name': '[{$gtmProduct->getFieldData("oxtitle")}]',
-                        'item_variant': '[{if $gtmProduct->oxarticles__oxvarselect->value}][{$gtmProduct->oxarticles__oxvarselect->value}][{/if}]',
-                        'price': [{$gtmProduct->oxarticles__oxprice->value|default:0}],
-                        'item_brand': '[{if $gtmManufacturer}][{$gtmManufacturer->oxmanufacturers__oxtitle->value}][{/if}]',
-                        'item_category': '[{if $gtmCategory}][{$gtmCategory->getLink()|parse_url:5|ltrim:"/"|rtrim:"/"}][{else}]-[{/if}]',
-                        'quantity': '1'
-                    }
-                ]
-            }
-        });
-    </script>
-[{/strip}]

CHANGELOG.md

@@ -4,6 +4,13 @@ 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.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
@@ -26,6 +33,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - using of ContainerFactory in ViewConfig
 
+## [1.3.1](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.2.1...1.3.1) - 2023-03-17
+### Added
+- Aggrosoft-Cookie-Consent compatibility
+### Fixed
+- wrong function for pageview on thankyou page
+
 ## [1.2.1](https://git.d3data.de/D3Public/GoogleAnalytics4/compare/1.2...1.2.1) - 2023-02-22
 ### Fixed
 - price formatting view_cart

Docs/README.md

@@ -1,11 +1,11 @@
-## Technische Doku
-### GA4 Events / Customizing
+# Technische Doku
+## GA4 Events / Customizing
 Für alle implementierten GA4 Events existieren Templates unter `source/modules/d3/googleanalytics4/Application/views/ga4/`, dabei entspricht der Dateiname dem Eventnamen in GA4.
 Die Einbindung dieser Event-Templates erfolgt über TPL-Blöcke unter `source/modules/d3/googleanalytics4/Application/views/blocks/`.  
 *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/
 
-### Blöcke
+## Blöcke
 Für den geregelten Ablauf sind folgende Blöcke nötig:
 - Suchergebnisse
     - Blockname: search_results
@@ -32,7 +32,7 @@ Für den geregelten Ablauf sind folgende Blöcke nötig:
     - Datei: page/checkout/thankyou.tpl
     - GA4 Event: purchase
 
-### Verfügbare Datalayer Variablen
+## Verfügbare Datalayer Variablen
 Für die einfachste Übersicht der enthaltenen Daten empfehle ich den Vorschau-Modus vom Google Tag Manager.
 
 Bei jedem Seitenaufruf wird die Datenschicht mit einigen wenigen Infos erstellt, die man zum reinen Erfassen der Seitenaufrufe benötigt:
@@ -44,8 +44,22 @@ Bei jedem Seitenaufruf wird die Datenschicht mit einigen wenigen Infos erstellt,
 
 Alle für Ecommerce Tracking relevanten Daten werden mit speziellen Ecommerce Events in die Datenschicht eingefügt.
 
-### Cookie-Handling
+## Cookie-Handling
 Sie nutzen einen eigenen, als Modul im Shop installierten, Cookie-manager?  
 Dann tragen Sie in den Folgeeinstellungen unter "Cookie Manager Einstellungen", 
-die Cookie-ID des zugehörigen Cookies ein. Und aktivieren Sie diese Weiche, 
-indem Sie den Haken bei "Eigenen Cookie Manager nutzen?" setzen.
+die Cookie-ID des zugehörigen Cookies ein.  
+Aktivieren Sie anschließend diese Weiche. Setzen Sie den Haken bei "Eigenen Cookie Manager nutzen?".
+
+### Unterstützung für
+- [aggrosoft - oxid-cookie-compliance](https://github.com/aggrosoft/oxid-cookie-compliance)
+  - https://github.com/aggrosoft/oxid-cookie-compliance
+  - die entsprechend gewählte Kategorie in den Moduleinstellungen des 'Google Analytics 4' unter
+  ```Einstell. > Cookie Manager Einstellungen > Cookie-ID``` eintragen
+
+- [Netensio - Cookie Consent Manager](https://www.netensio.de/oxid-eshop-module/cookie-consent-manager-fuer-oxid-eshop.html)
+  - Modul entsprechend konfigurieren
+  - CookieID des angelegten Cookies in den Moduleinstellungen des 'Google Analytics 4' unter
+    ```Einstell. > Cookie Manager Einstellungen > Cookie-ID``` eintragen
+  
+- [OXID Cookie Management powered by usercentrics](https://docs.oxid-esales.com/modules/usercentrics/de/latest/einfuehrung.html)
+  - soweit ich weiß nichts weiter?

Modules/Core/ViewConfig.php

@@ -48,6 +48,11 @@ class ViewConfig extends ViewConfig_parent
             return true;
         }
 
+        // Aggrosoft Cookie Consent
+        if (method_exists($this, "isCookieCategoryEnabled")) {
+            return $this->isCookieCategoryEnabled($sCookieID);
+        }
+
         return false;
     }
 
@@ -75,7 +80,7 @@ class ViewConfig extends ViewConfig_parent
         /** @var FrontendController $oShop */
         $oUser = $oConfig->getUser();
 
-        $cl         = $this->getTopActionClassName();
+        $cl         = $this->getTopActiveClassName();
         $aPageTypes = [
             "content"  => "cms",
             "details"  => "product",
@@ -86,6 +91,7 @@ class ViewConfig extends ViewConfig_parent
             "payment"  => "checkout",
             "order"    => "checkout",
             "thankyou" => "checkout",
+            "start"    => "start",
         ];
 
         $dataLayer = [

README.md

@@ -77,5 +77,6 @@ Die vollständigen Copyright- und Lizenzinformationen entnehmen Sie bitte der [L
 Zu diesem Modul haben beigetragen:
 
 - [Marat Bedoev](https://github.com/vanilla-thunder)
+- [Christoph Stäblein [gn2]](https://github.com/reyneke-vosz)
 
 Vielen Dank.

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'     => '2.2.2',
+    'version'     => '2.3.2',
     'author'      => 'Data Development (Inh.: Thomas Dartsch)',
     'email'       => 'support@shopmodule.com',
     'url'         => 'https://www.oxidmodule.com/',
@@ -26,23 +26,9 @@ $aModule          = [
     ],
     'templates'   => [
         // GA4 events
-        'ga4_add_payment_info.tpl' => 'd3/googleanalytics4/Application/views/ga4/add_payment_info.tpl',
-        'add_shipping_info.tpl'    => 'd3/googleanalytics4/Application/views/ga4/add_shipping_info.tpl',
         'ga4_add_to_cart.tpl'      => 'd3/googleanalytics4/Application/views/ga4/add_to_cart.tpl',
-        'ga4_begin_checkout.tpl'   => 'd3/googleanalytics4/Application/views/ga4/begin_checkout.tpl',
-        'ga4_generate_lead.tpl'    => 'd3/googleanalytics4/Application/views/ga4/generate_lead.tpl',
-        'ga4_login.tpl'            => 'd3/googleanalytics4/Application/views/ga4/login.tpl',
-        'ga4_purchase.tpl'         => 'd3/googleanalytics4/Application/views/ga4/purchase.tpl',
-        'ga4_remove_from_cart.tpl' => 'd3/googleanalytics4/Application/views/ga4/remove_from_cart.tpl',
         'ga4_search.tpl'           => 'd3/googleanalytics4/Application/views/ga4/search.tpl',
-        'ga4_select_content.tpl'   => 'd3/googleanalytics4/Application/views/ga4/select_content.tpl',
-        'ga4_select_item.tpl'      => 'd3/googleanalytics4/Application/views/ga4/select_item.tpl',
-        'ga4_select_promotion.tpl' => 'd3/googleanalytics4/Application/views/ga4/select_promotion.tpl',
-        'ga4_sign_up.tpl'          => 'd3/googleanalytics4/Application/views/ga4/sign_up.tpl',
-        'ga4_view_cart.tpl'        => 'd3/googleanalytics4/Application/views/ga4/view_cart.tpl',
-        'ga4_view_item.tpl'        => 'd3/googleanalytics4/Application/views/ga4/view_item.tpl',
         'ga4_view_item_list.tpl'   => 'd3/googleanalytics4/Application/views/ga4/view_item_list.tpl',
-        'ga4_view_promotion.tpl'   => 'd3/googleanalytics4/Application/views/ga4/view_promotion.tpl',
     ],
     'blocks'      => [
         // tag manager js
@@ -71,36 +57,12 @@ $aModule          = [
             'position' => 150
         ],
         // checkout
+        // view_cart
         [
             'template' => 'page/checkout/basket.tpl',
             'block'    => 'checkout_basket_main',
             'file'     => '/Application/views/blocks/checkout_s1.tpl'
-        ],
-        [
-            'template' => 'form/user_checkout_change.tpl',
-            'block'    => 'user_checkout_change',
-            'file'     => '/Application/views/blocks/checkout_s2.tpl'
-        ],
-        [
-            'template' => 'form/user_checkout_register.tpl',
-            'block'    => 'user_checkout_register',
-            'file'     => '/Application/views/blocks/checkout_s2.tpl'
-        ],
-        [
-            'template' => 'form/user_checkout_noregister.tpl',
-            'block'    => 'user_checkout_noregister',
-            'file'     => '/Application/views/blocks/checkout_s2.tpl'
-        ],
-        [
-            'template' => 'page/checkout/payment.tpl',
-            'block'    => 'checkout_payment_main',
-            'file'     => '/Application/views/blocks/checkout_s3.tpl'
-        ],
-        [
-            'template' => 'page/checkout/order.tpl',
-            'block'    => 'checkout_order_main',
-            'file'     => '/Application/views/blocks/checkout_s4.tpl'
-        ],
+        ],        
         [
             'template' => 'page/checkout/thankyou.tpl',
             'block'    => 'checkout_thankyou_main',