bump changelog && version to 2.10.1

deny method-call on no category

Application/Model/ManagerTypes.php

@@ -34,6 +34,8 @@ class ManagerTypes
 
     const CONSENTMANAGER            = "CONSENTMANAGER";
 
+    const COOKIEFIRST               = "COOKIEFIRST";
+
     /**
      * @return array
      */
@@ -45,7 +47,8 @@ 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,10 +31,17 @@ $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>
+                                                                        <a href="https://consentmanager.net/">Consentmanager</a><br>
+                                                                        <a href="https://usercentrics.com/">Usercentrics</a><br>
+                                                                        <a href="https://cookiefirst.com">Cookiefirst</a><br>
+                                                                        
+                                                                        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',
 ];

Application/views/blocks/purchase.tpl

@@ -32,11 +32,13 @@
                         'affiliation':      '[{$gtmBasketItem->getFieldData("oxtitle")}]',
                         'coupon':           '[{foreach from=$gtmOrderVouchers item="gtmOrderVoucher" name="gtmOrderVoucherIteration"}][{$gtmOrderVoucher}][{if !$smarty.foreach.gtmOrderVoucherIteration.last}], [{/if}][{/foreach}]',
                         'item_variant':     '[{$gtmBasketItem->getFieldData("oxselvariant")}]',
+                        [{if $gtmPurchaseItemCategory}]
                         'item_category':    '[{$gtmPurchaseItemCategory->getSplitCategoryArray(0)}]',
                         'item_category_2':  '[{$gtmPurchaseItemCategory->getSplitCategoryArray(1)}]',
                         'item_category_3':  '[{$gtmPurchaseItemCategory->getSplitCategoryArray(2)}]',
                         'item_category_4':  '[{$gtmPurchaseItemCategory->getSplitCategoryArray(3)}]',
                         'item_list_name':   '[{$gtmPurchaseItemCategory->getSplitCategoryArray()}]',
+                        [{/if}]
                         'price':            [{$gtmPurchaseItemPriceObject->getPrice()}],
                         'quantity':         [{$gtmBasketItem->getFieldData("oxamount")}],
                         'position':         [{$smarty.foreach.gtmArticles.iteration}]

Application/views/blocks/view_cart.tpl

@@ -24,11 +24,13 @@
                         'item_id':          '[{$gtmCartArticles[$basketindex]->getFieldData('oxartnum')}]',
                         'item_name':        '[{$gtmCartArticles[$basketindex]->getFieldData('oxtitle')}]',
                         'item_variant':     '[{$gtmCartArticles[$basketindex]->getFieldData('oxvarselect')}]',
+                        [{if $gtmBasketItemCategory}]
                         'item_category':    '[{$gtmBasketItemCategory->getSplitCategoryArray(0)}]',
                         'item_category_2':  '[{$gtmBasketItemCategory->getSplitCategoryArray(1)}]',
                         'item_category_3':  '[{$gtmBasketItemCategory->getSplitCategoryArray(2)}]',
                         'item_category_4':  '[{$gtmBasketItemCategory->getSplitCategoryArray(3)}]',
                         'item_list_name':   '[{$gtmBasketItemCategory->getSplitCategoryArray()}]',
+                        [{/if}]
                         'price':            [{$d3oItemPrice->getPrice()}],
                         'coupon':           '[{foreach from=$oxcmp_basket->getVouchers() item=sVoucher key=key name=Voucher}][{$sVoucher->sVoucherNr}][{if !$smarty.foreach.Voucher.last}], [{/if}][{/foreach}]',
                         'quantity':         [{$basketitem->getAmount()}],

Application/views/blocks/view_item.tpl

@@ -17,11 +17,13 @@
           'item_id': '[{$gtmProduct->getFieldData("oxartnum")}]',
           'item_brand': '[{if $gtmManufacturer}][{$gtmManufacturer->oxmanufacturers__oxtitle->value}][{/if}]',
           'item_variant': '[{if $gtmProduct->getFieldData("oxvarselect")}][{$gtmProduct->getFieldData("oxvarselect")}][{/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)}]',
           'item_list_name':'[{$gtmCategory->getSplitCategoryArray()}]',
