GoogleAnalytics4/Modules/Core/ViewConfig.php

<?php
/**
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * https://www.d3data.de
 *
 * @copyright (C) D3 Data Development (Inh. Thomas Dartsch)
 * @author    D3 Data Development - Daniel Seifert <info@shopmodule.com>
 * @link      https://www.oxidmodule.com
 */

namespace D3\GoogleAnalytics4\Modules\Core;

use OxidEsales\Eshop\Application\Controller\FrontendController;
use OxidEsales\Eshop\Core\Config;
use OxidEsales\Eshop\Core\Registry;

class ViewConfig extends ViewConfig_parent
{

    // Google Tag Manager Container ID
    private $sContainerId = null;
    private $sCookieManagerType = null;

    public function getGtmContainerId()
    {
        if ($this->sContainerId === null)
        {
            $this->sContainerId = $this->getConfig()->getConfigParam('d3_gtm_sContainerID');
        }
        return $this->sContainerId;
    }

    /**
     * @return mixed
     */
    public function getModuleSettingExplicitManagerSelectValue()
    {
        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;

            $allowedManagerTypes = [
                '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 $this->sCookieManagerType;
    }

    /**
     * @return bool
     */
    public function shallUseOwnCookieManager()
    {
        return (bool) Registry::getConfig()->getConfigParam('d3_gtm_settings_hasOwnCookieManager');
    }

    /**
     * @return bool
     */
    public function D3blShowGtmScript()
    {
        /** @var Config $oConfig */
        $oConfig = Registry::getConfig();

        // No Cookie Manager in use
        if (false === $this->shallUseOwnCookieManager()) {
            return true;
        }

        $sCookieID = $oConfig->getConfigParam('d3_gtm_settings_cookieName');

        // Netensio Cookie Manager
        if ($this->getCookieManagerType() == "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");
        }

        // Aggrosoft Cookie Consent
        if ($this->getCookieManagerType() == "agcookiecompliance") {
            if (method_exists($this, "isCookieCategoryEnabled")) {
                return $this->isCookieCategoryEnabled($sCookieID);
            }
        }

        // UserCentrics or consentmanager
        if ($this->getCookieManagerType() === "oxps_usercentrics" or $this->getCookieManagerType() === 'externalService') {
            // Always needs the script-tags delivered to the DOM.
            return true;
        }

        return false;
    }

    /**
     * Get additional attributes for script tags.
     * This is especially important for UserCentrics.
     * @return string
     */
    public function getGtmScriptAttributes()
    {
        $oConfig = Registry::getConfig();

        if (false === $this->shallUseOwnCookieManager()){
            return "";
        }

        if ($this->getCookieManagerType() === "oxps_usercentrics" or $this->getExplicitManager() === 'USERCENTRICS') {
            $sCookieId = $oConfig->getConfigParam('d3_gtm_settings_cookieName');

            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 ($sCookieId) {
                return 'async 
                        type="text/plain"
                        data-cmp-src="https://www.googletagmanager.com/gtm.js?id='.$this->getGtmContainerId().'"
                        class="cmplazyload"
                        data-cmp-vendor="s905"
                        ';
            }
        }

        return "";
    }

    private $blGA4enabled = null;

    public function isGA4enabled()
    {
        if ($this->blGA4enabled === null)
        {
            $this->sContainerId = $this->getConfig()->getConfigParam('d3_gtm_blEnableGA4');
        }

        return $this->blGA4enabled;
    }

    public function getGtmDataLayer()
    {
        if (!$this->getGtmContainerId()) return "[]";

        $oConfig = Registry::getConfig();
        $oView   = $oConfig->getTopActiveView();
        /** @var FrontendController $oShop */
        $oUser = $oConfig->getUser();

        $cl         = $this->getTopActiveClassName();
        $aPageTypes = [
            "content"  => "cms",
            "details"  => "product",
            "alist"    => "listing",
            "search"   => "listing",
            "basket"   => "checkout",
            "user"     => "checkout",
            "payment"  => "checkout",
            "order"    => "checkout",
            "thankyou" => "checkout",
            "start"    => "start",
        ];

        $dataLayer = [
            'page'      => [
                'type'  => $aPageTypes[$cl] ?? "unknown",
                'title' => $oView->getTitle(),
                'cl'    => $cl,
            ],
            'userid'    => ($oUser ? $oUser->getId() : false),
            'sessionid' => session_id() ?? false,
            //'httpref'   => $_SERVER["HTTP_REFERER"] ?? "unknown"
        ];

        return json_encode([$dataLayer], JSON_PRETTY_PRINT);
    }

    public function isPromotionList($listId)
    {
        $oConfig           = Registry::getConfig();
        $aPromotionListIds = $oConfig->getConfigParam("") ?? ['bargainItems', 'newItems', 'topBox', 'alsoBought', 'accessories', 'cross'];
    }
}