+          [{/if}]
           [{assign var="d3PriceObject" value=$gtmProduct->getPrice()}]
           'price': [{$d3PriceObject->getPrice()}]
         }

Application/views/ga4/add_to_cart.tpl

@@ -30,11 +30,13 @@
         'price':          [{$d3PriceObject->getPrice()}],
         'item_brand':     '[{if $gtmManufacturer}][{$gtmManufacturer->oxmanufacturers__oxtitle->value}][{/if}]',
         'item_variant':   '[{if $gtmProduct->getFieldData('oxvarselect')}][{$gtmProduct->getFieldData('oxvarselect')}][{/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)}]',
         'item_list_name':'[{$gtmCategory->getSplitCategoryArray()}]',
+        [{/if}]
         'quantity': iArtQuantity
         }
       ]

Application/views/ga4/remove_from_cart.tpl

@@ -0,0 +1,45 @@
+[{$smarty.block.parent}]
+
+[{assign var="d3BasketPrice" value=$oxcmp_basket->getPrice()}]
+
+[{if $hasBeenReloaded}]
+    [{strip}]
+            [{capture assign=d3_ga4_view_cart}]
+                dataLayer.push({"event": null, "eventLabel": null, "ecommerce": null});  /* Clear the previous ecommerce object. */
+                dataLayer.push({
+                    'isRemoveFromCart': true,
+                    'event': 'remove_from_cart',
+                    'eventLabel':'remove_from_cart',
+                    'ecommerce': {
+                        'actionField': "step: 1",
+                        'currency': "[{$currency->name}]",
+                        'value': [{$d3BasketPrice->getPrice()}],
+                        'coupon':         '[{foreach from=$oxcmp_basket->getVouchers() item=sVoucher key=key name=Voucher}][{$sVoucher->sVoucherNr}][{if !$smarty.foreach.Voucher.last}], [{/if}][{/foreach}]',
+                        'items': [
+                            [{foreach from=$toRemoveArticles->getArray() name=gtmRemovedItems item=rmItem  key=rmItemindex}]
+                            [{assign var="d3oItemPrice" value=$rmItem->getPrice()}]
+                            [{assign var="gtmBasketItemCategory" value=$rmItem->getCategory()}]
+                            {
+                            'item_id':          '[{$rmItem->getFieldData('oxartnum')}]',
+                            'item_name':        '[{$rmItem->getFieldData('oxtitle')}]',
+                            'item_variant':     '[{$rmItem->getFieldData('oxvarselect')}]',
+                            [{if $gtmBasketItemCategory}]
+                            'item_category':    '[{$gtmBasketItemCategory->getSplitCategoryArray(0)}]',
+                            'item_category_2':  '[{$gtmBasketItemCategory->getSplitCategoryArray(1)}]',
+                            'item_category_3':  '[{$gtmBasketItemCategory->getSplitCategoryArray(2)}]',
+                            'item_category_4':  '[{$gtmBasketItemCategory->getSplitCategoryArray(3)}]',
+                            'item_list_name':   '[{$gtmBasketItemCategory->getSplitCategoryArray()}]',
+                            [{/if}]
+                            'price':            [{$d3oItemPrice->getPrice()}],
+                            'coupon':           '[{foreach from=$oxcmp_basket->getVouchers() item=sVoucher key=key name=Voucher}][{$sVoucher->sVoucherNr}][{if !$smarty.foreach.Voucher.last}], [{/if}][{/foreach}]',
+                            'quantity':         '[{$rmItem->getFieldData('d3AmountThatGotRemoved')}]',
+                            'position':         [{$smarty.foreach.gtmRemovedItems.index}]
+                            }[{if !$smarty.foreach.gtmRemovedItems.last}],[{/if}]
+                            [{/foreach}]
+                        ]
+                    }
+                });
+            [{/capture}]
+    [{/strip}]
+    [{oxscript add=$d3_ga4_view_cart}]
+[{/if}]

Application/views/ga4/view_item_list.tpl

@@ -25,10 +25,12 @@
                         '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}]

Application/views/ga4/view_search_result.tpl

@@ -21,11 +21,13 @@
               '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)}]',
               'item_list_name':'[{$gtmCategory->getSplitCategoryArray()}]',
+              [{/if}]
               'quantity': 1
             }[{if !$smarty.foreach.gtmProducts.last}],[{/if}]
             [{/foreach}]

CHANGELOG.md

@@ -4,6 +4,26 @@ 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.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
@@ -85,6 +105,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### 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
+  - 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
+- general template 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
+### Changed
+- add_to_cart event template-structure
+
 ## [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

IntelliSenseHelper.php

@@ -20,4 +20,8 @@ namespace D3\GoogleAnalytics4\Modules\Core{
 namespace D3\GoogleAnalytics4\Modules\Application\Model{
     class Category_parent extends \OxidEsales\Eshop\Application\Model\Category {}
     class Basket_parent extends \OxidEsales\Eshop\Application\Model\Basket {}
+}
+
+namespace D3\GoogleAnalytics4\Modules\Application\Controller{
+    class BasketController_parent extends \OxidEsales\Eshop\Application\Controller\BasketController {}
 }

Modules/Application/Controller/BasketController.php

@@ -0,0 +1,103 @@
+<?php
+
+namespace D3\GoogleAnalytics4\Modules\Application\Controller;
+
+use OxidEsales\Eshop\Application\Component\BasketComponent;
+use OxidEsales\Eshop\Application\Model\Article;
+use OxidEsales\Eshop\Application\Model\ArticleList;
+use OxidEsales\Eshop\Core\Registry;
+use oxSystemComponentException;
+
+class BasketController extends BasketController_parent
+{
+    /**
+     * @throws oxSystemComponentException
+     */
+    public function render()
+    {
+        $return = parent::render();
+
+        $this->d3GA4getRemovedArticlesListObject();
+
+        return $return;
+    }
+
+    /**
+     * @return void
+     * @throws oxSystemComponentException
+     */
+    public function d3GA4getRemovedArticlesListObject() :void
+    {
+        $this->addTplParam('hasBeenReloaded', false);
+        // collecting items to add
+        $aProducts = Registry::getRequest()->getRequestEscapedParameter('aproducts');
+
+        // collecting specified item
+        $sProductId = $sProductId ?? Registry::getRequest()->getRequestEscapedParameter('aid');
+        if ($sProductId) {
+            // additionally fetching current product info
+            $dAmount = $dAmount ?? Registry::getRequest()->getRequestEscapedParameter('am');
+
+            // select lists
+            $aSel = $aSel ?? Registry::getRequest()->getRequestEscapedParameter('sel');
+
+            // persistent parameters
+            if (empty($aPersParam)) {
+
+                /** @var BasketComponent $oBasketComponent */
+                $oBasketComponent = $this->getComponent('oxcmp_basket');
+
+                $aPersParam = $oBasketComponent->__call('getPersistedParameters', []);
+            }
+
+            $sBasketItemId = Registry::getRequest()->getRequestEscapedParameter('bindex');
+
+            $aProducts[$sProductId] = ['am'           => $dAmount,
+                'sel'          => $aSel,
+                'persparam'    => $aPersParam,
+                'basketitemid' => $sBasketItemId
+            ];
+        }
+
+        if (is_array($aProducts) && count($aProducts)) {
+            $toRemoveArticleIdList = [];
+            $artIdOnArtAmountList = [];
+
+            if (Registry::getRequest()->getRequestEscapedParameter('removeBtn') !== null
+                or Registry::getRequest()->getRequestParameter('updateBtn') !== null) {
+
+                //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) {
+                        if (!in_array($aProduct, $toRemoveArticleIdList)) {
+                            $toRemoveArticleIdList[] = $aProduct['aid'];
+                            $artIdOnArtAmountList[$aProduct['aid']] = $aProduct['am'];
+                        }
+
+                        $aProducts[$sProductId]['am'] = 0;
+                        #for GA4 Event
+                        $this->addTplParam('hasBeenReloaded', true);
+                    } else {
+                        unset($aProducts[$sProductId]);
+                    }
+                }
+            }
+
+            $oArtList = oxNew(ArticleList::class);
+            $oArtList->loadIds($toRemoveArticleIdList);
+
+            #dumpVar($this->getBasketArticles());
+
+            /** @var Article $item */
+            foreach ($oArtList->getArray() as $item){
+                foreach ($artIdOnArtAmountList as $artId => $artAmount){
+                    if ($item->getId() === $artId){
+                        $item->assign(['d3AmountThatGotRemoved' => $artAmount]);
+                    }
+                }
+            }
+
+            $this->addTplParam('toRemoveArticles', $oArtList);
+        }
+    }
+}

Modules/Core/ViewConfig.php

@@ -75,7 +75,7 @@ class ViewConfig extends ViewConfig_parent
 
         $this->defineCookieManagerType();
 
-        $sCookieID = $oConfig->getConfigParam('d3_gtm_settings_cookieName');
+        $sCookieID = trim($oConfig->getConfigParam('d3_gtm_settings_cookieName'));
 
         // Netensio Cookie Manager
         if ($this->sCookieManagerType === ManagerTypes::NET_COOKIE_MANAGER) {
@@ -97,6 +97,7 @@ 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
         )
         {
@@ -115,8 +116,7 @@ class ViewConfig extends ViewConfig_parent
      */
     public function getGtmScriptAttributes() :string
     {
-        $oConfig = Registry::getConfig();
-        $sCookieId = $oConfig->getConfigParam('d3_gtm_settings_cookieName');
+        $sCookieId = trim(Registry::getConfig()->getConfigParam('d3_gtm_settings_cookieName'));
 
         if (false === $this->shallUseOwnCookieManager()){
             return "";
@@ -144,6 +144,10 @@ class ViewConfig extends ViewConfig_parent
             }
         }
 
+        if ($this->sCookieManagerType === ManagerTypes::COOKIEFIRST){
+            return 'type="text/plain" data-cookiefirst-category="' . $sCookieId .'"';
+        }
+
         return "";
     }
 

metadata.php

@@ -1,8 +1,10 @@
 <?php
 
+use D3\GoogleAnalytics4\Modules\Application\Controller\BasketController;
 use D3\GoogleAnalytics4\Modules\Application\Model\Basket as Basket;
 use D3\GoogleAnalytics4\Modules\Application\Model\Category as Category;
 use D3\GoogleAnalytics4\Modules\Core\ViewConfig;
+use OxidEsales\Eshop\Application\Controller\BasketController as OEBasketController;
 use OxidEsales\Eshop\Application\Model\Basket as OEBasket;
 use OxidEsales\Eshop\Application\Model\Category as OECategory;
 use OxidEsales\Eshop\Core\ViewConfig as OEViewConfig;
@@ -22,14 +24,15 @@ $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.8.0',
+    'version'     => '2.10.1',
     '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
+        OEBasket::class => Basket::class,
+        OEBasketController::class => BasketController::class
     ],
     'templates'   => [],
     'blocks'      => [
@@ -85,6 +88,13 @@ $aModule          = [
             'block'    => 'details_productmain_tobasket',
             'file'     => '/Application/views/ga4/add_to_cart.tpl',
             'position' => 150
+        ],
+        // remove_from_cart
+        [
+            'template' => 'page/checkout/basket.tpl',
+            'block'    => 'checkout_basket_main',
+            'file'     => '/Application/views/ga4/remove_from_cart.tpl',
+            'position' => 150
         ]
     ],
     'settings'    => [
@@ -128,7 +138,7 @@ $aModule          = [
             'name' => 'd3_gtm_settings_HAS_STD_MANAGER',
             'type' => 'select',
             'value' => 'none',
-            'constraints' => 'NONE|CONSENTMANAGER|USERCENTRICS',
+            'constraints' => 'NONE|CONSENTMANAGER|USERCENTRICS|COOKIEFIRST',
         ],
     ]
 ];