├── Api
    ├── ContainerInterface.php
    ├── DataLayer
    │   ├── BeginCheckoutInterface.php
    │   ├── Cart
    │   │   └── ItemInterface.php
    │   ├── Order
    │   │   └── ItemInterface.php
    │   ├── Product
    │   │   └── ItemInterface.php
    │   ├── PurchaseInterface.php
    │   ├── ViewCartInterface.php
    │   └── ViewItemInterface.php
    └── Transaction
    │   └── LogInterface.php
├── Block
    ├── AbstractDataLayer.php
    ├── Adminhtml
    │   └── System
    │   │   └── Config
    │   │       └── Form
    │   │           ├── Attention.php
    │   │           ├── EventList.php
    │   │           ├── ExportServerContainerButton.php
    │   │           ├── ExportWebContainerButton.php
    │   │           ├── Info.php
    │   │           ├── InfoMeasurementProtocol.php
    │   │           ├── InfoPlan.php
    │   │           ├── InfoPlanExtra.php
    │   │           ├── InfoPlanPlus.php
    │   │           └── ProtectCustomerData.php
    ├── DataLayer
    │   ├── BeginCheckout.php
    │   ├── Other.php
    │   ├── Purchase.php
    │   ├── PurchaseGetOrderFromRequest.php
    │   ├── ViewCart.php
    │   └── ViewItem.php
    └── GtmCode.php
├── Controller
    ├── Adminhtml
    │   ├── ContainerGenerate.php
    │   └── WebContainer
    │   │   └── Generate.php
    └── LastOrder
    │   └── DataLayer.php
├── LICENSE.txt
├── Model
    ├── AbstractDataLayer.php
    ├── Config.php
    ├── Config
    │   └── Source
    │   │   ├── BrandAttribute.php
    │   │   ├── InstallGtmOptions.php
    │   │   ├── OrderStatuses.php
    │   │   └── ProductAttribute.php
    ├── DataLayer
    │   ├── AbstractOrder.php
    │   ├── BeginCheckout.php
    │   ├── Cart
    │   │   └── Item.php
    │   ├── Order
    │   │   └── Item.php
    │   ├── Product
    │   │   └── Item.php
    │   ├── Purchase.php
    │   ├── ViewCart.php
    │   └── ViewItem.php
    ├── ResourceModel
    │   ├── Transaction.php
    │   └── Transaction
    │   │   └── Collection.php
    ├── Transaction.php
    ├── Transaction
    │   └── Log.php
    ├── TransactionRepository.php
    └── WebContainer.php
├── Plugin
    ├── Magefan
    │   └── GoogleTagManager
    │   │   └── Api
    │   │       └── DataLayer
    │   │           └── PurchaseInterface.php
    └── Magento
    │   ├── Customer
    │       └── CustomerData
    │       │   └── Customer.php
    │   └── Framework
    │       └── App
    │           └── Config
    │               └── ScopeConfig.php
├── README.md
├── Setup
    └── Patch
    │   └── Schema
    │       └── ChangePath.php
├── composer.json
├── etc
    ├── acl.xml
    ├── adminhtml
    │   ├── routes.xml
    │   └── system.xml
    ├── config.xml
    ├── csp_whitelist.xml
    ├── db_schema.xml
    ├── di.xml
    ├── frontend
    │   ├── di.xml
    │   └── routes.xml
    └── module.xml
├── registration.php
└── view
    ├── adminhtml
        └── templates
        │   └── system
        │       └── config
        │           ├── button
        │               └── export-container-button.phtml
        │           └── event
        │               └── list.phtml
    └── frontend
        ├── layout
            ├── catalog_product_view.xml
            ├── checkout_cart_index.xml
            ├── checkout_index_index.xml
            ├── checkout_onepage_success.xml
            ├── default.xml
            ├── hyva_checkout_index_index.xml
            ├── p2c2p_payment_success.xml
            └── redsys_checkout_success.xml
        └── templates
            ├── js_code.phtml
            └── no_js_code.phtml


/Api/ContainerInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Api;
10 | 
11 | use Magento\Framework\Exception\NoSuchEntityException;
12 | 
13 | interface ContainerInterface
14 | {
15 |     /**
16 |      * Generate JSON container
17 |      *
18 |      * @param string|null $storeId
19 |      * @return array
20 |      * @throws NoSuchEntityException
21 |      */
22 |     public function generate(?string $storeId = null): array;
23 | }
24 | 


--------------------------------------------------------------------------------
/Api/DataLayer/BeginCheckoutInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Api\DataLayer;
10 | 
11 | use Magento\Framework\Exception\NoSuchEntityException;
12 | use Magento\Quote\Model\Quote;
13 | 
14 | interface BeginCheckoutInterface
15 | {
16 |     /**
17 |      * Get GTM datalayer
18 |      *
19 |      * @param Quote $quote
20 |      * @return array
21 |      * @throws NoSuchEntityException
22 |      */
23 |     public function get(Quote $quote): array;
24 | }
25 | 


--------------------------------------------------------------------------------
/Api/DataLayer/Cart/ItemInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Api\DataLayer\Cart;
10 | 
11 | use Magento\Framework\Exception\NoSuchEntityException;
12 | use Magento\Quote\Model\Quote\Item;
13 | 
14 | interface ItemInterface
15 | {
16 |     /**
17 |      * Get quote Item
18 |      *
19 |      * @param Item $quoteItem
20 |      * @return array
21 |      * @throws NoSuchEntityException
22 |      */
23 |     public function get(Item $quoteItem): array;
24 | }
25 | 


--------------------------------------------------------------------------------
/Api/DataLayer/Order/ItemInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Api\DataLayer\Order;
10 | 
11 | use Magento\Framework\Exception\NoSuchEntityException;
12 | use Magento\Sales\Api\Data\OrderItemInterface;
13 | 
14 | interface ItemInterface
15 | {
16 |     /**
17 |      * Get order item
18 |      *
19 |      * @param OrderItemInterface $orderItem
20 |      * @return array
21 |      * @throws NoSuchEntityException
22 |      */
23 |     public function get(OrderItemInterface $orderItem): array;
24 | }
25 | 


--------------------------------------------------------------------------------
/Api/DataLayer/Product/ItemInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Api\DataLayer\Product;
10 | 
11 | use Magento\Framework\Exception\NoSuchEntityException;
12 | use Magento\Catalog\Model\Product;
13 | 
14 | interface ItemInterface
15 | {
16 |     /**
17 |      * Get product item
18 |      *
19 |      * @param Product $product
20 |      * @return array
21 |      * @throws NoSuchEntityException
22 |      */
23 |     public function get(Product $product): array;
24 | }
25 | 


--------------------------------------------------------------------------------
/Api/DataLayer/PurchaseInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Api\DataLayer;
10 | 
11 | use Magento\Framework\Exception\NoSuchEntityException;
12 | use Magento\Sales\Model\Order;
13 | 
14 | interface PurchaseInterface
15 | {
16 |     /**
17 |      * Get GTM datalayer
18 |      *
19 |      * @param Order $order
20 |      * @param string $requester
21 |      * @return array
22 |      * @throws NoSuchEntityException
23 |      */
24 |     public function get(Order $order, string $requester = ''): array;
25 | }
26 | 


--------------------------------------------------------------------------------
/Api/DataLayer/ViewCartInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Api\DataLayer;
10 | 
11 | use Magento\Framework\Exception\NoSuchEntityException;
12 | use Magento\Quote\Model\Quote;
13 | 
14 | interface ViewCartInterface
15 | {
16 |     /**
17 |      * Get GTM datalayer
18 |      *
19 |      * @param Quote $quote
20 |      * @return array
21 |      * @throws NoSuchEntityException
22 |      */
23 |     public function get(Quote $quote): array;
24 | }
25 | 


--------------------------------------------------------------------------------
/Api/DataLayer/ViewItemInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Api\DataLayer;
10 | 
11 | use Magento\Framework\Exception\NoSuchEntityException;
12 | use Magento\Catalog\Model\Product;
13 | 
14 | interface ViewItemInterface
15 | {
16 |     /**
17 |      * Get GTM datalayer
18 |      *
19 |      * @param Product $product
20 |      * @return array
21 |      * @throws NoSuchEntityException
22 |      */
23 |     public function get(Product $product): array;
24 | }
25 | 


--------------------------------------------------------------------------------
/Api/Transaction/LogInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Api\Transaction;
10 | 
11 | interface LogInterface
12 | {
13 |     /**
14 |      * @param mixed $order
15 |      * @param string $requester
16 |      * @return void
17 |      */
18 |     public function logTransaction($order, string $requester);
19 | 
20 |     /**
21 |      * @param mixed $order
22 |      * @param string $requester
23 |      * @return bool
24 |      */
25 |     public function isTransactionUnique($order, string $requester): bool;
26 | }
27 | 


--------------------------------------------------------------------------------
/Block/AbstractDataLayer.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Block;
10 | 
11 | use Magento\Framework\View\Element\AbstractBlock;
12 | use Magento\Framework\View\Element\Context;
13 | use Magefan\Community\Api\SecureHtmlRendererInterface;
14 | use Magefan\GoogleTagManager\Model\Config;
15 | 
16 | abstract class AbstractDataLayer extends AbstractBlock
17 | {
18 |     /**
19 |      * @var Config
20 |      */
21 |     protected $config;
22 | 
23 |     /**
24 |      * @var SecureHtmlRendererInterface
25 |      */
26 |     protected $mfSecureRenderer;
27 | 
28 |     /**
29 |      * @param Context $context
30 |      * @param Config $config
31 |      * @param array $data
32 |      * @param SecureHtmlRendererInterface|null $mfSecureRenderer
33 |      */
34 |     public function __construct(
35 |         Context $context,
36 |         Config $config,
37 |         array $data = [],
38 |         ?SecureHtmlRendererInterface $mfSecureRenderer = null
39 |     ) {
40 |         $this->config = $config;
41 |         $this->mfSecureRenderer = $mfSecureRenderer ?: \Magento\Framework\App\ObjectManager::getInstance()
42 |             ->get(SecureHtmlRendererInterface::class);
43 |         parent::__construct($context, $data);
44 |     }
45 | 
46 |     /**
47 |      * Get GTM datalayer
48 |      *
49 |      * @return array
50 |      */
51 |     abstract protected function getDataLayer(): array;
52 | 
53 |     /**
54 |      * Init GTM datalayer
55 |      *
56 |      * @return string
57 |      */
58 |     protected function _toHtml(): string
59 |     {
60 |         if ($this->config->isEnabled()) {
61 |             $dataLayer = $this->getDataLayer();
62 |             if ($dataLayer) {
63 |                 $json = json_encode($dataLayer);
64 |                 $json = str_replace('"getMfGtmCustomerIdentifier()"', 'getMfGtmCustomerIdentifier()', $json);
65 |                 $script = '
66 |                     window.dataLayer = window.dataLayer || [];
67 |                     window.dataLayer.push(' . $json . ');
68 |                 ';
69 |                 return $this->mfSecureRenderer->renderTag('script', ['style' => 'display:none'], $script, false);
70 |             }
71 |         }
72 | 
73 |         return '';
74 |     }
75 | }
76 | 


--------------------------------------------------------------------------------
/Block/Adminhtml/System/Config/Form/Attention.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Block\Adminhtml\System\Config\Form;
10 | 
11 | use Magento\Framework\Data\Form\Element\AbstractElement;
12 | 
13 | /**
14 |  * Admin configurations information block
15 |  */
16 | class Attention extends \Magefan\Community\Block\Adminhtml\System\Config\Form\Info
17 | {
18 | 
19 |     /**
20 |      * Return info block html
21 |      *
22 |      * @param  \Magento\Framework\Data\Form\Element\AbstractElement $element
23 |      * @return string
24 |      */
25 |     public function render(\Magento\Framework\Data\Form\Element\AbstractElement $element)
26 |     {
27 |         return '<div style="padding:10px;background-color:#fffbbb;border:1px solid #ddd;margin-bottom:7px;">
28 |             <strong>Attention!</strong> Once you change and save the "Web/Server Container", "Google Analytics 4" or "Google Ads" settings,
29 |             please don\'t forget to scroll down to the "Export Container" section
30 |             and click the "Generate JSON Container & Download File" button to export container data.
31 |             After you save the file, <a target="_blank" title="Create GTM tags" href="https://magefan.com/blog/add-google-tag-manager-to-magento-2#5-create-gtm-tags">
32 |             import it to your Google Tag Manager container.</a>
33 |         </div>';
34 |     }
35 | }
36 | 


--------------------------------------------------------------------------------
/Block/Adminhtml/System/Config/Form/EventList.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Block\Adminhtml\System\Config\Form;
10 | 
11 | use Magento\Backend\Block\Template\Context;
12 | use Magento\Config\Block\System\Config\Form\Field;
13 | use Magento\Framework\Data\Form\Element\AbstractElement;
14 | use Magento\Framework\Module\Manager;
15 | 
16 | class EventList extends Field
17 | {
18 |     public const EVENT_LIST_TEMPLATE = 'system/config/event/list.phtml';
19 | 
20 |     /**
21 |      * @var Manager
22 |      */
23 |     private $moduleManager;
24 | 
25 |     /**
26 |      * EventList constructor.
27 |      *
28 |      * @param Context $context
29 |      * @param Manager $moduleManager
30 |      * @param array $data
31 |      */
32 |     public function __construct(
33 |         Context $context,
34 |         Manager $moduleManager,
35 |         array $data = []
36 |     ) {
37 |         $this->moduleManager = $moduleManager;
38 |         parent::__construct($context, $data);
39 |     }
40 | 
41 |     /**
42 |      * Set template to itself
43 |      *
44 |      * @return $this
45 |      */
46 |     protected function _prepareLayout(): EventList
47 |     {
48 |         parent::_prepareLayout();
49 |         if (!$this->getTemplate()) {
50 |             $this->setTemplate(static::EVENT_LIST_TEMPLATE);
51 |         }
52 |         return $this;
53 |     }
54 | 
55 |     /**
56 |      * Render event list
57 |      *
58 |      * @param  AbstractElement $element
59 |      * @return string
60 |      */
61 |     public function render(AbstractElement $element): string
62 |     {
63 |         // Remove scope label
64 |         $element->unsScope()->unsCanUseWebsiteValue()->unsCanUseDefaultValue();
65 |         return parent::render($element);
66 |     }
67 | 
68 |     /**
69 |      * Get the event list and scripts contents
70 |      *
71 |      * @param AbstractElement $element
72 |      * @return string
73 |      */
74 |     protected function _getElementHtml(AbstractElement $element): string
75 |     {
76 |         return $this->_toHtml();
77 |     }
78 | 
79 |     /**
80 |      * Retrieve true if GTM Plus is enabled
81 |      *
82 |      * @return bool
83 |      */
84 |     public function isPlusEnabled(): bool
85 |     {
86 |         return (bool)$this->moduleManager->isEnabled('Magefan_GoogleTagManagerPlus');
87 |     }
88 | 
89 |     /**
90 |      * Retrieve true if GTM Extra is enabled
91 |      *
92 |      * @return bool
93 |      */
94 |     public function isExtraEnabled(): bool
95 |     {
96 |         return (bool)$this->moduleManager->isEnabled('Magefan_GoogleTagManagerExtra');
97 |     }
98 | }
99 | 


--------------------------------------------------------------------------------
/Block/Adminhtml/System/Config/Form/ExportServerContainerButton.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Block\Adminhtml\System\Config\Form;
10 | 
11 | class ExportServerContainerButton extends ExportWebContainerButton
12 | {
13 |     /**
14 |      * @var string
15 |      */
16 |     protected $conteinerType = 'server';
17 | 
18 |     /**
19 |      * @return string
20 |      */
21 |     public function getContainerGenerateUrl()
22 |     {
23 |         return $this->getUrl(
24 |             'mfgoogletagmanagerextra/serverContainer/generate',
25 |             [
26 |                 'store_id' => (int)$this->getRequest()->getParam('store') ?: null,
27 |                 'website_id' => (int)$this->getRequest()->getParam('website') ?: null
28 |             ]
29 |         );
30 |     }
31 | }
32 | 


--------------------------------------------------------------------------------
/Block/Adminhtml/System/Config/Form/ExportWebContainerButton.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Block\Adminhtml\System\Config\Form;
10 | 
11 | use Magento\Config\Block\System\Config\Form\Field;
12 | use Magento\Framework\Data\Form\Element\AbstractElement;
13 | 
14 | class ExportWebContainerButton extends Field
15 | {
16 |     /**
17 |      * Path to template file in theme.
18 |      *
19 |      * @var string
20 |      */
21 |     protected $_template = 'Magefan_GoogleTagManager::system/config/button/export-container-button.phtml';
22 | 
23 |     /**
24 |      * @var string
25 |      */
26 |     protected $conteinerType = 'web';
27 | 
28 |     /**
29 |      * Render button
30 |      *
31 |      * @param  AbstractElement $element
32 |      * @return string
33 |      */
34 |     public function render(AbstractElement $element): string
35 |     {
36 |         // Remove scope label
37 |         $element->unsScope()->unsCanUseWebsiteValue()->unsCanUseDefaultValue();
38 |         return parent::render($element);
39 |     }
40 | 
41 |     /**
42 |      * Get the button and scripts contents
43 |      *
44 |      * @param AbstractElement $element
45 |      * @return string
46 |      */
47 |     protected function _getElementHtml(AbstractElement $element): string
48 |     {
49 |         return $this->_toHtml();
50 |     }
51 | 
52 |     /**
53 |      * @return string
54 |      */
55 |     public function getConteinderType()
56 |     {
57 |         return $this->conteinerType;
58 |     }
59 | 
60 |     /**
61 |      * @return string
62 |      */
63 |     public function getContainerGenerateUrl()
64 |     {
65 |         return $this->getUrl(
66 |             'mfgoogletagmanager/webContainer/generate',
67 |             [
68 |                 'store_id' => (int)$this->getRequest()->getParam('store') ?: null,
69 |                 'website_id' => (int)$this->getRequest()->getParam('website') ?: null
70 |             ]
71 |         );
72 |     }
73 | }
74 | 


--------------------------------------------------------------------------------
/Block/Adminhtml/System/Config/Form/Info.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Block\Adminhtml\System\Config\Form;
10 | 
11 | class Info extends \Magefan\Community\Block\Adminhtml\System\Config\Form\Info
12 | {
13 |     /**
14 |      * Return extension url
15 |      *
16 |      * @return string
17 |      */
18 |     protected function getModuleUrl(): string
19 |     {
20 |         return 'https://mage' .
21 |             'fan.com/magento-2-google-tag-manager?utm_source=gtm_config&utm_medium=link&utm_campaign=regular';
22 |     }
23 | 
24 |     /**
25 |      * Return extension title
26 |      *
27 |      * @return string
28 |      */
29 |     protected function getModuleTitle(): string
30 |     {
31 |         return 'Google Tag Manager and Analytics Extension';
32 |     }
33 | }
34 | 


--------------------------------------------------------------------------------
/Block/Adminhtml/System/Config/Form/InfoMeasurementProtocol.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Block\Adminhtml\System\Config\Form;
10 | 
11 | class InfoMeasurementProtocol extends Info
12 | {
13 | 
14 |     /**
15 |      * Return info block html
16 |      * @param  \Magento\Framework\Data\Form\Element\AbstractElement $element
17 |      * @return string
18 |      */
19 |     public function render(\Magento\Framework\Data\Form\Element\AbstractElement $element)
20 |     {
21 |         $html = '';
22 | 
23 |         $html .= '<div id="ga4mp-disabled" style="display:none; padding:10px;background-color:#f8f8f8;border:1px solid #ddd;margin-bottom:7px;">';
24 |         $html .= 'GA4 Measurement Protocol is not available while <a href="#mfgoogletagmanager_server_container-head">GTM Server Container</a> is enabled.';
25 |         $html .= '</div>';
26 | 
27 |         $script = '
28 |             require(["jquery", "Magento_Ui/js/modal/alert", "domReady!"], function($, alert){
29 |                 setInterval(function(){
30 |                     if (parseInt($("#mfgoogletagmanager_server_container_enabled").val())) {
31 |                         $("#ga4mp-disabled").show();
32 |                     } else {
33 |                         $("#ga4mp-disabled").hide();
34 |                     }
35 |                 }, 1000);
36 |             });
37 |         ';
38 | 
39 |         $html .= $this->mfSecureRenderer->renderTag('script', [], $script, false);
40 | 
41 |         return $html;
42 |     }
43 | }
44 | 


--------------------------------------------------------------------------------
/Block/Adminhtml/System/Config/Form/InfoPlan.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
  4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
  5 |  */
  6 | 
  7 | declare(strict_types=1);
  8 | 
  9 | namespace Magefan\GoogleTagManager\Block\Adminhtml\System\Config\Form;
 10 | 
 11 | use Magefan\Community\Api\SecureHtmlRendererInterface;
 12 | 
 13 | abstract class InfoPlan extends \Magefan\Community\Block\Adminhtml\System\Config\Form\Info
 14 | {
 15 |     /**
 16 |      * @return string
 17 |      */
 18 |     abstract protected function getMinPlan(): string;
 19 | 
 20 |     /**
 21 |      * @return string
 22 |      */
 23 |     abstract protected function getSectionsJson(): string;
 24 | 
 25 |     /**
 26 |      * @return string
 27 |      */
 28 |     abstract protected function getText(): string;
 29 | 
 30 | 
 31 |     /**
 32 |      * Return info block html
 33 |      * @param  \Magento\Framework\Data\Form\Element\AbstractElement $element
 34 |      * @return string
 35 |      */
 36 |     public function render(\Magento\Framework\Data\Form\Element\AbstractElement $element)
 37 |     {
 38 |         if ($this->getModuleVersion->execute($this->getModuleName() . $this->getMinPlan())) {
 39 |             return '';
 40 |         }
 41 | 
 42 |         $html = '';
 43 | 
 44 |         if ($text = $this->getText()) {
 45 |             $textHtml = '<div style="padding:10px;background-color:#f8f8f8;border:1px solid #ddd;margin-bottom:7px;">';
 46 |             $textHtml .= $text . ' <a style="color: #ef672f; text-decoration: underline;" href="https://magefan.com/magento-2-google-tag-manager/pricing?utm_source=gtm_config&utm_medium=link&utm_campaign=regular" target="_blank">Read more</a>.';
 47 |             $textHtml .= '</div>';
 48 |         }
 49 | 
 50 |         $optionAvailableInText = ($this->getMinPlan() == 'Extra')
 51 |             ? 'This option is available in <strong>Extra</strong> plan only.'
 52 |             : 'This option is available in <strong>Plus or Extra</strong> plans only.';
 53 | 
 54 |         $script = '
 55 |                 require(["jquery", "Magento_Ui/js/modal/alert", "domReady!"], function($, alert){
 56 |                     setInterval(function(){
 57 |                         var sections = ' . $this->getSectionsJson() . ';
 58 |                         
 59 |                         sections.forEach(function(sectionId) {
 60 |                             var $section = $("#" + sectionId + "-state").parent(".section-config");
 61 |                             if (!$section.length) {
 62 |                                 $section = $("#" + sectionId).parents("tr:first");
 63 |                             } else {
 64 |                                 var $fieldset = $section.find("fieldset:first");
 65 |                                 if (!$fieldset.data("mfftext")) {
 66 |                                     $fieldset.data("mfftext", 1);
 67 |                                     $fieldset.prepend(\'' . $textHtml . '\');
 68 |                                 }
 69 |                             }
 70 |                             
 71 |                             $section.find(".use-default").css("visibility", "hidden");
 72 |                             $section.find("input,select").each(function(){
 73 |                                 $(this).attr("readonly", "readonly");
 74 |                                 $(this).removeAttr("disabled");
 75 |                                 if ($(this).data("mffdisabled")) return;
 76 |                                 $(this).data("mffdisabled", 1);
 77 |                                 $(this).click(function(){
 78 |                                     $(this).val($(this).data("mfOldValue")).trigger("change");     
 79 |                                     alert({
 80 |                                         title: "You cannot use this option.",
 81 |                                         content: "' . $optionAvailableInText . '",
 82 |                                         buttons: [{
 83 |                                             text: "Upgrade Plan Now",
 84 |                                             class: "action primary accept",
 85 |                                             click: function () {
 86 |                                                 window.open("https://magefan.com/magento-2-google-tag-manager/pricing?utm_source=gtm_config&utm_medium=link&utm_campaign=regular");
 87 |                                             }
 88 |                                         }]
 89 |                                     });
 90 |                                 }).on("focus", function() {
 91 |                                     $(this).data("mfOldValue", $(this).val());
 92 |                                 });
 93 |                             });
 94 |                         });
 95 |                     }, 1000);
 96 |                 });
 97 |         ';
 98 | 
 99 |         $html .= $this->mfSecureRenderer->renderTag('script', [], $script, false);
100 | 
101 |         return $html;
102 |     }
103 | }
104 | 


--------------------------------------------------------------------------------
/Block/Adminhtml/System/Config/Form/InfoPlanExtra.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Block\Adminhtml\System\Config\Form;
10 | 
11 | class InfoPlanExtra extends InfoPlan
12 | {
13 | 
14 |     /**
15 |      * @return string
16 |      */
17 |     protected function getMinPlan(): string
18 |     {
19 |         return 'Extra';
20 |     }
21 | 
22 |     /**
23 |      * @return string
24 |      */
25 |     protected function getSectionsJson(): string
26 |     {
27 |         $sections = json_encode([
28 |             'mfgoogletagmanager_events_purchase_allowed_order_status',
29 |             'mfgoogletagmanager_analytics_measurement_protocol',
30 |             'mfgoogletagmanager_server_container',
31 |             'mfgoogletagmanager_events_purchase_track_admin_orders',
32 |             'mfgoogletagmanager_web_container_gtg_enabled'
33 |         ]);
34 |         return $sections;
35 |     }
36 | 
37 |     /**
38 |      * @return string
39 |      */
40 |     protected function getText(): string
41 |     {
42 |         return (string)__("This option is available in <strong>%1</strong> plan only.", $this->getMinPlan());
43 |     }
44 | }
45 | 


--------------------------------------------------------------------------------
/Block/Adminhtml/System/Config/Form/InfoPlanPlus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Block\Adminhtml\System\Config\Form;
10 | 
11 | class InfoPlanPlus extends InfoPlan
12 | {
13 | 
14 |     /**
15 |      * @return string
16 |      */
17 |     protected function getMinPlan(): string
18 |     {
19 |         return 'Plus';
20 |     }
21 | 
22 |     /**
23 |      * @return string
24 |      */
25 |     protected function getSectionsJson(): string
26 |     {
27 |         $sections = json_encode([
28 |             'mfgoogletagmanager_ads',
29 |         ]);
30 |         return $sections;
31 |     }
32 | 
33 |     protected function getText(): string
34 |     {
35 |         return (string)__("This option is available in <strong>Plus or Extra</strong> plans only.");
36 |     }
37 | }
38 | 


--------------------------------------------------------------------------------
/Block/Adminhtml/System/Config/Form/ProtectCustomerData.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Block\Adminhtml\System\Config\Form;
10 | 
11 | use Magento\Config\Block\System\Config\Form\Field;
12 | use Magento\Framework\Data\Form\Element\AbstractElement;
13 | 
14 | class ProtectCustomerData extends Field
15 | {
16 |     /**
17 |      * Render protect customer data
18 |      *
19 |      * @param  AbstractElement $element
20 |      * @return string
21 |      */
22 |     public function render(AbstractElement $element): string
23 |     {
24 |         $url = $this->getUrl('*/*/*/section/web');
25 |         $comment = '
26 |             <strong>Note</strong>: this option works only when default Magento Cookie Restriction Mode is enabled at 
27 |             <a href="' . $url . '" target="_blank">Stores > Configuration > General > Web > Default Cookie Settings</a>.
28 |             If Magento Cookie Restriction Mode is disabled, then GTM JavaScript will be loaded before consent ignoring the "Load GTM Script Before Consent" option.<br/><br/>
29 |             Even if GTM JavaScript is loaded before customer`s consent,
30 |             GTM still waits for consent to send user data related to advertising and analytics.';
31 | 
32 |         $element->setComment($comment);
33 |         return parent::render($element);
34 |     }
35 | }
36 | 


--------------------------------------------------------------------------------
/Block/DataLayer/BeginCheckout.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Block\DataLayer;
10 | 
11 | use Magefan\GoogleTagManager\Block\AbstractDataLayer;
12 | use Magefan\GoogleTagManager\Model\Config;
13 | use Magento\Checkout\Model\Session as CheckoutSession;
14 | use Magento\Framework\Exception\LocalizedException;
15 | use Magento\Framework\Exception\NoSuchEntityException;
16 | use Magento\Framework\View\Element\Context;
17 | use Magefan\GoogleTagManager\Api\DataLayer\BeginCheckoutInterface;
18 | 
19 | class BeginCheckout extends AbstractDataLayer
20 | {
21 |     /**
22 |      * @var CheckoutSession
23 |      */
24 |     protected $checkoutSession;
25 | 
26 |     /**
27 |      * @var BeginCheckoutInterface
28 |      */
29 |     private $beginCheckout;
30 | 
31 |     /**
32 |      * BeginCheckout constructor.
33 |      *
34 |      * @param Context $context
35 |      * @param Config $config
36 |      * @param CheckoutSession $checkoutSession
37 |      * @param BeginCheckoutInterface $beginCheckout
38 |      * @param array $data
39 |      */
40 |     public function __construct(
41 |         Context $context,
42 |         Config $config,
43 |         CheckoutSession $checkoutSession,
44 |         BeginCheckoutInterface $beginCheckout,
45 |         array $data = []
46 |     ) {
47 |         $this->checkoutSession = $checkoutSession;
48 |         $this->beginCheckout = $beginCheckout;
49 |         parent::__construct($context, $config, $data);
50 |     }
51 | 
52 |     /**
53 |      * Get GTM datalayer for checkout page
54 |      *
55 |      * @return array
56 |      * @throws LocalizedException
57 |      * @throws NoSuchEntityException
58 |      */
59 |     protected function getDataLayer(): array
60 |     {
61 |         $quote = $this->checkoutSession->getQuote();
62 |         return $this->beginCheckout->get($quote);
63 |     }
64 | }
65 | 


--------------------------------------------------------------------------------
/Block/DataLayer/Other.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Block\DataLayer;
10 | 
11 | use Magefan\GoogleTagManager\Block\AbstractDataLayer;
12 | 
13 | class Other extends AbstractDataLayer
14 | {
15 |     /**
16 |      * Get GTM datalayer for other pages
17 |      *
18 |      * @return array
19 |      */
20 |     protected function getDataLayer(): array
21 |     {
22 |         return [];
23 |     }
24 | }
25 | 


--------------------------------------------------------------------------------
/Block/DataLayer/Purchase.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Block\DataLayer;
10 | 
11 | use Magefan\GoogleTagManager\Block\AbstractDataLayer;
12 | use Magefan\GoogleTagManager\Model\Config;
13 | use Magento\Checkout\Model\Session as CheckoutSession;
14 | use Magento\Framework\Exception\NoSuchEntityException;
15 | use Magento\Framework\View\Element\Context;
16 | use Magefan\GoogleTagManager\Api\DataLayer\PurchaseInterface;
17 | 
18 | class Purchase extends AbstractDataLayer
19 | {
20 |     /**
21 |      * @var CheckoutSession
22 |      */
23 |     private $checkoutSession;
24 | 
25 |     /**
26 |      * @var PurchaseInterface
27 |      */
28 |     private $purchase;
29 | 
30 |     /**
31 |      * Purchase constructor.
32 |      *
33 |      * @param Context $context
34 |      * @param Config $config
35 |      * @param CheckoutSession $checkoutSession
36 |      * @param PurchaseInterface $purchase
37 |      * @param array $data
38 |      */
39 |     public function __construct(
40 |         Context $context,
41 |         Config $config,
42 |         CheckoutSession $checkoutSession,
43 |         PurchaseInterface $purchase,
44 |         array $data = []
45 |     ) {
46 |         $this->checkoutSession = $checkoutSession;
47 |         $this->purchase = $purchase;
48 |         parent::__construct($context, $config, $data);
49 |     }
50 | 
51 |     /**
52 |      * Get GTM datalayer for checkout success page
53 |      *
54 |      * @return array
55 |      * @throws NoSuchEntityException
56 |      */
57 |     protected function getDataLayer(): array
58 |     {
59 |         $order = $this->getOrder();
60 |         return $this->purchase->get($order);
61 |     }
62 | 
63 |     /**
64 |      * @return \Magento\Sales\Model\Order
65 |      */
66 |     protected function getOrder()
67 |     {
68 |         return $this->checkoutSession->getLastRealOrder();
69 |     }
70 | }
71 | 


--------------------------------------------------------------------------------
/Block/DataLayer/PurchaseGetOrderFromRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Block\DataLayer;
10 | 
11 | use Magefan\GoogleTagManager\Block\DataLayer\Purchase;
12 | 
13 | /**
14 |  * Custom Block For 2c2p payment method
15 |  */
16 | class PurchaseGetOrderFromRequest extends Purchase
17 | {
18 |     /**
19 |      * @return \Magento\Sales\Model\Order|null
20 |      */
21 |     protected function getOrder()
22 |     {
23 |         $order = $this->getOrderFactory()->create()->loadByIncrementId($this->getOrderId());
24 | 
25 |         if (!$order->getId()) {
26 |             return null;
27 |         }
28 |         return $order;
29 |     }
30 | 
31 |     /**
32 |      * @return mixed
33 |      */
34 |     protected function getOrderFactory()
35 |     {
36 |         $objectManager = \Magento\Framework\App\ObjectManager::getInstance();
37 |         return $objectManager->get(\Magento\Sales\Model\OrderFactory::class);
38 |     }
39 | 
40 |     /**
41 |      * @return string
42 |      */
43 |     protected function getOrderId()
44 |     {
45 |         $request = $this->getRequest();
46 | 
47 |         if ($request) {
48 |             return (string)$request->getParam('order_id');
49 |         }
50 | 
51 |         return 0;
52 |     }
53 | }
54 | 


--------------------------------------------------------------------------------
/Block/DataLayer/ViewCart.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Block\DataLayer;
10 | 
11 | use Magefan\GoogleTagManager\Block\AbstractDataLayer;
12 | use Magefan\GoogleTagManager\Model\Config;
13 | use Magento\Framework\Exception\LocalizedException;
14 | use Magento\Framework\Exception\NoSuchEntityException;
15 | use Magento\Framework\View\Element\Context;
16 | use Magento\Checkout\Model\Session as CheckoutSession;
17 | use Magefan\GoogleTagManager\Api\DataLayer\ViewCartInterface;
18 | 
19 | class ViewCart extends AbstractDataLayer
20 | {
21 |     /**
22 |      * @var CheckoutSession
23 |      */
24 |     protected $checkoutSession;
25 | 
26 |     /**
27 |      * @var ViewCartInterface
28 |      */
29 |     private $viewCart;
30 | 
31 |     /**
32 |      * ViewCart constructor.
33 |      *
34 |      * @param Context $context
35 |      * @param Config $config
36 |      * @param CheckoutSession $checkoutSession
37 |      * @param ViewCartInterface $viewCart
38 |      * @param array $data
39 |      */
40 |     public function __construct(
41 |         Context $context,
42 |         Config $config,
43 |         CheckoutSession $checkoutSession,
44 |         ViewCartInterface $viewCart,
45 |         array $data = []
46 |     ) {
47 |         $this->checkoutSession = $checkoutSession;
48 |         $this->viewCart = $viewCart;
49 |         parent::__construct($context, $config, $data);
50 |     }
51 | 
52 |     /**
53 |      * Get GTM datalayer for shopping cart page
54 |      *
55 |      * @return array
56 |      * @throws LocalizedException
57 |      * @throws NoSuchEntityException
58 |      */
59 |     protected function getDataLayer(): array
60 |     {
61 |         $quote = $this->checkoutSession->getQuote();
62 |         return $this->viewCart->get($quote);
63 |     }
64 | }
65 | 


--------------------------------------------------------------------------------
/Block/DataLayer/ViewItem.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Block\DataLayer;
10 | 
11 | use Magefan\GoogleTagManager\Block\AbstractDataLayer;
12 | use Magefan\GoogleTagManager\Model\Config;
13 | use Magento\Catalog\Model\Product;
14 | use Magento\Framework\Exception\NoSuchEntityException;
15 | use Magento\Framework\Registry;
16 | use Magento\Framework\View\Element\Context;
17 | use Magefan\GoogleTagManager\Api\DataLayer\ViewItemInterface;
18 | 
19 | class ViewItem extends AbstractDataLayer
20 | {
21 |     /**
22 |      * @var Registry
23 |      */
24 |     private $registry;
25 | 
26 |     /**
27 |      * @var ViewItemInterface
28 |      */
29 |     private $viewItem;
30 | 
31 |     /**
32 |      * ViewItem constructor.
33 |      *
34 |      * @param Context $context
35 |      * @param Config $config
36 |      * @param Registry $registry
37 |      * @param ViewItemInterface $viewItem
38 |      * @param array $data
39 |      */
40 |     public function __construct(
41 |         Context $context,
42 |         Config $config,
43 |         Registry $registry,
44 |         ViewItemInterface $viewItem,
45 |         array $data = []
46 |     ) {
47 |         $this->registry = $registry;
48 |         $this->viewItem = $viewItem;
49 |         parent::__construct($context, $config, $data);
50 |     }
51 | 
52 |     /**
53 |      * Get GTM datalayer for product page
54 |      *
55 |      * @return array
56 |      * @throws NoSuchEntityException
57 |      */
58 |     protected function getDataLayer(): array
59 |     {
60 |         return $this->viewItem->get($this->getCurrentProduct());
61 |     }
62 | 
63 |     /**
64 |      * Get current product
65 |      *
66 |      * @return Product
67 |      */
68 |     private function getCurrentProduct(): Product
69 |     {
70 |         return $this->registry->registry('current_product');
71 |     }
72 | }
73 | 


--------------------------------------------------------------------------------
/Block/GtmCode.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
  4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
  5 |  */
  6 | 
  7 | declare(strict_types=1);
  8 | 
  9 | namespace Magefan\GoogleTagManager\Block;
 10 | 
 11 | use Magento\Framework\Exception\NoSuchEntityException;
 12 | use Magento\Framework\View\Element\Template;
 13 | use Magefan\GoogleTagManager\Model\Config;
 14 | 
 15 | class GtmCode extends Template
 16 | {
 17 |     /**
 18 |      * @var Config
 19 |      */
 20 |     private $config;
 21 | 
 22 |     /**
 23 |      * GtmCode constructor.
 24 |      * @param Template\Context $context
 25 |      * @param Config $config
 26 |      * @param array $data
 27 |      */
 28 |     public function __construct(
 29 |         Template\Context $context,
 30 |         Config $config,
 31 |         array $data = []
 32 |     ) {
 33 |         $this->config = $config;
 34 |         parent::__construct($context, $data);
 35 |     }
 36 | 
 37 |     /**
 38 |      * @return string
 39 |      */
 40 |     public function getGtmScript(): string
 41 |     {
 42 |         $partsForRemove = [
 43 |             '<!-- Google Tag Manager -->',
 44 |             '<!-- End Google Tag Manager -->',
 45 |             '<script>',
 46 |             '</script>'
 47 |         ];
 48 |         $gtmScript = $this->config->getGtmScript();
 49 |         if ($gtmScript) {
 50 |             foreach ($partsForRemove as $part) {
 51 |                 $gtmScript = str_replace($part, '', $gtmScript);
 52 |             }
 53 | 
 54 |             $gtmScript = str_replace($this->getGtmJsUrl(true), $this->getGtmJsUrl(), $gtmScript);
 55 | 
 56 |             return $gtmScript;
 57 |         }
 58 | 
 59 |         return '';
 60 |     }
 61 | 
 62 |     /**
 63 |      * @return string
 64 |      */
 65 |     public function getGtmNoScript(): string
 66 |     {
 67 |         return $this->config->getGtmNoScript();
 68 |     }
 69 | 
 70 |     /**
 71 |      * @return string
 72 |      */
 73 |     public function getPublicId(): string
 74 |     {
 75 |         return $this->config->getPublicId();
 76 |     }
 77 | 
 78 |     /**
 79 |      * Check if protect customer data is enabled
 80 |      *
 81 |      * @return bool
 82 |      */
 83 |     public function isProtectCustomerDataEnabled(): bool
 84 |     {
 85 |         return $this->config->isProtectCustomerDataEnabled();
 86 |     }
 87 | 
 88 | 
 89 |     /**
 90 |      * Retrieve true if gtm script should be loaded before customer provice consent.
 91 |      *
 92 |      * @return bool
 93 |      */
 94 |     public function isLoadBeforeConsent(): bool
 95 |     {
 96 |         return $this->config->isLoadBeforeConsent();
 97 |     }
 98 | 
 99 |     /**
100 |      * Retrieve true if cookie restriction mode enabled
101 |      *
102 |      * @return bool
103 |      */
104 |     public function isCookieRestrictionModeEnabled()
105 |     {
106 |         return $this->config->isCookieRestrictionModeEnabled();
107 |     }
108 | 
109 |     /**
110 |      * Retrieve true if mf cookie consent extension is enabled
111 |      *
112 |      * @return bool
113 |      */
114 |     public function isMfCookieConsentExtensionEnabled()
115 |     {
116 |         return $this->config->isMfCookieConsentExtensionEnabled();
117 |     }
118 | 
119 |     /**
120 |      * Get current website ID
121 |      *
122 |      * @return int
123 |      * @throws NoSuchEntityException
124 |      */
125 |     public function getWebsiteId(): int
126 |     {
127 |         return (int)$this->_storeManager->getStore()->getWebsiteId();
128 |     }
129 | 
130 |     /**
131 |      * @return string
132 |      */
133 |     protected function _toHtml(): string
134 |     {
135 | 
136 |         if ($this->config->isEnabled() /* && $this->getPublicId() */) {
137 |             return parent::_toHtml();
138 |         }
139 | 
140 |         return '';
141 |     }
142 | 
143 |     /**
144 |      * @return Config
145 |      */
146 |     public function getConfig()
147 |     {
148 |         return $this->config;
149 |     }
150 | 
151 |     /**
152 |      * Retrieve true if speed optimization is enabled
153 |      *
154 |      * @return bool
155 |      */
156 |     public function isSpeedOptimizationEnabled(): bool
157 |     {
158 |         return (bool)$this->config->isSpeedOptimizationEnabled();
159 |     }
160 | 
161 | 
162 |     /**
163 |      * @param $origin
164 |      * @return string
165 |      * @throws NoSuchEntityException
166 |      */
167 |     public function getGtmJsUrl($origin = false): string
168 |     {
169 |         if (!$origin && $this->getConfig()->isGoogleTagGatewayEnabled()) {
170 |             return $this->_storeManager->getStore()->getBaseUrl()  . '/mfgtmproxy/';
171 |         } else {
172 |             return 'https://www.googletagmanager.com/gtm.js';
173 |         }
174 |     }
175 | }
176 | 


--------------------------------------------------------------------------------
/Controller/Adminhtml/ContainerGenerate.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
  4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
  5 |  */
  6 | 
  7 | declare(strict_types=1);
  8 | 
  9 | namespace Magefan\GoogleTagManager\Controller\Adminhtml;
 10 | 
 11 | use Magento\Backend\App\Action;
 12 | use Magento\Backend\App\Action\Context;
 13 | use Magento\Framework\App\Action\HttpGetActionInterface;
 14 | use Magento\Framework\App\Filesystem\DirectoryList;
 15 | use Magento\Framework\App\Response\Http\FileFactory;
 16 | use Magento\Framework\App\Response\RedirectInterface;
 17 | use Magento\Framework\Controller\Result\RawFactory;
 18 | use Magento\Framework\Controller\Result\Redirect;
 19 | use Magento\Framework\Controller\ResultFactory;
 20 | use Magento\Framework\Stdlib\DateTime\DateTime;
 21 | use Psr\Log\LoggerInterface;
 22 | use Magefan\GoogleTagManager\Model\Config;
 23 | use Magefan\GoogleTagManager\Api\ContainerInterface as Container;
 24 | use Magento\Store\Model\StoreManagerInterface;
 25 | 
 26 | class ContainerGenerate extends Action implements HttpGetActionInterface
 27 | {
 28 |     /**
 29 |      * Authorization level of a basic admin session
 30 |      *
 31 |      * @see _isAllowed()
 32 |      */
 33 |     public const ADMIN_RESOURCE = 'Magefan_GoogleTagManager::mfgoogletagmanager_config';
 34 | 
 35 |     /**
 36 |      * @var RawFactory
 37 |      */
 38 |     private $resultRawFactory;
 39 | 
 40 |     /**
 41 |      * @var FileFactory
 42 |      */
 43 |     private $fileFactory;
 44 | 
 45 |     /**
 46 |      * @var DateTime
 47 |      */
 48 |     private $dateTime;
 49 | 
 50 |     /**
 51 |      * @var LoggerInterface
 52 |      */
 53 |     private $logger;
 54 | 
 55 |     /**
 56 |      * @var RedirectInterface
 57 |      */
 58 |     private $redirect;
 59 | 
 60 |     /**
 61 |      * @var Config
 62 |      */
 63 |     private $config;
 64 | 
 65 |     /**
 66 |      * @var Container
 67 |      */
 68 |     private $container;
 69 | 
 70 |     /**
 71 |      * @var StoreManagerInterface
 72 |      */
 73 |     private $storeManager;
 74 | 
 75 |     /**
 76 |      * Generate constructor.
 77 |      *
 78 |      * @param Context $context
 79 |      * @param RawFactory $resultRawFactory
 80 |      * @param FileFactory $fileFactory
 81 |      * @param DateTime $dateTime
 82 |      * @param LoggerInterface $logger
 83 |      * @param RedirectInterface $redirect
 84 |      * @param Config $config
 85 |      * @param Container $container
 86 |      * @param StoreManagerInterface $storeManager
 87 |      */
 88 |     public function __construct(
 89 |         Context               $context,
 90 |         RawFactory            $resultRawFactory,
 91 |         FileFactory           $fileFactory,
 92 |         DateTime              $dateTime,
 93 |         LoggerInterface       $logger,
 94 |         RedirectInterface     $redirect,
 95 |         Config                $config,
 96 |         Container             $container,
 97 |         StoreManagerInterface $storeManager
 98 |     ) {
 99 |         $this->resultRawFactory = $resultRawFactory;
100 |         $this->fileFactory = $fileFactory;
101 |         $this->dateTime = $dateTime;
102 |         $this->logger = $logger;
103 |         $this->redirect = $redirect;
104 |         $this->config = $config;
105 |         $this->container = $container;
106 |         $this->storeManager = $storeManager;
107 |         parent::__construct($context);
108 |     }
109 | 
110 |     /**
111 |      * Generate and download JSON container
112 |      */
113 |     public function execute()
114 |     {
115 |         //clear echo current buffer
116 |         if (function_exists('ob_get_clean')) {
117 |             ob_get_clean();
118 |         }
119 | 
120 |         /** @var Redirect $resultRedirect */
121 |         $resultRedirect = $this->resultFactory->create(ResultFactory::TYPE_REDIRECT);
122 | 
123 |         /* Ability to generate JSON file even if the module is disabled.
124 |         if (!$this->config->isEnabled()) {
125 |             $this->messageManager
126 |                 ->addErrorMessage(__('To generate a JSON container, please enable the extension first.'));
127 |             return $resultRedirect->setPath($this->redirect->getRefererUrl());
128 |         }
129 |         */
130 | 
131 |         try {
132 |             $storeId = (string)$this->getRequest()->getParam('store_id') ?: null;
133 |             if (!$storeId && ($websiteId = ((string)$this->getRequest()->getParam('website_id') ?: null))) {
134 |                 $storeId = $this->storeManager->getWebsite($websiteId)->getDefaultStore()->getId();
135 |             }
136 | 
137 |             $container = $this->container->generate($storeId);
138 | 
139 |             $fileContent = [
140 |                 'type' => 'string',
141 |                 'value' => json_encode($container, JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT),
142 |                 'rm' => true
143 |             ];
144 |             return $this->fileFactory->create(
145 |                 sprintf('GTM' . '_%s.json', $this->dateTime->date('Y-m-d_H-i-s')),
146 |                 $fileContent,
147 |                 DirectoryList::MEDIA,
148 |                 'application/json'
149 |             );
150 |         } catch (\Exception $e) {
151 |             $this->logger->critical('Error message', ['exception' => $e]);
152 |             $this->messageManager->addErrorMessage(__('Something went wrong while generating the file.'));
153 |             return $resultRedirect->setPath($this->redirect->getRefererUrl());
154 |         }
155 |     }
156 | }
157 | 


--------------------------------------------------------------------------------
/Controller/Adminhtml/WebContainer/Generate.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Controller\Adminhtml\WebContainer;
10 | 
11 | use Magefan\GoogleTagManager\Controller\Adminhtml\ContainerGenerate;
12 | 
13 | class Generate extends ContainerGenerate
14 | {
15 |     /* Use di.xml to change container param as virtual type is not compatible with controllers */
16 | }
17 | 


--------------------------------------------------------------------------------
/Controller/LastOrder/DataLayer.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Controller\LastOrder;
10 | 
11 | use Magento\Framework\App\Action\Context;
12 | use Magefan\GoogleTagManager\Model\Config;
13 | use Magefan\GoogleTagManager\Model\DataLayer\Purchase;
14 | use Magento\Sales\Api\OrderRepositoryInterface;
15 | use Magento\Checkout\Model\Session;
16 | use Magento\Framework\Controller\Result\JsonFactory;
17 | 
18 | class DataLayer extends \Magento\Framework\App\Action\Action
19 | {
20 |     /**
21 |      * @var Config
22 |      */
23 |     protected $config;
24 | 
25 |     /**
26 |      * @var Purchase
27 |      */
28 |     protected $purchaseDataLayer;
29 | 
30 |     /**
31 |      * @var OrderRepositoryInterface
32 |      */
33 |     protected $orderRepository;
34 | 
35 |     /**
36 |      * @var Session
37 |      */
38 |     protected $checkoutSession;
39 | 
40 |     /**
41 |      * @var JsonFactory
42 |      */
43 |     protected $jsonResultFactory;
44 | 
45 |     /**
46 |      * ConfirmOrder constructor.
47 |      * @param Context $context
48 |      * @param Config $config
49 |      * @param Purchase $purchaseDataLayer
50 |      * @param OrderRepositoryInterface $orderRepository
51 |      * @param Session $checkoutSession
52 |      * @param JsonFactory $jsonResultFactory
53 |      */
54 |     public function __construct(
55 |         Context $context,
56 |         Config $config,
57 |         Purchase $purchaseDataLayer,
58 |         OrderRepositoryInterface $orderRepository,
59 |         Session $checkoutSession,
60 |         JsonFactory $jsonResultFactory
61 |     ) {
62 |         parent::__construct($context);
63 |         $this->config = $config;
64 |         $this->purchaseDataLayer = $purchaseDataLayer;
65 |         $this->orderRepository = $orderRepository;
66 |         $this->checkoutSession = $checkoutSession;
67 |         $this->jsonResultFactory = $jsonResultFactory;
68 |     }
69 | 
70 |     public function execute()
71 |     {
72 |         $result = $this->jsonResultFactory->create();
73 |         if ($this->config->isEnabled()) {
74 |             $orderId = $this->checkoutSession->getLastOrderId();
75 |             try {
76 |                 $order = $this->orderRepository->get($orderId);
77 |             } catch (\NoSuchElementException $e) {
78 |                 $order = null;
79 |             }
80 |             if ($order && $order->getEntityId()) {
81 |                 $dataLayer = $this->purchaseDataLayer->get($order);
82 |                 if ($dataLayer) {
83 |                     $result->setData($dataLayer);
84 |                 }
85 |             }
86 |         }
87 |         return $result;
88 |     }
89 | }
90 | 


--------------------------------------------------------------------------------
/LICENSE.txt:
--------------------------------------------------------------------------------
1 | Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement)


--------------------------------------------------------------------------------
/Model/AbstractDataLayer.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
  4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
  5 |  */
  6 | 
  7 | declare(strict_types=1);
  8 | 
  9 | namespace Magefan\GoogleTagManager\Model;
 10 | 
 11 | use Exception;
 12 | use Magento\Catalog\Api\CategoryRepositoryInterface;
 13 | use Magento\Catalog\Api\Data\CategoryInterface;
 14 | use Magento\Catalog\Model\Product;
 15 | use Magento\Framework\Exception\NoSuchEntityException;
 16 | use Magento\Store\Model\StoreManagerInterface;
 17 | use Magento\Framework\App\RequestInterface;
 18 | use Magento\Framework\Registry;
 19 | use Magento\Framework\App\ObjectManager;
 20 | use Magento\Customer\Model\Session;
 21 | use Magento\Customer\Model\ResourceModel\GroupRepository;
 22 | 
 23 | class AbstractDataLayer
 24 | {
 25 |     /**
 26 |      * @var Config
 27 |      */
 28 |     protected $config;
 29 | 
 30 |     /**
 31 |      * @var StoreManagerInterface
 32 |      */
 33 |     protected $storeManager;
 34 | 
 35 |     /**
 36 |      * @var CategoryRepositoryInterface
 37 |      */
 38 |     protected $categoryRepository;
 39 | 
 40 |     /**
 41 |      * @var RequestInterface
 42 |      */
 43 |     protected $request;
 44 | 
 45 |     /**
 46 |      * @var Registry
 47 |      */
 48 |     protected $registry;
 49 | 
 50 |     /**
 51 |      * @var Session
 52 |      */
 53 |     protected $session;
 54 | 
 55 |     /**
 56 |      * @var GroupRepository
 57 |      */
 58 |     protected $groupRepository;
 59 | 
 60 |     /**
 61 |      * @var string
 62 |      */
 63 |     protected $customerGroupCode;
 64 | 
 65 |     /**
 66 |      * @var string
 67 |      */
 68 |     protected $ecommPageType = 'other';
 69 | 
 70 |     /**
 71 |      * AbstractDataLayer constructor.
 72 |      *
 73 |      * @param Config $config
 74 |      * @param StoreManagerInterface $storeManager
 75 |      * @param CategoryRepositoryInterface $categoryRepository
 76 |      */
 77 |     public function __construct(
 78 |         Config                      $config,
 79 |         StoreManagerInterface       $storeManager,
 80 |         CategoryRepositoryInterface $categoryRepository,
 81 |         ?RequestInterface            $request = null,
 82 |         ?Registry                    $registry = null,
 83 |         ?Session                     $session = null,
 84 |         ?GroupRepository             $groupRepository = null
 85 |     ) {
 86 |         $this->config = $config;
 87 |         $this->storeManager = $storeManager;
 88 |         $this->categoryRepository = $categoryRepository;
 89 |         $this->request = $request ?: ObjectManager::getInstance()->get(
 90 |             RequestInterface::class
 91 |         );
 92 |         $this->registry = $registry ?: ObjectManager::getInstance()->get(
 93 |             Registry::class
 94 |         );
 95 |         $this->session = $session ?: ObjectManager::getInstance()->get(
 96 |             Session::class
 97 |         );
 98 |         $this->groupRepository = $groupRepository ?: ObjectManager::getInstance()->get(
 99 |             GroupRepository::class
100 |         );
101 |     }
102 | 
103 | 
104 |     /**
105 |      * @return string
106 |      */
107 |     public function getEcommPageType(): string
108 |     {
109 |         if ('other' === $this->ecommPageType) {
110 |             $fullActionName = $this->request->getFullActionName();
111 |             switch ($fullActionName) {
112 |                 case 'cms_index_index':
113 |                     $this->ecommPageType = 'home';
114 |                     break;
115 |                 case 'catalog_category_view':
116 |                     $this->ecommPageType = 'category';
117 |                     break;
118 |                 case 'catalog_product_view':
119 |                     $this->ecommPageType = 'product';
120 |                     break;
121 |                 case 'checkout_cart_index':
122 |                     $this->ecommPageType = 'cart';
123 |                     break;
124 |                 case 'checkout_index_index':
125 |                     $this->ecommPageType = 'checkout';
126 |                     break;
127 |                 case 'contact_index_index':
128 |                     $this->ecommPageType = 'contact';
129 |                     break;
130 |                 case 'catalogsearch_result_index':
131 |                     $this->ecommPageType = 'searchresults';
132 |                     break;
133 |                 case 'cms_page_view':
134 |                     $this->ecommPageType = 'cmspage';
135 |                     break;
136 |             }
137 |         }
138 | 
139 |         return $this->ecommPageType;
140 |     }
141 | 
142 |     /**
143 |      * @param string $ecommPageType
144 |      * @return void
145 |      */
146 |     public function setEcommPageType(string $ecommPageType): void
147 |     {
148 |         $this->ecommPageType = $ecommPageType;
149 |     }
150 | 
151 |     /**
152 |      * Get category names
153 |      *
154 |      * @param Product $product
155 |      * @return array
156 |      * @throws NoSuchEntityException
157 |      */
158 |     protected function getCategoryNames(Product $product): array
159 |     {
160 |         $result = [];
161 | 
162 |         if (!$this->config->getCategoriesAttribute()) {
163 |             return $result;
164 |         }
165 | 
166 |         if ($productCategory = $this->getCategoryByProduct($product)) {
167 |             $categoryIds = $productCategory->getPathIds();
168 |             $number = 1;
169 |             $categoryNames = [];
170 |             foreach ($categoryIds as $categoryId) {
171 |                 $category = $this->categoryRepository->get($categoryId, $this->storeManager->getStore()->getId());
172 |                 if ($category->getLevel() < 2) {
173 |                     continue;
174 |                 }
175 | 
176 |                 $result['item_category' . (($number == 1) ? '' : $number)] = $category->getName();
177 |                 $categoryNames[] = $category->getName();
178 |                 $number++;
179 |             }
180 |             $result['category'] = implode(',', $categoryNames);
181 | 
182 |         }
183 | 
184 |         return $result;
185 |     }
186 | 
187 |     /**
188 |      * Get product category
189 |      *
190 |      * @param Product $product
191 |      * @return CategoryInterface|null
192 |      * @throws NoSuchEntityException
193 |      */
194 |     private function getCategoryByProduct(Product $product): ?CategoryInterface
195 |     {
196 |         if ('catalog_category_product' == $this->request->getFullActionName()) {
197 |             if ($category = $this->registry->registry('current_category')) {
198 |                 return $category;
199 |             }
200 |         }
201 | 
202 |         $productCategory = null;
203 |         $categoryIds = $product->getCategoryIds();
204 | 
205 |         if ($categoryIds) {
206 |             $level = -1;
207 |             $store = $this->storeManager->getStore();
208 |             $rootCategoryId = $store->getRootCategoryId();
209 | 
210 |             foreach ($categoryIds as $categoryId) {
211 |                 try {
212 |                     $category = $this->categoryRepository->get($categoryId, $store->getId());
213 |                     if ($category->getIsActive()
214 |                         && $category->getLevel() > $level
215 |                         && in_array($rootCategoryId, $category->getPathIds())
216 |                     ) {
217 |                         $level = $category->getLevel();
218 |                         $productCategory = $category;
219 |                     }
220 |                 } catch (Exception $e) { // phpcs:ignore
221 |                     /* Do nothing */
222 |                 }
223 |             }
224 |         }
225 | 
226 |         return $productCategory;
227 |     }
228 | 
229 |     /**
230 |      * Get current currency code
231 |      *
232 |      * @return string
233 |      * @throws NoSuchEntityException
234 |      */
235 |     protected function getCurrentCurrencyCode(): string
236 |     {
237 |         return $this->storeManager->getStore()->getCurrentCurrencyCode();
238 |     }
239 | 
240 |     /**
241 |      * Format price
242 |      *
243 |      * @param float $price
244 |      * @return float
245 |      */
246 |     protected function formatPrice(float $price): float
247 |     {
248 |         return (float)number_format($price, 2, '.', '');
249 |     }
250 | 
251 |     /**
252 |      * Get product price
253 |      * @deprecated
254 |      * @param Product $product
255 |      * @return float
256 |      */
257 |     protected function getPrice(Product $product): float
258 |     {
259 |         $priceInfo = $product->getPriceInfo()->getPrice('final_price')->getAmount();
260 |         $price = $priceInfo->getValue();
261 |         return $this->formatPrice((float)$price);
262 |     }
263 | 
264 |     /**
265 |      * @param $product
266 |      * @return float
267 |      */
268 |     protected function getProductValue($product): float
269 |     {
270 |         $priceInfo = $product->getPriceInfo()->getPrice('final_price')->getAmount();
271 |         if (!$this->config->isPurchaseTaxEnabled()) {
272 |             $value = $priceInfo->getValue('tax');
273 |         } else {
274 |             $value = $priceInfo->getValue();
275 |         }
276 | 
277 |         return $this->formatPrice((float)$value);
278 |     }
279 | 
280 |     /**
281 |      * @param Product $product
282 |      * @param string $attributeCode
283 |      * @return string
284 |      */
285 |     protected function getProductAttributeValue(Product $product, ?string $attributeCode): string
286 |     {
287 |         if ($attributeCode) {
288 |             $result = $product->getData($attributeCode);
289 |             if (is_numeric($result) && !in_array($attributeCode, ['sku', 'entity_id'])) {
290 |                 $result = $product->getResource()->getAttribute($attributeCode)->getFrontend()->getValue($product);
291 |             }
292 | 
293 |             if (is_array($result)) {
294 |                 $result = implode(', ', $result);
295 |             }
296 | 
297 |             if ($result) {
298 |                 return (string)$result;
299 |             }
300 |         }
301 | 
302 |         return '';
303 |     }
304 | 
305 |     /**
306 |      * @return string
307 |      * @throws NoSuchEntityException
308 |      * @throws \Magento\Framework\Exception\LocalizedException
309 |      */
310 |     protected function getCustomerGroupCode(): string
311 |     {
312 |         if (null === $this->customerGroupCode) {
313 |             $this->customerGroupCode = 'Guest';
314 |             $customerGroupId = $this->session->getCustomerGroupId();
315 |             if ($customerGroupId) {
316 |                 try {
317 |                     $group = $this->groupRepository->getById($customerGroupId);
318 |                     $this->customerGroupCode = (string)$group->getCode();
319 |                 } catch (NoSuchEntityException $e) {
320 |                     /* Do nothing */
321 |                 }
322 |             }
323 |         }
324 | 
325 |         return $this->customerGroupCode;
326 |     }
327 | 
328 |     /**
329 |      * @param array $data
330 |      * @return array
331 |      */
332 |     protected function eventWrap(array $data): array
333 |     {
334 |         if (empty($data)) {
335 |             return $data;
336 |         }
337 | 
338 |         $data = $this->addCustomerGroup($data);
339 |         $data = $this->addMfUniqueEventId($data);
340 |         $data = $this->addEcommPageType($data);
341 |         $data = $this->addCustomerIdentifier($data);
342 | 
343 |         return $data;
344 |     }
345 | 
346 |     /**
347 |      * @param array $data
348 |      * @return array
349 |      */
350 |     protected function addCustomerGroup(array $data): array
351 |     {
352 |         if (!isset($data['customerGroup'])) {
353 |             $data['customerGroup'] = $this->getCustomerGroupCode();
354 |         }
355 |         return $data;
356 |     }
357 | 
358 |     /**
359 |      * @param array $data
360 |      * @return array
361 |      */
362 |     protected function addMfUniqueEventId(array $data): array
363 |     {
364 | 
365 |         $hash = md5(json_encode($data) . microtime());
366 |         $event = isset($data['event']) ? $data['event'] : 'event';
367 |         $eventId = $event . '_' . $hash;
368 | 
369 |         $data['magefanUniqueEventId'] = $eventId;
370 | 
371 |         return $data;
372 |     }
373 | 
374 |     protected function addEcommPageType(array $data): array
375 |     {
376 |         if (!isset($data['ecomm_pagetype'])) {
377 |             $data['ecomm_pagetype'] = $this->getEcommPageType();
378 |         }
379 | 
380 |         return $data;
381 |     }
382 | 
383 |     /**
384 |      * @param array $data
385 |      * @return array
386 |      */
387 |     protected function addCustomerIdentifier(array $data): array
388 |     {
389 |         if (empty($data['customer_identifier'])) {
390 |             $data['customer_identifier'] = 'getMfGtmCustomerIdentifier()';
391 |         }
392 |         return $data;
393 |     }
394 | }
395 | 


--------------------------------------------------------------------------------
/Model/Config.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
  4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
  5 |  */
  6 | 
  7 | declare(strict_types=1);
  8 | 
  9 | namespace Magefan\GoogleTagManager\Model;
 10 | 
 11 | use Magento\Framework\App\Config\ScopeConfigInterface;
 12 | use Magento\Store\Model\ScopeInterface;
 13 | use Magento\Config\Model\Config\Backend\Admin\Custom;
 14 | use Magento\Framework\Module\Manager as ModuleManager;
 15 | 
 16 | class Config
 17 | {
 18 |     /**
 19 |      * General config
 20 |      */
 21 |     public const XML_PATH_EXTENSION_ENABLED = 'mfgoogletagmanager/general/enabled';
 22 | 
 23 |     /**
 24 |      * Web Container config
 25 |      */
 26 |     public const XML_PATH_WEB_CONTAINER_ENABLED = 'mfgoogletagmanager/web_container/enabled';
 27 |     public const XML_PATH_INSTALL_GTM = 'mfgoogletagmanager/web_container/install_gtm';
 28 |     public const XML_PATH_ACCOUNT_ID = 'mfgoogletagmanager/web_container/account_id';
 29 |     public const XML_PATH_CONTAINER_ID = 'mfgoogletagmanager/web_container/container_id';
 30 |     public const XML_PATH_WEB_PUBLIC_ID = 'mfgoogletagmanager/web_container/public_id';
 31 |     public const XML_PATH_SCRIPT_CONTENT = 'mfgoogletagmanager/web_container/script_content';
 32 |     public const XML_PATH_NO_SCRIPT_CONTENT = 'mfgoogletagmanager/web_container/noscript_content';
 33 |     public const XML_PATH_GOOGLE_TAG_GATEWAY = 'mfgoogletagmanager/web_container/gtg_enabled';
 34 | 
 35 |     /**
 36 |      * Analytics config
 37 |      */
 38 |     public const  XML_PATH_ANALYTICS_ENABLE = 'mfgoogletagmanager/analytics/enable';
 39 |     public const  XML_PATH_ANALYTICS_MEASUREMENT_ID = 'mfgoogletagmanager/analytics/measurement_id';
 40 | 
 41 |     /**
 42 |      * Product attributes config
 43 |      */
 44 |     public const XML_PATH_ATTRIBUTES_PRODUCT = 'mfgoogletagmanager/attributes/product';
 45 |     public const XML_PATH_ATTRIBUTES_BRAND = 'mfgoogletagmanager/attributes/brand';
 46 |     public const XML_PATH_ATTRIBUTES_CATEGORIES = 'mfgoogletagmanager/attributes/categories';
 47 | 
 48 |     /**
 49 |      * Events config
 50 |      */
 51 |     public const XML_PATH_EVENTS_PURCHASE_TAX_ENABLED = 'mfgoogletagmanager/events/purchase/tax_enabled';
 52 |     public const XML_PATH_EVENTS_PURCHASE_SHIPPING_ENABLED = 'mfgoogletagmanager/events/purchase/shipping_enabled';
 53 | 
 54 |     /**
 55 |      * Customer data protection regulation config
 56 |      */
 57 |     public const XML_PATH_PROTECT_CUSTOMER_DATA = 'mfgoogletagmanager/customer_data/protect';
 58 |     public const XML_PATH_LOAD_BEFORE_CONSENT = 'mfgoogletagmanager/customer_data/load_before_consent';
 59 | 
 60 |     /**
 61 |      * Speed optimization config
 62 |      */
 63 |     public const XML_PATH_SPEED_OPTIMIZATION_ENABLED = 'mfgoogletagmanager/page_speed_optimization/enabled';
 64 |     public const XML_PATH_THIRD_PARTY_GA = 'mfgoogletagmanager/third_party_ga/enabled';
 65 | 
 66 |     /**
 67 |      * MF cookie consent extension enabled
 68 |      */
 69 |     public const XML_PATH_MF_COOKIE_CONSENT_EXTENSION_ENABLED = 'mf_cookie_consent/general/enabled';
 70 | 
 71 |     /**
 72 |      * @var ScopeConfigInterface
 73 |      */
 74 |     private $scopeConfig;
 75 | 
 76 |     /**
 77 |      * @var ModuleManager
 78 |      */
 79 |     protected $moduleManager;
 80 | 
 81 |     /**
 82 |      * Config constructor.
 83 |      *
 84 |      * @param ScopeConfigInterface $scopeConfig
 85 |      * @param ModuleManager $moduleManager
 86 |      */
 87 |     public function __construct(
 88 |         ScopeConfigInterface $scopeConfig,
 89 |         ModuleManager $moduleManager
 90 |     ) {
 91 |         $this->scopeConfig = $scopeConfig;
 92 |         $this->moduleManager = $moduleManager;
 93 |     }
 94 | 
 95 |     /**
 96 |      * Retrieve true if module is enabled
 97 |      *
 98 |      * @param string|null $storeId
 99 |      * @return bool
100 |      */
101 |     public function isEnabled(?string $storeId = null): bool
102 |     {
103 |         return (bool)$this->getConfig(self::XML_PATH_EXTENSION_ENABLED, $storeId);
104 |     }
105 | 
106 |     /**
107 |      * Retrieve true if web container enabled
108 |      *
109 |      * @param string|null $storeId
110 |      * @return bool
111 |      */
112 |     public function isWebContainerEnabled(?string $storeId = null): bool
113 |     {
114 |         return (bool)$this->getConfig(self::XML_PATH_WEB_CONTAINER_ENABLED, $storeId);
115 |     }
116 | 
117 |     /**
118 |      * Retrieve GTM account ID
119 |      *
120 |      * @param string|null $storeId
121 |      * @return string
122 |      */
123 |     public function getAccountId(?string $storeId = null): string
124 |     {
125 |         return trim((string)$this->getConfig(self::XML_PATH_ACCOUNT_ID, $storeId));
126 |     }
127 | 
128 |     /**
129 |      * Retrieve GTM container ID
130 |      *
131 |      * @param string|null $storeId
132 |      * @return string
133 |      */
134 |     public function getContainerId(?string $storeId = null): string
135 |     {
136 |         return trim((string)$this->getConfig(self::XML_PATH_CONTAINER_ID, $storeId));
137 |     }
138 | 
139 |     /**
140 |      * @param string|null $storeId
141 |      * @return string
142 |      */
143 |     public function getPublicId(?string $storeId = null): string
144 |     {
145 |         if ('use_public_id' === $this->getInstallGtm()) {
146 |             return trim((string)$this->getConfig(self::XML_PATH_WEB_PUBLIC_ID, $storeId));
147 |         } else {
148 |             if ($gtmScript = $this->getGtmScript($storeId)) {
149 |                 $pattern = '/GTM-[A-Z0-9]+/';
150 |                 $matches = [];
151 |                 if (preg_match($pattern, $gtmScript, $matches)) {
152 |                     if (isset($matches[0])) {
153 |                         return trim((string)$matches[0]);
154 |                     }
155 |                 }
156 |             }
157 |         }
158 | 
159 |         return '';
160 |     }
161 | 
162 |     /**
163 |      * @param string|null $storeId
164 |      * @return string
165 |      */
166 |     public function getGtmScript(?string $storeId = null): string
167 |     {
168 |         return trim((string)$this->getConfig(self::XML_PATH_SCRIPT_CONTENT, $storeId));
169 |     }
170 | 
171 |     /**
172 |      * @param string|null $storeId
173 |      * @return string
174 |      */
175 |     public function getGtmNoScript(?string $storeId = null): string
176 |     {
177 |         return trim((string)$this->getConfig(self::XML_PATH_NO_SCRIPT_CONTENT, $storeId));
178 |     }
179 | 
180 |     /**
181 |      * Retrieve true if analytics enabled
182 |      *
183 |      * @param string|null $storeId
184 |      * @return bool
185 |      */
186 |     public function isAnalyticsEnabled(?string $storeId = null): bool
187 |     {
188 |         return (bool)$this->getConfig(self::XML_PATH_ANALYTICS_ENABLE, $storeId);
189 |     }
190 | 
191 |     /**
192 |      * Retrieve Google Analytics measurement ID
193 |      *
194 |      * @param string|null $storeId
195 |      * @return string
196 |      */
197 |     public function getMeasurementId(?string $storeId = null): string
198 |     {
199 |         return trim((string)$this->getConfig(self::XML_PATH_ANALYTICS_MEASUREMENT_ID, $storeId));
200 |     }
201 | 
202 |     /**
203 |      * @param string|null $storeId
204 |      * @return bool
205 |      */
206 |     public function isPurchaseTaxEnabled(?string $storeId = null): bool
207 |     {
208 |         return (bool)$this->getConfig(self::XML_PATH_EVENTS_PURCHASE_TAX_ENABLED, $storeId);
209 |     }
210 | 
211 |     /**
212 |      * @param string|null $storeId
213 |      * @return bool
214 |      */
215 |     public function isPurchaseShippingEnabled(?string $storeId = null): bool
216 |     {
217 |         return (bool)$this->getConfig(self::XML_PATH_EVENTS_PURCHASE_SHIPPING_ENABLED, $storeId);
218 |     }
219 | 
220 |     /**
221 |      * Retrieve Magento product attribute
222 |      *
223 |      * @param string|null $storeId
224 |      * @return string
225 |      */
226 |     public function getProductAttribute(?string $storeId = null): string
227 |     {
228 |         return trim((string)$this->getConfig(self::XML_PATH_ATTRIBUTES_PRODUCT, $storeId));
229 |     }
230 | 
231 |     /**
232 |      * Retrieve Magento product brand attribute
233 |      *
234 |      * @param string|null $storeId
235 |      * @return string
236 |      */
237 |     public function getBrandAttribute(?string $storeId = null): string
238 |     {
239 |         return trim((string)$this->getConfig(self::XML_PATH_ATTRIBUTES_BRAND, $storeId));
240 |     }
241 | 
242 |     /**
243 |      * Retrieve true if protect customer data is enabled
244 |      *
245 |      * @param string|null $storeId
246 |      * @return bool
247 |      */
248 |     public function isProtectCustomerDataEnabled(?string $storeId = null): bool
249 |     {
250 |         return (bool)$this->getConfig(self::XML_PATH_PROTECT_CUSTOMER_DATA, $storeId);
251 |     }
252 | 
253 |     /**
254 |      * Retrieve true if gtm script should be loaded before customer provice consent.
255 |      *
256 |      * @param string|null $storeId
257 |      * @return bool
258 |      */
259 |     public function isLoadBeforeConsent(?string $storeId = null): bool
260 |     {
261 |         return $this->getConfig(self::XML_PATH_LOAD_BEFORE_CONSENT, $storeId) ||
262 |             !$this->isCookieRestrictionModeEnabled($storeId);
263 |     }
264 | 
265 | 
266 |     /**
267 |      * Retrieve true if cookie restriction mode enabled
268 |      *
269 |      * @param string|null $storeId
270 |      * @return bool
271 |      */
272 |     public function isCookieRestrictionModeEnabled(?string $storeId = null)
273 |     {
274 |         return (bool)$this->getConfig(Custom::XML_PATH_WEB_COOKIE_RESTRICTION, $storeId);
275 |     }
276 | 
277 |     /**
278 |      * Retrieve true if mf cookie consent extension is enabled
279 |      *
280 |      * @param string|null $storeId
281 |      * @return bool
282 |      */
283 |     public function isMfCookieConsentExtensionEnabled(?string $storeId = null)
284 |     {
285 |         return $this->moduleManager->isEnabled('Magefan_CookieConsent')
286 |             && $this->getConfig(self::XML_PATH_MF_COOKIE_CONSENT_EXTENSION_ENABLED, $storeId);
287 |     }
288 | 
289 |     /*
290 |      * Retrieve Magento product categories
291 |      *
292 |      * @param string|null $storeId
293 |      * @return string
294 |      */
295 |     public function getCategoriesAttribute(?string $storeId = null): string
296 |     {
297 |         return trim((string)$this->getConfig(self::XML_PATH_ATTRIBUTES_CATEGORIES, $storeId));
298 |     }
299 | 
300 |     /**
301 |      * @param string|null $storeId
302 |      * @return int
303 |      */
304 |     public function getInstallGtm(?string $storeId = null): string
305 |     {
306 |         return trim((string)$this->getConfig(self::XML_PATH_INSTALL_GTM, $storeId));
307 |     }
308 | 
309 |     /**
310 |      * Retrieve store config value
311 |      *
312 |      * @param string $path
313 |      * @param string|null $storeId
314 |      * @return mixed
315 |      */
316 |     public function getConfig(string $path, ?string $storeId = null)
317 |     {
318 |         return $this->scopeConfig->getValue($path, ScopeInterface::SCOPE_STORE, $storeId);
319 |     }
320 | 
321 |     /**
322 |      * Retrieve true if speed optimization is enabled
323 |      *
324 |      * @param string|null $storeId
325 |      * @return bool
326 |      */
327 |     public function isSpeedOptimizationEnabled(?string $storeId = null): bool
328 |     {
329 |         return (bool)$this->getConfig(self::XML_PATH_SPEED_OPTIMIZATION_ENABLED, $storeId);
330 |     }
331 | 
332 |     /**
333 |      * @param string|null $storeId
334 |      * @return bool
335 |      */
336 |     public function isThirdPartyGaEnabled(?string $storeId = null): bool
337 |     {
338 |         return (bool)$this->getConfig(self::XML_PATH_THIRD_PARTY_GA, $storeId);
339 |     }
340 | 
341 |     /**
342 |      * @param string|null $storeId
343 |      * @return bool
344 |      */
345 |     public function isGoogleTagGatewayEnabled(?string $storeId = null): bool
346 |     {
347 |         if ($this->moduleManager->isEnabled('Magefan_GoogleTagManagerExtra')) {
348 |             return (bool)$this->getConfig(self::XML_PATH_GOOGLE_TAG_GATEWAY, $storeId);
349 |         }
350 | 
351 |         return false;
352 |     }
353 | }
354 | 


--------------------------------------------------------------------------------
/Model/Config/Source/BrandAttribute.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Model\Config\Source;
10 | 
11 | use Magento\Catalog\Model\ResourceModel\Product\Attribute\CollectionFactory as AttributeCollectionFactory;
12 | use Magento\Framework\Data\OptionSourceInterface;
13 | 
14 | class BrandAttribute implements OptionSourceInterface
15 | {
16 |     /**
17 |      * @var AttributeCollectionFactory
18 |      */
19 |     private $attributeCollectionFactory;
20 | 
21 |     /**
22 |      * @var array
23 |      */
24 |     protected $options;
25 | 
26 |     /**
27 |      * BrandAttribute constructor.
28 |      *
29 |      * @param AttributeCollectionFactory $attributeCollectionFactory
30 |      */
31 |     public function __construct(
32 |         AttributeCollectionFactory $attributeCollectionFactory
33 |     ) {
34 |         $this->attributeCollectionFactory = $attributeCollectionFactory;
35 |     }
36 | 
37 |     /**
38 |      * Return array of options as value-label pairs
39 |      *
40 |      * @return array Format: array(array('value' => '<value>', 'label' => '<label>'), ...)
41 |      */
42 |     public function toOptionArray(): array
43 |     {
44 |         if ($this->options === null) {
45 |             $this->options[] = ['value' => '', 'label' => __('--Please Select--')];
46 | 
47 |             $attributeCollection = $this->attributeCollectionFactory->create();
48 |             $attributeCollection->addVisibleFilter()
49 |                 ->setOrder('frontend_label', 'ASC');
50 | 
51 |             foreach ($attributeCollection->getItems() as $attribute) {
52 |                 $label = $attribute->getData('frontend_label');
53 |                 $value = $attribute->getData('attribute_code');
54 | 
55 |                 if (array_search($label, array_column($this->options, 'label')) !== false) {
56 |                     $label = $label . ' [' . $value . ']';
57 |                 }
58 | 
59 |                 $this->options[] = [
60 |                     'value' => $value,
61 |                     'label' => $label
62 |                 ];
63 |             }
64 |         }
65 | 
66 |         return $this->options;
67 |     }
68 | }
69 | 


--------------------------------------------------------------------------------
/Model/Config/Source/InstallGtmOptions.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Model\Config\Source;
10 | 
11 | use Magento\Framework\Data\OptionSourceInterface;
12 | 
13 | class InstallGtmOptions implements OptionSourceInterface
14 | {
15 | 
16 |     /**
17 |      * @var array
18 |      */
19 |     protected $options;
20 | 
21 |     /**
22 |      * Return array of options as value-label pairs
23 |      *
24 |      * @return array Format: array(array('value' => '<value>', 'label' => '<label>'), ...)
25 |      */
26 |     public function toOptionArray(): array
27 |     {
28 |         if ($this->options === null) {
29 |             $this->options[] = ['value' => 'use_public_id', 'label' => __('Public ID')];
30 |             $this->options[] = ['value' => 'use_head_and_body_script', 'label' => __('Head Script and Body Noscript')];
31 |         }
32 | 
33 |         return $this->options;
34 |     }
35 | }
36 | 


--------------------------------------------------------------------------------
/Model/Config/Source/OrderStatuses.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Model\Config\Source;
10 | 
11 | use Magento\Sales\Model\Config\Source\Order\Status as StatusModel;
12 | use Magento\Framework\Option\ArrayInterface;
13 | 
14 | class OrderStatuses implements ArrayInterface
15 | {
16 |     /**
17 |      * @var StatusModel
18 |      */
19 |     protected $statusModel;
20 | 
21 |     protected $optionArray;
22 | 
23 |     /**
24 |      * @param StatusModel $statusModel
25 |      */
26 |     public function __construct(
27 |         StatusModel $statusModel
28 |     ) {
29 |         $this->statusModel = $statusModel;
30 |     }
31 | 
32 |     /**
33 |      * @return array[]
34 |      */
35 |     public function toOptionArray()
36 |     {
37 |         if (!isset($this->optionArray)) {
38 |             $this->optionArray = [];
39 |             $this->optionArray[] = ['value' => __('any'), 'label' => __('Any status')];
40 | 
41 |             $statuses = $this->statusModel->toOptionArray();
42 |             foreach ($statuses as $status) {
43 |                 if (!isset($status['value']) || !isset($status['label'])) {
44 |                     continue;
45 |                 }
46 | 
47 |                 if (!$status['value'] || !$status['label']) {
48 |                     continue;
49 |                 }
50 | 
51 |                 $this->optionArray[] = ['value' => (string)$status['value'], 'label' => (string)$status['label']];
52 |             }
53 |         }
54 | 
55 |         return $this->optionArray;
56 |     }
57 | }
58 | 


--------------------------------------------------------------------------------
/Model/Config/Source/ProductAttribute.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Model\Config\Source;
10 | 
11 | use Magento\Catalog\Model\ResourceModel\Product\Attribute\CollectionFactory as AttributeCollectionFactory;
12 | use Magento\Framework\Data\OptionSourceInterface;
13 | 
14 | class ProductAttribute implements OptionSourceInterface
15 | {
16 |     /**
17 |      * @var AttributeCollectionFactory
18 |      */
19 |     private $attributeCollectionFactory;
20 | 
21 |     /**
22 |      * @var array
23 |      */
24 |     protected $options;
25 | 
26 |     /**
27 |      * ProductAttribute constructor.
28 |      *
29 |      * @param AttributeCollectionFactory $attributeCollectionFactory
30 |      */
31 |     public function __construct(
32 |         AttributeCollectionFactory $attributeCollectionFactory
33 |     ) {
34 |         $this->attributeCollectionFactory = $attributeCollectionFactory;
35 |     }
36 | 
37 |     /**
38 |      * Return array of options as value-label pairs
39 |      *
40 |      * @return array Format: array(array('value' => '<value>', 'label' => '<label>'), ...)
41 |      */
42 |     public function toOptionArray(): array
43 |     {
44 |         if ($this->options === null) {
45 |             $this->options = [];
46 | 
47 |             $this->options[] = [
48 |                 'value' => 'entity_id',
49 |                 'label' => 'Product ID'
50 |             ];
51 | 
52 |             $attributeCollection = $this->attributeCollectionFactory->create();
53 |             $attributeCollection->addVisibleFilter()
54 |                 ->setOrder('frontend_label', 'ASC');
55 | 
56 |             foreach ($attributeCollection->getItems() as $attribute) {
57 |                 $label = $attribute->getData('frontend_label');
58 |                 $value = $attribute->getData('attribute_code');
59 | 
60 |                 if (array_search($label, array_column($this->options, 'label')) !== false) {
61 |                     $label = $label . ' [' . $value . ']';
62 |                 }
63 | 
64 |                 $this->options[] = [
65 |                     'value' => $value,
66 |                     'label' => $label
67 |                 ];
68 |             }
69 |         }
70 | 
71 |         return $this->options;
72 |     }
73 | }
74 | 


--------------------------------------------------------------------------------
/Model/DataLayer/AbstractOrder.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Model\DataLayer;
10 | 
11 | use Magefan\GoogleTagManager\Model\AbstractDataLayer;
12 | use Magefan\GoogleTagManager\Model\Config;
13 | use Magento\Catalog\Api\CategoryRepositoryInterface;
14 | use Magento\Sales\Model\Order;
15 | use Magento\Store\Model\StoreManagerInterface;
16 | use Magefan\GoogleTagManager\Api\DataLayer\Order\ItemInterface;
17 | 
18 | abstract class AbstractOrder extends AbstractDataLayer
19 | {
20 |     /**
21 |      * @var ItemInterface
22 |      */
23 |     private $gtmItem;
24 | 
25 |     /**
26 |      * Purchase constructor.
27 |      *
28 |      * @param Config $config
29 |      * @param StoreManagerInterface $storeManager
30 |      * @param CategoryRepositoryInterface $categoryRepository
31 |      * @param ItemInterface $gtmItem
32 |      */
33 |     public function __construct(
34 |         Config $config,
35 |         StoreManagerInterface $storeManager,
36 |         CategoryRepositoryInterface $categoryRepository,
37 |         ItemInterface $gtmItem
38 |     ) {
39 |         $this->gtmItem = $gtmItem;
40 |         parent::__construct($config, $storeManager, $categoryRepository);
41 |     }
42 | 
43 |     /**
44 |      * @inheritDoc
45 |      */
46 |     public function get(Order $order, string $requester = ''): array
47 |     {
48 |         if ($order) {
49 |             $items = [];
50 |             foreach ($order->getAllVisibleItems() as $item) {
51 |                 $items[] = $this->gtmItem->get($item);
52 |             }
53 | 
54 |             return $this->eventWrap([
55 |                 'event' => $this->getEventName(),
56 |                 'ecommerce' => [
57 |                     'transaction_id' => $order->getIncrementId(),
58 |                     'value' => $this->getValue($order),
59 |                     'tax' => $this->formatPrice((float)$order->getTaxAmount()),
60 |                     'shipping' => $this->formatPrice((float)$order->getShippingAmount()),
61 |                     'currency' => $this->getCurrentCurrencyCode(),
62 |                     'coupon' => $order->getCouponCode() ?: '',
63 |                     'items' => $items
64 |                 ],
65 |                 'is_virtual' => (bool)$order->getIsVirtual(),
66 |                 'shipping_description' => $order->getShippingDescription(),
67 |                 'customer_is_guest' => (bool)$order->getCustomerIsGuest(),
68 |                 'customer_identifier' => hash('sha256', (string)$order->getCustomerEmail()),
69 |             ]);
70 |         }
71 | 
72 |         return [];
73 |     }
74 | 
75 |     /**
76 |      * @param Order $order
77 |      * @return float
78 |      */
79 |     protected function getValue(Order $order): float
80 |     {
81 |         $orderValue = (float)$order->getGrandTotal();
82 | 
83 |         if (!$this->config->isPurchaseTaxEnabled()) {
84 |             $orderValue -= $order->getTaxAmount();
85 |         }
86 | 
87 |         if (!$this->config->isPurchaseShippingEnabled()) {
88 |             $orderValue -= $order->getShippingAmount();
89 |         }
90 | 
91 |         return $this->formatPrice((float)$orderValue);
92 |     }
93 | 
94 |     /**
95 |      * @return string
96 |      */
97 |     abstract protected function getEventName(): string;
98 | }
99 | 


--------------------------------------------------------------------------------
/Model/DataLayer/BeginCheckout.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Model\DataLayer;
10 | 
11 | use Magefan\GoogleTagManager\Api\DataLayer\BeginCheckoutInterface;
12 | use Magefan\GoogleTagManager\Model\AbstractDataLayer;
13 | use Magefan\GoogleTagManager\Model\Config;
14 | use Magefan\GoogleTagManager\Api\DataLayer\Cart\ItemInterface;
15 | use Magento\Catalog\Api\CategoryRepositoryInterface;
16 | use Magento\Quote\Model\Quote;
17 | use Magento\Store\Model\StoreManagerInterface;
18 | 
19 | class BeginCheckout extends AbstractDataLayer implements BeginCheckoutInterface
20 | {
21 |     /**
22 |      * @var string
23 |      */
24 |     protected $ecommPageType = 'checkout';
25 | 
26 |     /**
27 |      * @var ItemInterface
28 |      */
29 |     private $gtmItem;
30 | 
31 |     /**
32 |      * BeginCheckout constructor.
33 |      *
34 |      * @param Config $config
35 |      * @param StoreManagerInterface $storeManager
36 |      * @param CategoryRepositoryInterface $categoryRepository
37 |      * @param ItemInterface $gtmItem
38 |      */
39 |     public function __construct(
40 |         Config $config,
41 |         StoreManagerInterface $storeManager,
42 |         CategoryRepositoryInterface $categoryRepository,
43 |         ItemInterface $gtmItem
44 |     ) {
45 |         $this->gtmItem = $gtmItem;
46 |         parent::__construct($config, $storeManager, $categoryRepository);
47 |     }
48 | 
49 |     /**
50 |      * @inheritDoc
51 |      */
52 |     public function get(Quote $quote): array
53 |     {
54 |         $items = [];
55 |         $value = 0;
56 | 
57 |         foreach ($quote->getAllVisibleItems() as $quoteItem) {
58 |             $item = $this->gtmItem->get($quoteItem);
59 |             $items[] = $item;
60 |             $value += $item['price'] * $item['quantity'];
61 |         }
62 | 
63 |         return $this->eventWrap([
64 |             'event' => 'begin_checkout',
65 |             'ecommerce' => [
66 |                 'currency' => $this->getCurrentCurrencyCode(),
67 |                 'value' => $this->formatPrice((float)$value),
68 |                 'coupon' => $quote->getCouponCode() ?: '',
69 |                 'items' => $items
70 |             ],
71 |             'customer_identifier' => $quote->getCustomerEmail() ? hash('sha256', (string)$quote->getCustomerEmail()) : ''
72 |         ]);
73 |     }
74 | }
75 | 


--------------------------------------------------------------------------------
/Model/DataLayer/Cart/Item.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Model\DataLayer\Cart;
10 | 
11 | use Magefan\GoogleTagManager\Api\DataLayer\Cart\ItemInterface;
12 | use Magefan\GoogleTagManager\Model\AbstractDataLayer;
13 | use Magento\Quote\Model\Quote\Item as QuoteItem;
14 | 
15 | class Item extends AbstractDataLayer implements ItemInterface
16 | {
17 |     /**
18 |      * @inheritDoc
19 |      */
20 |     public function get(QuoteItem $quoteItem): array
21 |     {
22 |         $product = $quoteItem->getProduct();
23 |         $categoryNames = $this->getCategoryNames($product);
24 |         return array_merge([
25 |             'item_id' => ($this->config->getProductAttribute() == 'sku')
26 |                 ? $quoteItem->getSku()
27 |                 : $this->getProductAttributeValue($product, $this->config->getProductAttribute()),
28 |             'item_name' => $quoteItem->getName(),
29 |             'discount' => $this->formatPrice((float)$quoteItem->getDiscountAmount()),
30 |             'coupon_code' => $quoteItem->getQuote()->getCouponCode() ?: '',
31 |             'item_brand' => $this->getProductAttributeValue($product, $this->config->getBrandAttribute()),
32 |             'price' => $this->getValue($quoteItem),
33 |             'quantity' => $quoteItem->getQty() * 1
34 |         ], $categoryNames);
35 |     }
36 | 
37 |     /**
38 |      * @param $quoteItem
39 |      * @return float
40 |      */
41 |     protected function getValue(QuoteItem $quoteItem): float
42 |     {
43 |         if ($this->config->isPurchaseTaxEnabled()) {
44 |             $value = (float)$quoteItem->getPriceInclTax();
45 |             if (!$value) {
46 |                 $value = (float)$quoteItem->getPrice();
47 |             }
48 |         } else {
49 |             $value = (float)$quoteItem->getPrice();
50 |         }
51 | 
52 |         //fix for magento 2.3.2 - module-quote/Model/Quote/Item/Processor.php prepareItem does not set price to quote item
53 |         if (!$value && ($quoteItemProduct = $quoteItem->getProduct())) {
54 |             return $this->getProductValue($quoteItemProduct);
55 |         } else {
56 |             return $this->formatPrice((float)$value);
57 |         }
58 |     }
59 | }
60 | 


--------------------------------------------------------------------------------
/Model/DataLayer/Order/Item.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Model\DataLayer\Order;
10 | 
11 | use Magefan\GoogleTagManager\Api\DataLayer\Order\ItemInterface;
12 | use Magefan\GoogleTagManager\Model\AbstractDataLayer;
13 | use Magento\Sales\Api\Data\OrderItemInterface;
14 | 
15 | class Item extends AbstractDataLayer implements ItemInterface
16 | {
17 |     /**
18 |      * @inheritDoc
19 |      */
20 |     public function get(OrderItemInterface $orderItem): array
21 |     {
22 |         $product = $orderItem->getProduct();
23 |         $categoryNames = $this->getCategoryNames($product);
24 |         return array_merge([
25 |             'item_id' => ($this->config->getProductAttribute() == 'sku')
26 |                 ? $orderItem->getSku()
27 |                 : $this->getProductAttributeValue($product, $this->config->getProductAttribute()),
28 |             'item_name' => $orderItem->getName(),
29 |             'discount' => $this->formatPrice((float)$orderItem->getDiscountAmount()),
30 |             'item_brand' => $this->getProductAttributeValue($product, $this->config->getBrandAttribute()),
31 |             'price' => $this->getValue($orderItem),
32 |             'quantity' => $orderItem->getQtyOrdered() * 1
33 |         ], $categoryNames);
34 |     }
35 | 
36 |     /**
37 |      * @param $quoteItem
38 |      * @return float
39 |      */
40 |     protected function getValue(OrderItemInterface $orderItem): float
41 |     {
42 |         if ($this->config->isPurchaseTaxEnabled()) {
43 |             $value = (float)$orderItem->getPriceInclTax();
44 |         } else {
45 |             $value = (float)$orderItem->getPrice();
46 |         }
47 | 
48 |         return $this->formatPrice((float)$value);
49 |     }
50 | }
51 | 


--------------------------------------------------------------------------------
/Model/DataLayer/Product/Item.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Model\DataLayer\Product;
10 | 
11 | use Magefan\GoogleTagManager\Api\DataLayer\Product\ItemInterface;
12 | use Magefan\GoogleTagManager\Model\AbstractDataLayer;
13 | use Magento\Catalog\Model\Product;
14 | 
15 | class Item extends AbstractDataLayer implements ItemInterface
16 | {
17 |     /**
18 |      * @inheritDoc
19 |      */
20 |     public function get(Product $product): array
21 |     {
22 |         $categoryNames = $this->getCategoryNames($product);
23 |         return array_merge([
24 |             'item_id' => $this->getProductAttributeValue($product, $this->config->getProductAttribute()),
25 |             'item_name' => $product->getName(),
26 |             'item_url' => $product->getProductUrl(),
27 |             'item_brand' => $this->getProductAttributeValue($product, $this->config->getBrandAttribute()),
28 |             'price' => $this->getProductValue($product)
29 |         ], $categoryNames);
30 |     }
31 | }
32 | 


--------------------------------------------------------------------------------
/Model/DataLayer/Purchase.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Model\DataLayer;
10 | 
11 | use Magefan\GoogleTagManager\Api\DataLayer\PurchaseInterface;
12 | 
13 | class Purchase extends AbstractOrder implements PurchaseInterface
14 | {
15 |     /**
16 |      * @var string
17 |      */
18 |     protected $ecommPageType = 'purchase';
19 | 
20 |     /**
21 |      * @return string
22 |      */
23 |     protected function getEventName(): string
24 |     {
25 |         return 'purchase';
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/Model/DataLayer/ViewCart.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Model\DataLayer;
10 | 
11 | use Magefan\GoogleTagManager\Api\DataLayer\ViewCartInterface;
12 | use Magefan\GoogleTagManager\Model\AbstractDataLayer;
13 | use Magefan\GoogleTagManager\Model\Config;
14 | use Magento\Catalog\Api\CategoryRepositoryInterface;
15 | use Magento\Quote\Model\Quote;
16 | use Magefan\GoogleTagManager\Api\DataLayer\Cart\ItemInterface;
17 | use Magento\Store\Model\StoreManagerInterface;
18 | 
19 | class ViewCart extends AbstractDataLayer implements ViewCartInterface
20 | {
21 |     /**
22 |      * @var string
23 |      */
24 |     protected $ecommPageType = 'cart';
25 | 
26 |     /**
27 |      * @var ItemInterface
28 |      */
29 |     private $gtmItem;
30 | 
31 |     /**
32 |      * ViewCart constructor.
33 |      *
34 |      * @param Config $config
35 |      * @param StoreManagerInterface $storeManager
36 |      * @param CategoryRepositoryInterface $categoryRepository
37 |      * @param ItemInterface $gtmItem
38 |      */
39 |     public function __construct(
40 |         Config $config,
41 |         StoreManagerInterface $storeManager,
42 |         CategoryRepositoryInterface $categoryRepository,
43 |         ItemInterface $gtmItem
44 |     ) {
45 |         $this->gtmItem = $gtmItem;
46 |         parent::__construct($config, $storeManager, $categoryRepository);
47 |     }
48 | 
49 |     /**
50 |      * @inheritDoc
51 |      */
52 |     public function get(Quote $quote): array
53 |     {
54 |         $items = [];
55 |         $itemsQty = 0;
56 |         $value = 0;
57 | 
58 |         foreach ($quote->getAllVisibleItems() as $quoteItem) {
59 |             $item = $this->gtmItem->get($quoteItem);
60 |             $items[] = $item;
61 |             $itemsQty += $item['quantity'];
62 |             $value += $item['price'] * $item['quantity'];
63 |         }
64 | 
65 |         return $this->eventWrap([
66 |             'event' => 'view_cart',
67 |             'ecommerce' => [
68 |                 'currency' => $this->getCurrentCurrencyCode(),
69 |                 'value' => $this->formatPrice((float)$value),
70 |                 'items' => $items
71 |             ],
72 |             'items_count' => count($items),
73 |             'items_qty' => $itemsQty,
74 |             'coupon_code' => $quote->getCouponCode() ?: '',
75 |             'customer_identifier' => $quote->getCustomerEmail() ? hash('sha256', (string)$quote->getCustomerEmail()) : ''
76 |         ]);
77 |     }
78 | }
79 | 


--------------------------------------------------------------------------------
/Model/DataLayer/ViewItem.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Model\DataLayer;
10 | 
11 | use Magefan\GoogleTagManager\Api\DataLayer\ViewItemInterface;
12 | use Magefan\GoogleTagManager\Model\Config;
13 | use Magento\Catalog\Api\CategoryRepositoryInterface;
14 | use Magento\Catalog\Model\Product;
15 | use Magefan\GoogleTagManager\Model\AbstractDataLayer;
16 | use Magento\Store\Model\StoreManagerInterface;
17 | use Magefan\GoogleTagManager\Api\DataLayer\Product\ItemInterface;
18 | 
19 | class ViewItem extends AbstractDataLayer implements ViewItemInterface
20 | {
21 |     /**
22 |      * @var string
23 |      */
24 |     protected $ecommPageType = 'product';
25 | 
26 |     /**
27 |      * @var ItemInterface
28 |      */
29 |     private $gtmItem;
30 | 
31 |     /**
32 |      * ViewItem constructor.
33 |      *
34 |      * @param Config $config
35 |      * @param StoreManagerInterface $storeManager
36 |      * @param CategoryRepositoryInterface $categoryRepository
37 |      * @param ItemInterface $gtmItem
38 |      */
39 |     public function __construct(
40 |         Config $config,
41 |         StoreManagerInterface $storeManager,
42 |         CategoryRepositoryInterface $categoryRepository,
43 |         ItemInterface $gtmItem
44 |     ) {
45 |         $this->gtmItem = $gtmItem;
46 |         parent::__construct($config, $storeManager, $categoryRepository);
47 |     }
48 | 
49 |     /**
50 |      * @inheritDoc
51 |      */
52 |     public function get(Product $product): array
53 |     {
54 |         $item = $this->gtmItem->get($product);
55 |         return $this->eventWrap([
56 |             'event' => 'view_item',
57 |             'ecommerce' => [
58 |                 'currency' => $this->getCurrentCurrencyCode(),
59 |                 'value' => $this->getProductValue($product),
60 |                 'items' => [
61 |                     $item
62 |                 ]
63 |             ]
64 |         ]);
65 |     }
66 | }
67 | 


--------------------------------------------------------------------------------
/Model/ResourceModel/Transaction.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Model\ResourceModel;
10 | 
11 | use Magento\Framework\Model\ResourceModel\Db\AbstractDb;
12 | 
13 | class Transaction extends AbstractDb
14 | {
15 | 
16 |     /**
17 |      * @inheritDoc
18 |      */
19 |     protected function _construct()
20 |     {
21 |         $this->_init('magefan_gtm_transaction', 'id');
22 |     }
23 | }
24 | 


--------------------------------------------------------------------------------
/Model/ResourceModel/Transaction/Collection.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Model\ResourceModel\Transaction;
10 | 
11 | use Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection;
12 | 
13 | class Collection extends AbstractCollection
14 | {
15 | 
16 |     /**
17 |      * @inheritDoc
18 |      */
19 |     protected $_idFieldName = 'id';
20 | 
21 |     /**
22 |      * @inheritDoc
23 |      */
24 |     protected function _construct()
25 |     {
26 |         $this->_init(
27 |             \Magefan\GoogleTagManager\Model\Transaction::class,
28 |             \Magefan\GoogleTagManager\Model\ResourceModel\Transaction::class
29 |         );
30 |     }
31 | }
32 | 


--------------------------------------------------------------------------------
/Model/Transaction.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Model;
10 | 
11 | use Magento\Framework\Model\AbstractModel;
12 | 
13 | class Transaction extends AbstractModel
14 | {
15 | 
16 |     /**
17 |      * @inheritDoc
18 |      */
19 |     public function _construct()
20 |     {
21 |         $this->_init(\Magefan\GoogleTagManager\Model\ResourceModel\Transaction::class);
22 |     }
23 | }
24 | 


--------------------------------------------------------------------------------
/Model/Transaction/Log.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
  4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
  5 |  */
  6 | 
  7 | declare(strict_types=1);
  8 | 
  9 | namespace Magefan\GoogleTagManager\Model\Transaction;
 10 | 
 11 | use Magefan\GoogleTagManager\Model\ResourceModel\Transaction\CollectionFactory as TransactionCollectionFactory;
 12 | use Magefan\GoogleTagManager\Model\TransactionFactory;
 13 | use Magefan\GoogleTagManager\Model\TransactionRepository;
 14 | use Magefan\GoogleTagManager\Api\Transaction\LogInterface;
 15 | use Magento\Sales\Model\OrderFactory;
 16 | use Magento\Sales\Api\Data\OrderInterface as Order;
 17 | use Magento\Framework\Exception\CouldNotSaveException;
 18 | use Psr\Log\LoggerInterface;
 19 | 
 20 | class Log implements LogInterface
 21 | {
 22 |     /**
 23 |      * @var TransactionCollectionFactory
 24 |      */
 25 |     private $transactionCollectionFactory;
 26 | 
 27 |     /**
 28 |      * @var TransactionFactory
 29 |      */
 30 |     private $transactionFactory;
 31 | 
 32 |     /**
 33 |      * @var TransactionRepository
 34 |      */
 35 |     private $transactionRepository;
 36 | 
 37 |     /**
 38 |      * @var OrderFactory
 39 |      */
 40 |     private $orderFactory;
 41 | 
 42 |     /**
 43 |      * @var LoggerInterface
 44 |      */
 45 |     private $logger;
 46 | 
 47 | 
 48 |     /**
 49 |      * @param TransactionCollectionFactory $transactionCollectionFactory
 50 |      * @param TransactionFactory $transactionFactory
 51 |      * @param TransactionRepository $transactionRepository
 52 |      * @param OrderFactory $orderFactory
 53 |      * @param LoggerInterface $logger
 54 |      */
 55 |     public function __construct(
 56 |         TransactionCollectionFactory $transactionCollectionFactory,
 57 |         TransactionFactory $transactionFactory,
 58 |         TransactionRepository $transactionRepository,
 59 |         OrderFactory $orderFactory,
 60 |         LoggerInterface $logger
 61 |     ) {
 62 |         $this->transactionCollectionFactory = $transactionCollectionFactory;
 63 |         $this->transactionFactory = $transactionFactory;
 64 |         $this->transactionRepository = $transactionRepository;
 65 |         $this->orderFactory = $orderFactory;
 66 |         $this->logger = $logger;
 67 |     }
 68 | 
 69 |     /**
 70 |      * @param mixed $order
 71 |      * @param string $requester
 72 |      * @return void
 73 |      */
 74 |     public function logTransaction($order, string $requester)
 75 |     {
 76 |         $order = $this->getOrder($order);
 77 | 
 78 |         $transactionModel = $this->transactionFactory->create();
 79 | 
 80 |         $transactionModel->setTransactionId((string)$order->getIncrementId());
 81 |         $transactionModel->setStoreId((int)$order->getStoreId());
 82 |         $transactionModel->setRequester($requester);
 83 | 
 84 |         try {
 85 |             $this->transactionRepository->save($transactionModel);
 86 |         } catch (CouldNotSaveException $e) {
 87 |             $this->logger->log("Magefan_GoogleTagManager error while logging transaction id: " . $order->getIncrementId()
 88 |                 . ' and requester: ' . $requester);
 89 |         }
 90 |     }
 91 | 
 92 |     /**
 93 |      * @param mixed $order
 94 |      * @param string $requester
 95 |      * @return bool
 96 |      */
 97 |     public function isTransactionUnique($order, string $requester): bool
 98 |     {
 99 |         $order = $this->getOrder($order);
100 | 
101 |         $transactionsForRequesterByTransactionId = $this->transactionFactory->create()->getCollection()->addFieldToFilter(
102 |             'requester',
103 |             $requester
104 |         )->addFieldToFilter(
105 |             'transaction_id',
106 |             $order->getIncrementId()
107 |         )->addFieldToFilter(
108 |             'store_id',
109 |             (int)$order->getStoreId()
110 |         );
111 | 
112 |         if (count($transactionsForRequesterByTransactionId)) {
113 |             return false;
114 |         }
115 | 
116 |         return true;
117 |     }
118 | 
119 |     /**
120 |      * @param $order
121 |      * @return Order
122 |      * @throws \Exception
123 |      */
124 |     private function getOrder($order): Order
125 |     {
126 |         if (is_object($order)) {
127 |             if (!($order instanceof Order)) {
128 |                 throw new \Exception('Object is not instance of OrderInterface.');
129 |             }
130 |         } else {
131 |             $order = $this->orderFactory->create()->loadByIncrementId((string)$order);
132 |             if (!$order->getId()) {
133 |                 throw new \Exception('Order with such ID does not exist.');
134 |             }
135 |         }
136 | 
137 |         return $order;
138 |     }
139 | }
140 | 


--------------------------------------------------------------------------------
/Model/TransactionRepository.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Model;
10 | 
11 | use Magefan\GoogleTagManager\Model\ResourceModel\Transaction as ResourceTransaction;
12 | use Magefan\GoogleTagManager\Model\TransactionFactory;
13 | use Magento\Framework\Exception\CouldNotSaveException;
14 | use Magento\Framework\Exception\NoSuchEntityException;
15 | 
16 | class TransactionRepository
17 | {
18 | 
19 |     /**
20 |      * @var ResourceTransaction
21 |      */
22 |     protected $resource;
23 | 
24 |     /**
25 |      * @var TransactionFactory
26 |      */
27 |     protected $transactionFactory;
28 | 
29 |     /**
30 |      * @param ResourceTransaction $resource
31 |      * @param TransactionFactory $transactionFactory
32 |      */
33 |     public function __construct(
34 |         ResourceTransaction $resource,
35 |         TransactionFactory $transactionFactory
36 |     ) {
37 |         $this->resource = $resource;
38 |         $this->transactionFactory = $transactionFactory;
39 |     }
40 | 
41 |     /**
42 |      * @param Transaction $transaction
43 |      * @return Transaction
44 |      * @throws CouldNotSaveException
45 |      */
46 |     public function save(Transaction $transaction)
47 |     {
48 |         try {
49 |             $this->resource->save($transaction);
50 |         } catch (\Exception $exception) {
51 |             throw new CouldNotSaveException(__(
52 |                 'Could not save the transaction: %1',
53 |                 $exception->getMessage()
54 |             ));
55 |         }
56 |         return $transaction;
57 |     }
58 | 
59 |     /**
60 |      * @param $transactionId
61 |      * @return mixed
62 |      * @throws NoSuchEntityException
63 |      */
64 |     public function get($transactionId)
65 |     {
66 |         $transaction = $this->transactionFactory->create();
67 |         $this->resource->load($transaction, $transactionId);
68 |         if (!$transaction->getId()) {
69 |             throw new NoSuchEntityException(__('Transaction with id "%1" does not exist.', $transactionId));
70 |         }
71 |         return $transaction;
72 |     }
73 | }
74 | 


--------------------------------------------------------------------------------
/Model/WebContainer.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
  4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
  5 |  */
  6 | 
  7 | declare(strict_types=1);
  8 | 
  9 | namespace Magefan\GoogleTagManager\Model;
 10 | 
 11 | use Magento\Framework\Exception\NoSuchEntityException;
 12 | use Magento\Framework\Stdlib\DateTime\DateTime;
 13 | use Magento\Store\Model\StoreManagerInterface;
 14 | use Magefan\GoogleTagManager\Api\ContainerInterface;
 15 | 
 16 | class WebContainer implements ContainerInterface
 17 | {
 18 |     /**
 19 |      * @var StoreManagerInterface
 20 |      */
 21 |     private $storeManager;
 22 | 
 23 |     /**
 24 |      * @var DateTime
 25 |      */
 26 |     private $dateTime;
 27 | 
 28 |     /**
 29 |      * @var Config
 30 |      */
 31 |     private $config;
 32 | 
 33 |     /**
 34 |      * Container constructor.
 35 |      *
 36 |      * @param StoreManagerInterface $storeManager
 37 |      * @param DateTime $dateTime
 38 |      * @param Config $config
 39 |      */
 40 |     public function __construct(
 41 |         StoreManagerInterface $storeManager,
 42 |         DateTime $dateTime,
 43 |         Config $config
 44 |     ) {
 45 |         $this->storeManager = $storeManager;
 46 |         $this->dateTime = $dateTime;
 47 |         $this->config = $config;
 48 |     }
 49 | 
 50 |     /**
 51 |      * Generate JSON container
 52 |      *
 53 |      * @param string|null $storeId
 54 |      * @return array
 55 |      * @throws NoSuchEntityException
 56 |      */
 57 |     public function generate(?string $storeId = null): array
 58 |     {
 59 |         $store = $this->storeManager->getStore($storeId);
 60 |         $timestamp = (string)$this->dateTime->timestamp();
 61 |         $accountId = $this->config->getAccountId($storeId);
 62 |         $containerId = $this->config->getContainerId($storeId);
 63 |         $publicId = $this->config->getPublicId($storeId);
 64 |         $isAnalyticsEnabled = $this->config->isAnalyticsEnabled($storeId);
 65 | 
 66 |         return [
 67 |             'exportFormatVersion' => 2,
 68 |             'exportTime' => $this->dateTime->date('Y-m-d H:i:s'),
 69 |             'containerVersion' => [
 70 |                 'path' => 'accounts/' . $accountId . '/containers/' . $containerId . '/versions/0',
 71 |                 'accountId' => $accountId,
 72 |                 'containerId' => $containerId,
 73 |                 'containerVersionId' => '0',
 74 |                 'container' => [
 75 |                     'path' => 'accounts/' . $accountId . '/containers/' . $containerId,
 76 |                     'accountId' => $accountId,
 77 |                     'containerId' => $containerId,
 78 |                     //'name' => '',
 79 |                     'publicId' => $publicId,
 80 |                     'usageContext' => [
 81 |                         'WEB'
 82 |                     ],
 83 |                     'fingerprint' => $timestamp,
 84 |                     'tagManagerUrl' => 'https://tagmanager.google.com/#/container/accounts/' . $accountId
 85 |                         . '/containers/' . $containerId . '/workspaces?apiLink=container'
 86 |                 ],
 87 |                 'tag' => $isAnalyticsEnabled ? $this->generateTags($accountId, $containerId, $timestamp, $storeId) : [],
 88 |                 'trigger' => $isAnalyticsEnabled ? $this->generateTriggers($accountId, $containerId, $timestamp) : [],
 89 |                 'variable' => $isAnalyticsEnabled ? $this->generateVariable($accountId, $containerId, $timestamp, $storeId) : [],
 90 |                 'builtInVariable' => $isAnalyticsEnabled ? [
 91 |                     [
 92 |                         'accountId' => $accountId,
 93 |                         'containerId' => $containerId,
 94 |                         'type' => 'EVENT',
 95 |                         'name' => 'Event'
 96 |                     ]
 97 |                 ] : [],
 98 |                 'fingerprint' => $timestamp,
 99 |                 'tagManagerUrl' => 'https://tagmanager.google.com/#/versions/accounts/' . $accountId
100 |                     . '/containers/' . $containerId . '/versions/0?apiLink=version'
101 |             ]
102 |         ];
103 |     }
104 | 
105 |     /**
106 |      * Get triggers for container
107 |      *
108 |      * @param string $accountId
109 |      * @param string $containerId
110 |      * @param string $timestamp
111 |      * @return array
112 |      */
113 |     private function generateTriggers(string $accountId, string $containerId, string $timestamp): array
114 |     {
115 |         $triggers[] = [
116 |             'accountId' => $accountId,
117 |             'containerId' => $containerId,
118 |             'triggerId' => '162',
119 |             'name' => 'Magefan GTM - Configuration',
120 |             'type' => 'PAGEVIEW',
121 |             'fingerprint' => $timestamp
122 |         ];
123 | 
124 |         $triggers[] = [
125 |             'accountId' => $accountId,
126 |             'containerId' => $containerId,
127 |             'triggerId' => '167',
128 |             'name' => 'Magefan GTM - Ecommerce',
129 |             'type' => 'CUSTOM_EVENT',
130 |             'customEventFilter' => [
131 |                 [
132 |                     'type' => 'MATCH_REGEX',
133 |                     'parameter' => [
134 |                         [
135 |                             'type' => 'TEMPLATE',
136 |                             'key' => 'arg0',
137 |                             'value' => '{{_event}}'
138 |                         ],
139 |                         [
140 |                             'type' => 'TEMPLATE',
141 |                             'key' => 'arg1',
142 |                             'value' => 'view_item|view_cart|purchase|begin_checkout'
143 |                         ]
144 |                     ]
145 |                 ]
146 |             ],
147 |             'fingerprint' => $timestamp
148 |         ];
149 | 
150 |         $triggerNames = ['View Item', 'View Cart', 'Purchase', 'Begin Checkout'];
151 |         foreach ($triggerNames as $key => $triggerName) {
152 |             $triggers[] = [
153 |                 'accountId' => $accountId,
154 |                 'containerId' => $containerId,
155 |                 'triggerId' => 168 + $key,
156 |                 'name' => 'Magefan GTM - ' . $triggerName,
157 |                 'type' => 'CUSTOM_EVENT',
158 |                 'customEventFilter' => [
159 |                     [
160 |                         'type' => 'EQUALS',
161 |                         'parameter' => [
162 |                             [
163 |                                 'type' => 'TEMPLATE',
164 |                                 'key' => 'arg0',
165 |                                 'value' => '{{_event}}'
166 |                             ],
167 |                             [
168 |                                 'type' => 'TEMPLATE',
169 |                                 'key' => 'arg1',
170 |                                 'value' => strtolower(str_replace(' ', '_', $triggerName))
171 |                             ]
172 |                         ]
173 |                     ]
174 |                 ],
175 |                 'fingerprint' => $timestamp
176 |             ];
177 |         }
178 | 
179 |         return $triggers;
180 |     }
181 | 
182 |     /**
183 |      * Get tags for container
184 |      *
185 |      * @param string $accountId
186 |      * @param string $containerId
187 |      * @param string $timestamp
188 |      * @param string|null $storeId
189 |      * @return array
190 |      */
191 |     private function generateTags(
192 |         string $accountId,
193 |         string $containerId,
194 |         string $timestamp,
195 |         ?string $storeId = null
196 |     ): array {
197 |         return [
198 |             [
199 |                 'accountId' => $accountId,
200 |                 'containerId' => $containerId,
201 |                 'tagId' => '163',
202 |                 'name' => 'Magefan GA4 - Configuration',
203 |                 'type' => 'googtag',
204 |                 'parameter' => [
205 |                     [
206 |                         'type' => 'TEMPLATE',
207 |                         'key' => 'tagId',
208 |                         'value' => '{{Magefan GA4 - Measurement ID}}'
209 |                     ],
210 |                     [
211 |                         'type' => 'LIST',
212 |                         'key' => 'configSettingsTable',
213 |                         'list' => [
214 |                             [
215 |                                 'type' => 'MAP',
216 |                                 'map' => [
217 |                                     [
218 |                                         'type' => 'TEMPLATE',
219 |                                         'key' => 'parameter',
220 |                                         'value' => 'send_page_view'
221 |                                     ],
222 |                                     [
223 |                                         'type' => 'TEMPLATE',
224 |                                         'key' => 'parameterValue',
225 |                                         'value' => 'true'
226 |                                     ]
227 |                                 ]
228 |                             ]
229 |                         ]
230 |                     ]
231 |                 ],
232 |                 'fingerprint' => $timestamp,
233 |                 'firingTriggerId' => [
234 |                     '162'
235 |                 ],
236 |                 'tagFiringOption' => 'ONCE_PER_EVENT',
237 |                 'monitoringMetadata' => [
238 |                     'type' => 'MAP'
239 |                 ],
240 |                 'consentSettings' => [
241 |                     'consentStatus' => 'NOT_SET'
242 |                 ]
243 |             ],
244 |             [
245 |                 'accountId' => $accountId,
246 |                 'containerId' => $containerId,
247 |                 'tagId' => '169',
248 |                 'name' => 'Magefan GA4 - Ecommerce',
249 |                 'type' => 'gaawe',
250 |                 'parameter' => [
251 |                     [
252 |                         'type' => 'BOOLEAN',
253 |                         'key' => 'sendEcommerceData',
254 |                         'value' => 'true'
255 |                     ],
256 |                     [
257 |                         'type' => 'TEMPLATE',
258 |                         'key' => 'getEcommerceDataFrom',
259 |                         'value' => 'dataLayer'
260 |                     ],
261 |                     [
262 |                         'type' => 'TEMPLATE',
263 |                         'key' => 'eventName',
264 |                         'value' => '{{Event}}'
265 |                     ],
266 |                     [
267 |                         'type' => 'TEMPLATE',
268 |                         'key' => 'measurementIdOverride',
269 |                         'value' => '{{Magefan GA4 - Measurement ID}}'
270 |                     ],
271 |                     [
272 |                         "type" => "TEMPLATE",
273 |                         "key" => "eventSettingsVariable",
274 |                         "value" => "{{Magefan GA4 - User ID}}"
275 |                     ]
276 |                 ],
277 |                 'fingerprint' => $timestamp,
278 |                 'firingTriggerId' => [
279 |                     '167'
280 |                 ],
281 |                 'tagFiringOption' => 'ONCE_PER_EVENT',
282 |                 'monitoringMetadata' => [
283 |                     'type' => 'MAP'
284 |                 ],
285 |                 'consentSettings' => [
286 |                     'consentStatus' => 'NOT_SET'
287 |                 ]
288 |             ]
289 |         ];
290 |     }
291 | 
292 |     /**
293 |      * @param string $accountId
294 |      * @param string $containerId
295 |      * @param string $timestamp
296 |      * @param string|null $storeId
297 |      * @return array[]
298 |      */
299 |     private function generateVariable(
300 |         string $accountId,
301 |         string $containerId,
302 |         string $timestamp,
303 |         ?string $storeId = null
304 |     ): array {
305 |         return [
306 |             [
307 |                 'accountId' => $accountId,
308 |                 'containerId' => $containerId,
309 |                 'variableId' => '692',
310 |                 'name' => 'Magefan GA4 - Measurement ID',
311 |                 'type' => 'c',
312 |                 'parameter' => [
313 |                     [
314 |                         'type' => 'TEMPLATE',
315 |                         'key' => 'value',
316 |                         'value' => $this->config->getMeasurementId($storeId)
317 |                     ],
318 |                 ]
319 |             ],
320 |             [
321 |                 'accountId' => $accountId,
322 |                 'containerId' => $containerId,
323 |                 'variableId' => '256',
324 |                 'name' => 'Magefan DLV - Customer Email Hash',
325 |                 'type' => 'v',
326 |                 'parameter' => [
327 |                     [
328 |                         'type' => 'INTEGER',
329 |                         'key' => 'dataLayerVersion',
330 |                         'value' => '2'
331 |                     ],
332 |                     [
333 |                         'type' => 'BOOLEAN',
334 |                         'key' => 'setDefaultValue',
335 |                         'value' => 'false'
336 |                     ],
337 |                     [
338 |                         'type' => 'TEMPLATE',
339 |                         'key' => 'name',
340 |                         'value' => 'customer_identifier'
341 |                     ]
342 |                 ],
343 |                 'fingerprint' => $timestamp,
344 |                 'formatValue' => (object)[]
345 |             ],
346 |             [
347 |                 'accountId' => $accountId,
348 |                 'containerId' => $containerId,
349 |                 'variableId'=>'43',
350 |                 'name'=>'Magefan GA4 - User ID',
351 |                 'type'=>'gtes',
352 |                 'parameter'=>[
353 |                     [
354 |                         'type'=>'LIST',
355 |                         'key'=>'eventSettingsTable',
356 |                         'list'=>[
357 |                             [
358 |                                 'type'=>'MAP',
359 |                                 'map'=>[
360 |                                     [
361 |                                         'type'=>'TEMPLATE',
362 |                                         'key'=>'parameter',
363 |                                         'value'=>'user_id'
364 |                                     ],
365 |                                     [
366 |                                         'type'=>'TEMPLATE',
367 |                                         'key'=>'parameterValue',
368 |                                         'value'=>'{{Magefan DLV - Customer Email Hash}}'
369 |                                     ]
370 |                                 ]
371 |                             ]
372 |                         ]
373 |                     ]
374 |                 ],
375 |                 'fingerprint' => $timestamp
376 |             ]
377 |         ];
378 |     }
379 | }
380 | 


--------------------------------------------------------------------------------
/Plugin/Magefan/GoogleTagManager/Api/DataLayer/PurchaseInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Plugin\Magefan\GoogleTagManager\Api\DataLayer;
10 | 
11 | use Magefan\GoogleTagManager\Api\DataLayer\PurchaseInterface as Subject;
12 | use Magefan\GoogleTagManager\Model\TransactionFactory;
13 | use Magento\Sales\Model\Order;
14 | use Magefan\GoogleTagManager\Api\Transaction\LogInterface as TransactionLog;
15 | 
16 | class PurchaseInterface
17 | {
18 |     /**
19 |      * @var TransactionLog
20 |      */
21 |     protected $transactionLog;
22 | 
23 |     /**
24 |      * @param TransactionLog $transactionLog
25 |      */
26 |     public function __construct(
27 |         TransactionLog $transactionLog
28 |     ) {
29 |         $this->transactionLog = $transactionLog;
30 |     }
31 | 
32 |     /**
33 |      * Prevent double purchase tracking by the same requester
34 |      * @param Subject $subject
35 |      * @param $proceed
36 |      * @param Order $order
37 |      * @param string $requester
38 |      * @return array
39 |      */
40 |     public function aroundGet(Subject $subject, $proceed, Order $order, string $requester = ''): array
41 |     {
42 |         if ($this->transactionLog->isTransactionUnique($order, $requester)) {
43 |             $this->transactionLog->logTransaction($order, $requester);
44 |             return $proceed($order, $requester);
45 |         } else {
46 |             return [];
47 |         }
48 |     }
49 | }
50 | 


--------------------------------------------------------------------------------
/Plugin/Magento/Customer/CustomerData/Customer.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Magefan\GoogleTagManager\Plugin\Magento\Customer\CustomerData;
10 | 
11 | use Magento\Customer\Model\Session;
12 | use Magefan\GoogleTagManager\Model\Config;
13 | 
14 | class Customer
15 | {
16 |     /**
17 |      * @var Session
18 |      */
19 |     private $session;
20 |     /**
21 |      * @var Config
22 |      */
23 |     private $config;
24 | 
25 |     /**
26 |      * @param Session $session
27 |      */
28 |     public function __construct(
29 |         Session $session,
30 |         Config $config
31 |     ) {
32 |         $this->session = $session;
33 |         $this->config = $config;
34 |     }
35 | 
36 |     /**
37 |      * @param \Magento\Customer\CustomerData\Customer $subject
38 |      * @param $result
39 |      * @return void
40 |      */
41 |     public function afterGetSectionData(
42 |         \Magento\Customer\CustomerData\Customer $subject,
43 |         $result
44 |     ) {
45 |         if ($this->config->isEnabled()) {
46 |             if ($this->session->getCustomerId()) {
47 |                 $result['mf_gtm_customer_identifier'] = hash('sha256', (string)$this->session->getCustomer()->getEmail());
48 |             }
49 |         }
50 | 
51 |         return $result;
52 |     }
53 | }
54 | 


--------------------------------------------------------------------------------
/Plugin/Magento/Framework/App/Config/ScopeConfig.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Magefan\GoogleTagManager\Plugin\Magento\Framework\App\Config;
 4 | 
 5 | use Magento\Framework\App\Config\ScopeConfigInterface;
 6 | use Magefan\GoogleTagManager\Model\Config;
 7 | 
 8 | class ScopeConfig
 9 | {
10 |     /**
11 |      * @var Config
12 |      */
13 |     private $config;
14 | 
15 |     const PATHS = ['google/adwords/active',
16 |         'google/analytics/active',
17 |         'google/gtag/analytics4/active',
18 |         'google/gtag/adwords/active',
19 |         'googletagmanager/general/active',
20 |         'am_ga4/general/enable',
21 |         'weltpixel_ga4/general/enable',
22 |         'mst_gtm/general/enabled',
23 |         'googletagmanager/general/enabled'
24 |         ];
25 | 
26 |     /**
27 |      * @param Config $config
28 |      */
29 |     public function __construct(
30 |         Config $config
31 |     ) {
32 |         $this->config = $config;
33 |     }
34 | 
35 |     /**
36 |      * @param ScopeConfigInterface $subject
37 |      * @param $result
38 |      * @param $path
39 |      * @param string $scopeType
40 |      * @param $scopeCode
41 |      * @return mixed|string
42 |      */
43 |     public function afterGetValue(
44 |         ScopeConfigInterface $subject,
45 |         $result,
46 |         $path,
47 |         $scopeType = ScopeConfigInterface::SCOPE_TYPE_DEFAULT,
48 |         $scopeCode = null
49 |     ) {
50 |         if (in_array($path, self::PATHS)) {
51 |             if ($this->config->isEnabled() && !$this->config->isThirdPartyGaEnabled()) {
52 |                 $result = '0';
53 |             }
54 |         }
55 | 
56 |         return $result;
57 |     }
58 | }
59 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # [Magento 2 Google Tag Manager](https://magefan.com/magento-2-google-tag-manager) by Magefan
  2 | 
  3 | [![Total Downloads](https://poser.pugx.org/magefan/module-google-tag-manager/downloads)](https://packagist.org/packages/magefan/module-google-tag-manager)
  4 | [![Latest Stable Version](https://poser.pugx.org/magefan/module-google-tag-manager/v/stable)](https://packagist.org/packages/magefan/module-google-tag-manager)
  5 | 
  6 | <img align="right" width="120" height="120" src="https://cm.magefan.com/catalog/product/cache/28b407cef1668fd0bdd6f36db3e8e2f0/i/c/icon-google-tag-manager.jpg">
  7 | 
  8 | [Magento 2 Google Tag Manager](https://magefan.com/magento-2-google-tag-manager)  is a solution for better store performance tracking that eliminates any actions required with your website source code. It allows you to specify the GTM and GA4 tracking IDs in the admin panel, then export the preset tracking tags, import them into your GTM account and get better reporting on various actions in your store. 
  9 | 
 10 | Improve store performance tracking with no-effort. 
 11 | 
 12 | <img  align="right" width="120" height="70" src="https://magefan.com/media/wysiwyg/made_in_ukraine.jpg">
 13 | 
 14 | <a href="https://magefan.com/magento-2-google-tag-manager"><img width="190" height="70" src="https://cm.magefan.com/wysiwyg/products/download-magefan-extensions.png"></a>
 15 | 
 16 | ## Useful Links
 17 |   * [User Guide](https://magefan.com/magento-2-google-tag-manager/documentation)
 18 |   * [Change Log](https://magefan.com/magento-2-google-tag-manager/change-log)
 19 |   * [FAQs](https://magefan.com/magento-2-google-tag-manager#pattr-faq)
 20 | 
 21 | ## 🇺🇦 Stand with Ukraine! [How can you help?](https://magefan.com/blog/join-our-donations)
 22 | 
 23 | ## Requirements
 24 |   * Magento Community 2.3.0-2.4.x (CE, EE, ECE, B2B)
 25 |   * [Magefan Community Extension](https://github.com/magefan/module-community) >= v2.1.20. Please install this extension first if you use installation via FTP.
 26 |   * **Note** that the extension is free only for the Magento Community (Open Source) Edition. For Magento EE, ECE, and B2B you need to purchase the license  at magefan.com.
 27 | 
 28 | ## Editions & Pricing
 29 |   
 30 | <a href="https://magefan.com/magento-2-google-tag-manager/pricing">
 31 |           <img
 32 |             src="https://cm.magefan.com/wysiwyg/products/google-tag-manager-pricing-min.png"
 33 |             alt="Editions and Pricing for Magento 2 Google Tag Manager" />
 34 |         </a>
 35 |         
 36 | ## Benefits
 37 | * [Implement tracking tags easier](https://github.com/magefan/module-google-tag-manager#features)
 38 | * [Import/export tracking tags](https://github.com/magefan/module-google-tag-manager#importexport-tracking-tags)
 39 | * [Monitor customer behaviour](https://github.com/magefan/module-google-tag-manager#monitor-customer-behaviour)
 40 | * [Track checkout performance](https://github.com/magefan/module-google-tag-manager#track-checkout-performance)
 41 | * [Track product performance](https://github.com/magefan/module-google-tag-manager#track-product-performance)
 42 | * [Enable dynamic remarketing](https://github.com/magefan/module-google-tag-manager#enable-dynamic-remarketing)
 43 | * [Monitor custom blocks](https://github.com/magefan/module-google-tag-manager#monitor-custom-blocks)
 44 | 
 45 | ## Features
 46 | 
 47 | ### Implement tracking tags easier
 48 | 
 49 | Enabling Google Tag Manager tags in your Magento website usually requires you to get the GTM tracking code and implement it into your website source code. Not only is it hard for non-technical people, but time-consuming for developers. 
 50 | 
 51 | Magefan Google Tag Manager for Magento 2 allows you to insert tracking IDs in the admin panel and the extension will do the rest. No source code editing.
 52 | 
 53 | 
 54 | <p align="center">
 55 |   <img width="853" height="425" src="https://cm.magefan.com/catalog/magento-2-google-tag-manager-extension.png">
 56 | </p>
 57 | 
 58 | 
 59 | ### Import/export tracking tags
 60 | 
 61 | Once the tracking IDs are implemented in your website, you need to create different events and variables in the Google Tag Manager Account. But not with our Magento 2 Google Tag Manager Extension.
 62 | 
 63 | You can generate JSON container with all the essential tags and then import it into your GTM account. Et Voila! You have all your tags created for you.
 64 | 
 65 | ### Monitor customer behaviour
 66 | 
 67 | Tracking customers’ behaviour in your store allows you to see the patterns and bottlenecks that appear in the customer’s journey. Check what products customers view the most, add to their cart, purchase and abandon. 
 68 | 
 69 | Once you have this data, you’ll be able to tweak your marketing strategy and improve the shopping experience in your store.
 70 | 
 71 | <p align="center">
 72 |   <img width="853" height="425" src="https://cm.magefan.com/catalog/magento-2-google-tag-manager-event-tracking.png">
 73 | </p>
 74 | 
 75 | ### Track checkout performance
 76 | 
 77 | Checkout step is one of the most important steps in the customers’ journey and, as it often appears, one where customers get stuck. Although you have implemented the best practices to improve checkout, our GTM Extension for Magento will make it better. 
 78 | 
 79 | Get insights into the checkout performance by tracking vital events - begin_checkout, add_shipping_info, add_billing_info, and purchase.
 80 | 
 81 | ### Track product performance
 82 | 
 83 | What are your biggest traffic and revenue generators? Use this Magento 2 Google Tag Manager extension to track data on what products get the most views, are purchased, added to the cart, wishlist and removed from the cart the most often. 
 84 | 
 85 | Establish a strategy that allows you to increase conversions and promote products that are falling behind in sales. 
 86 | 
 87 | <p align="center">
 88 |   <img width="853" height="425" src="https://cm.magefan.com/catalog/product-performance-report-in-google-analytics.png">
 89 | </p>
 90 | 
 91 | ### Enable dynamic remarketing
 92 | 
 93 | If you want to provide more personalized ads and drive people, who already visited your website, back, use Magento 2 Google Tag Manager extension for dynamic remarketing. Our Extension support dynamic remarketing to help you display products and service customers viewed the last time they visited your website.
 94 | 
 95 | ### Monitor custom blocks
 96 | 
 97 | Have you implemented related, cross-sell and up-sell products but don’t know if they are performing as expected? Track product views in custom blocks with Magento 2 GTM extension and improve your sales strategy accordingly. 
 98 | 
 99 | ## Demo
100 | 
101 | Try out our open demo and if you like our extension **please give us some star on Github ★**
102 | <table>
103 |   <tbody>
104 |     <tr>
105 |       <td align="center" valign="middle">
106 |         Storefront Demo
107 |       </td>
108 |       <td align="center" valign="middle">
109 |         Admin Panel Demo
110 |       </td align="center" valign="middle">
111 |     </tr>
112 |     <tr>
113 |       <td align="center" valign="middle">
114 |         <a href="https://gtm.demo.magefan.top/">
115 |           <img
116 |             src="https://magefan.com/static/version1520969775/frontend/Magefan/new/en_US/images/product-tab-demo-1.jpg"
117 |             alt="Magento 2 Google Tag Manager Storefront Demo"
118 |             height="220"
119 |           >
120 |         </a>
121 |       </td>
122 |       <td align="center" valign="middle">
123 |         <a href="https://gtm.demo.magefan.top/admin/admin/system_config/edit/section/mfgoogletagmanager/">
124 |           <img
125 |             src="https://cs.magefan.com/version1732118579/frontend/Magefan/next/en_US/Magefan_CssOptimizer/images/product-tab-demo-2.jpg"
126 |             alt="Magento 2 Google Tag Manager Admin Panel Demo"
127 |             height="220"
128 |           >
129 |         </a>
130 |       </td>
131 |     </tr>
132 |     <tr>
133 |       <td align="center" valign="middle">
134 |         <a href="https://gtm.demo.magefan.top/">
135 |           view
136 |         </a>
137 |       </td>
138 |       <td align="center" valign="middle">
139 |         <a href="https://gtm.demo.magefan.top/admin/admin/system_config/edit/section/mfgoogletagmanager/">
140 |           view
141 |         </a>
142 |       </td>
143 |     </tr>
144 |   </tbody>
145 | </table>
146 | 
147 | ## Support
148 | If you have any issues, please [contact us](mailto:support@magefan.com)
149 | then if you still need help, open a bug report in GitHub's
150 | [issue tracker](https://github.com/magefan/module-google-tag-manager/issues).
151 | 
152 | ## Need More Features?
153 | Please contact us to get a quote
154 | https://magefan.com/contact
155 | 
156 | ## License
157 | The code is licensed under [EULA](https://magefan.com/end-user-license-agreement).
158 | 
159 | ## [Magento 2 Extensions](https://magefan.com/magento-2-extensions) by Magefan
160 | 
161 | ### [Magento 2 Google Extensions](https://magefan.com/magento-2-extensions/google-extensions)
162 | 
163 |   * [Magento 2 Google Indexing](https://magefan.com/magento-2-google-indexing-api)
164 |   * [Magento 2 Google Analytics 4](https://magefan.com/magento-2-google-analytics-4)
165 |   * [Magento 2 Google Shopping Feed](https://magefan.com/magento-2-google-shopping-feed-extension)
166 |   * [Magento 2 Google Customer Reviews](https://magefan.com/magento-2-google-customer-reviews)
167 | 
168 | ### Magento 2 SEO Extensions
169 | 
170 |   * [Magento 2 SEO Extension](https://magefan.com/magento-2-seo-extension)
171 |   * [Magento 2 Rich Snippets](https://magefan.com/magento-2-rich-snippets)
172 |   * [Magento 2 HTML Sitemap](https://magefan.com/magento-2-html-sitemap-extension)
173 |   * [Magento 2 XML Sitemap](https://magefan.com/magento-2-xml-sitemap-extension)
174 |   * [Magento 2 Facebook Open Graph](https://magefan.com/magento-2-open-graph-extension-og-tags)
175 |   * [Magento 2 Twitter Cards](https://magefan.com/magento-2-twitter-cards-extension)
176 | 
177 | 
178 | ### [Magento 2 Speed Optimization Extensions](https://magefan.com/magento-2-extensions/speed-optimization)
179 | 
180 |   * [Magento 2 Google Page Speed Optimizer](https://magefan.com/magento-2-google-page-speed-optimizer)
181 |   * [Magento 2 Full Page Cache Warmer](https://magefan.com/magento-2-full-page-cache-warmer)
182 |   * [Magento 2 Image Lazy Load](https://magefan.com/magento-2-image-lazy-load-extension)
183 |   * [Magento 2 WebP Images](https://magefan.com/magento-2-webp-optimized-images)
184 |   * [Magento 2 Rocket JavaScript](https://magefan.com/rocket-javascript-deferred-javascript)
185 | 
186 |   ### [Magento 2 Admin Panel Extensions](https://magefan.com/magento-2-extensions/admin-extensions)
187 | 
188 |   
189 |   * [Magento 2 Size Chart Extension](https://magefan.com/magento-2-size-chart)
190 |   * [Magento 2 Security Extension](https://magefan.com/magento-2-security-extension)
191 |   * [Magento 2 Admin Action Log](https://magefan.com/magento-2-admin-action-log)
192 |   * [Magento 2 Order Editor](https://magefan.com/magento-2-edit-order-extension)
193 |   * [Magento 2 Better Order Grid](https://magefan.com/magento-2-better-order-grid-extension)
194 |   * [Magento 2 Extended Product Grid](https://magefan.com/magento-2-product-grid-inline-editor)
195 |   * [Magento 2 Product Tabs](https://magefan.com/magento-2/extensions/product-tabs)
196 |   * [Magento 2 Facebook Pixel](https://magefan.com/magento-2-facebook-pixel-extension)
197 |   * [Magento 2 Email Attachments](https://magefan.com/magento-2-email-attachments)
198 |   * [Magento 2 Admin View](https://magefan.com/magento-2-admin-view-extension)
199 |   * [Magento 2 Admin Email Notifications](https://magefan.com/magento-2-admin-email-notifications)
200 |   * [Magento 2 Login As Customer](https://magefan.com/login-as-customer-magento-2-extension)
201 | 
202 | ### Magento 2 Blog Extensions
203 | 
204 |   * [Magento 2 Blog](https://magefan.com/magento2-blog-extension)
205 |   * [Magento 2 Multi Blog](https://magefan.com/magento-2-multi-blog-extension)
206 |   * [Magento 2 Product Widget](https://magefan.com/magento-2-product-widget)
207 | 
208 | ### [Magento 2 Marketing Automation Extensions](https://magefan.com/magento-2-extensions/marketing-automation)
209 | 
210 |   * [Magento 2 Cookie Consent](https://magefan.com/magento-2-cookie-consent)
211 |   * [Magento 2 Product Labels](https://magefan.com/magento-2-product-labels)
212 |   * [Magento 2 Base Price](https://magefan.com/magento-2-base-price)
213 |   * [Magento 2 Dynamic Categories](https://magefan.com/magento-2-dynamic-categories)
214 |   * [Magento 2 Dynamic Blocks and Pages Extension](https://magefan.com/magento-2-cms-display-rules-extension)
215 |   * [Magento 2 Automatic Related Products](https://magefan.com/magento-2-automatic-related-products)
216 |   * [Magento 2 Price History](https://magefan.com/magento-2-price-history)
217 |   * [Magento 2 Mautic Integration](https://magefan.com/magento-2-mautic-extension)
218 |   * [Magento 2 YouTube Video](https://magefan.com/magento2-youtube-extension)    
219 |  
220 | ### [Magento 2 Cart Extensions](https://magefan.com/magento-2-extensions/cart-extensions)
221 | 
222 |   * [Magento 2 Checkout Extension](https://magefan.com/better-magento-2-checkout-extension)
223 |   * [Magento 2 Coupon Code](https://magefan.com/magento-2-coupon-code-link)
224 |   * [Magento 2 Guest to Customer](https://magefan.com/magento2-convert-guest-to-customer)
225 | 
226 | ### [Magento 2 Multi-Language Extensions](https://magefan.com/magento-2-extensions/multi-language-extensions)
227 | 
228 |   * [Magento 2 Hreflang Tags](https://magefan.com/magento2-alternate-hreflang-extension)
229 |   * [Magento 2 Auto Currency Switcher](https://magefan.com/magento-2-currency-switcher-auto-currency-by-country)
230 |   * [Magento 2 Auto Language Switcher](https://magefan.com/magento-2-auto-language-switcher)
231 |   * [Magento 2 GeoIP Store Switcher](https://magefan.com/magento-2-geoip-switcher-extension)
232 |   * [Magento 2 Translation](https://magefan.com/magento-2-translation-extension)
233 | 
234 | ### [Developers Tools](https://magefan.com/magento-2-extensions/developer-tools)
235 | 
236 |   * [Magento 2 Zero Downtime Deployment](https://magefan.com/blog/magento-2-zero-downtime-deployment)
237 |   * [Magento 2 Cron Schedule](https://magefan.com/magento-2-cron-schedule)
238 |   * [Magento 2 CLI Extension](https://magefan.com/magento2-cli-extension)
239 |   * [Magento 2 Conflict Detector](https://magefan.com/magento2-conflict-detector)
240 |      
241 |   ## [Shopify Apps](https://magefan.com/shopify/apps) by Magefan
242 | 
243 |   * [Shopify Login As Customer](https://apps.shopify.com/login-as-customer)
244 |   * [Shopify Blog](https://apps.shopify.com/magefan-blog)
245 |   * [Shopify Size Chart](https://magefan.com/shopify/apps/size-chart)
246 |   * [Shopify Google Indexer](https://magefan.com/shopify/apps/google-indexing)
247 |   * [Shopify Product Feeds](https://magefan.com/shopify/apps/product-feed)
248 | 


--------------------------------------------------------------------------------
/Setup/Patch/Schema/ChangePath.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | declare(strict_types=1);
 7 | 
 8 | namespace Magefan\GoogleTagManager\Setup\Patch\Schema;
 9 | 
10 | use Magento\Framework\Setup\Patch\SchemaPatchInterface;
11 | use Magento\Framework\Setup\SchemaSetupInterface;
12 | 
13 | class ChangePath implements SchemaPatchInterface
14 | {
15 | 
16 |     /**
17 |      * @var SchemaSetupInterface
18 |      */
19 |     private $schemaSetup;
20 | 
21 |     /**
22 |      * Constructor
23 |      *
24 |      * @param SchemaSetupInterface $schemaSetup
25 |      */
26 |     public function __construct(
27 |         SchemaSetupInterface $schemaSetup
28 |     ) {
29 |         $this->schemaSetup = $schemaSetup;
30 |     }
31 | 
32 |     /**
33 |      * {@inheritdoc}
34 |      */
35 |     public function apply()
36 |     {
37 |         $this->schemaSetup->startSetup();
38 |         $connection = $this->schemaSetup->getConnection();
39 | 
40 |         $table = $this->schemaSetup->getTable('core_config_data');
41 | 
42 |         $changedConfigurationFields = [
43 |             'mfgoogletagmanager/general/public_id' => 'mfgoogletagmanager/web_container/public_id',
44 |             'mfgoogletagmanager/general/account_id' => 'mfgoogletagmanager/web_container/account_id',
45 |             'mfgoogletagmanager/general/container_id' => 'mfgoogletagmanager/web_container/container_id',
46 |         ];
47 | 
48 |         foreach ($changedConfigurationFields as $oldPath => $newPath) {
49 |             $connection->update(
50 |                 $table,
51 |                 ['path' => $newPath],
52 |                 ['path = ?' => $oldPath]
53 |             );
54 |         }
55 | 
56 |         $this->schemaSetup->endSetup();
57 |     }
58 | 
59 |     /**
60 |      * @return array
61 |      */
62 |     public function getAliases()
63 |     {
64 |         return [];
65 |     }
66 | 
67 |     /**
68 |      * @return array
69 |      */
70 |     public static function getDependencies()
71 |     {
72 |         return [];
73 |     }
74 | }
75 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "magefan/module-google-tag-manager",
 3 |     "description": "Magento 2 Google Tag Manager and Google Analytics 4",
 4 |     "type": "magento2-module",
 5 |     "license": "proprietary",
 6 |     "authors": [
 7 |         {
 8 |             "name": "Magefan",
 9 |             "email": "support@magefan.com"
10 |         }
11 |     ],
12 |     "version": "2.6.9",
13 |     "require": {
14 |         "magefan/module-community" : ">=2.2.9"
15 |     },
16 |     "autoload": {
17 |         "files": [
18 |             "registration.php"
19 |         ],
20 |         "psr-4": {
21 |             "Magefan\\GoogleTagManager\\": ""
22 |         }
23 |     }
24 | }
25 | 


--------------------------------------------------------------------------------
/etc/acl.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 5 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 6 |  */
 7 | -->
 8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Acl/etc/acl.xsd">
 9 |     <acl>
10 |         <resources>
11 |             <resource id="Magento_Backend::admin">
12 |                 <resource id="Magento_Backend::stores">
13 |                     <resource id="Magento_Backend::stores_settings">
14 |                         <resource id="Magento_Config::config">
15 |                             <resource id="Magefan_GoogleTagManager::mfgoogletagmanager_config" title="Google Tag Manager Section" translate="title" sortOrder="10" />
16 |                         </resource>
17 |                     </resource>
18 |                 </resource>
19 |             </resource>
20 |         </resources>
21 |     </acl>
22 | </config>
23 | 


--------------------------------------------------------------------------------
/etc/adminhtml/routes.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 5 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 6 |  */
 7 | -->
 8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:App/etc/routes.xsd">
 9 |     <router id="admin">
10 |         <route id="mfgoogletagmanager" frontName="mfgoogletagmanager">
11 |             <module name="Magefan_GoogleTagManager" />
12 |         </route>
13 |     </router>
14 | </config>
15 | 


--------------------------------------------------------------------------------
/etc/adminhtml/system.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" ?>
  2 | <!--
  3 | /**
  4 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
  5 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
  6 |  */
  7 | -->
  8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd">
  9 |     <system>
 10 |         <section id="mfgoogletagmanager" translate="label" sortOrder="10423249260" showInDefault="1" showInWebsite="1" showInStore="1">
 11 |             <class>separator-top</class>
 12 |             <label>Google Tag Manager and Analytics</label>
 13 |             <tab>magefan</tab>
 14 |             <resource>Magefan_GoogleTagManager::mfgoogletagmanager_config</resource>
 15 |             <group id="general" translate="label" type="text" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1">
 16 |                 <label>General</label>
 17 |                 <attribute type="expanded">1</attribute>
 18 |                 <field id="version" translate="label comment" type="text" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1">
 19 |                     <frontend_model>Magefan\GoogleTagManager\Block\Adminhtml\System\Config\Form\Info</frontend_model>
 20 |                 </field>
 21 |                 <field id="infoPlus" translate="label comment" type="text" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1">
 22 |                     <frontend_model>Magefan\GoogleTagManager\Block\Adminhtml\System\Config\Form\InfoPlanPlus</frontend_model>
 23 |                 </field>
 24 |                 <field id="infoExtra" translate="label comment" type="text" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1">
 25 |                     <frontend_model>Magefan\GoogleTagManager\Block\Adminhtml\System\Config\Form\InfoPlanExtra</frontend_model>
 26 |                 </field>
 27 |                 <field id="attention" translate="label comment" type="text" sortOrder="9999" showInDefault="1" showInWebsite="1" showInStore="1">
 28 |                     <frontend_model>Magefan\GoogleTagManager\Block\Adminhtml\System\Config\Form\Attention</frontend_model>
 29 |                 </field>
 30 |                 <field id="enabled" translate="label comment" type="select" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1">
 31 |                     <label>Enable Extension</label>
 32 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
 33 |                 </field>
 34 |                 <field id="key" translate="label" type="text" sortOrder="30" showInDefault="1" showInWebsite="0" showInStore="0">
 35 |                     <label>Product Key</label>
 36 |                     <frontend_model>Magefan\Community\Block\Adminhtml\System\Config\Form\ProductKeyField</frontend_model>
 37 |                 </field>
 38 |             </group>
 39 |             <group id="web_container" translate="label" type="text" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1" >
 40 |                 <label>Web Container</label>
 41 |                 <attribute type="expanded">1</attribute>
 42 |                 <field id="enabled" translate="label comment" type="select" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
 43 |                     <label>Enable Web Container</label>
 44 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
 45 |                 </field>
 46 |                 <field id="install_gtm" translate="label comment" type="select" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
 47 |                     <label>Google Tag Manager Installation Method</label>
 48 |                     <depends>
 49 |                         <field id="enabled">1</field>
 50 |                     </depends>
 51 |                     <source_model>Magefan\GoogleTagManager\Model\Config\Source\InstallGtmOptions</source_model>
 52 |                 </field>
 53 |                 <field id="public_id" translate="label comment" type="text" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1">
 54 |                     <label>Public ID</label>
 55 |                     <comment>
 56 |                         <![CDATA[
 57 |                             <div class="default_loader_mfgtm_js_example">
 58 |                                 E.g. <strong>GTM-XXXXXXX</strong><br/>Public ID is used to insert the code to your pages automatically:
 59 |                                 <div style="border: 1px dashed #5f5f5f;padding: 5px;background: #f4f4f4;margin-bottom: 14px;white-space: pre-line;">&lt;!-- Google Tag Manager --&gt;
 60 |                                     &lt;script&gt;(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({&#39;gtm.start&#39;:
 61 |                                     new Date().getTime(),event:&#39;gtm.js&#39;});var f=d.getElementsByTagName(s)[0],
 62 |                                     j=d.createElement(s),dl=l!=&#39;dataLayer&#39;?&#39;&amp;l=&#39;+l:&#39;&#39;;j.async=true;j.src=
 63 |                                     &#39;https://www.googletagmanager.com/gtm.js?id=&#39;+i+dl;f.parentNode.insertBefore(j,f);
 64 |                                     })(window,document,&#39;script&#39;,&#39;dataLayer&#39;,&#39;<strong>GTM-XXXXXXX</strong>&#39;);&lt;/script&gt;
 65 |                                     &lt;!-- End Google Tag Manager --&gt;
 66 |                                 </div>
 67 |                                 <div style="border: 1px dashed #5f5f5f;padding: 5px;background: #f4f4f4;margin-bottom: 14px;white-space: pre-line;">&lt;!-- Google Tag Manager (noscript) --&gt;
 68 |                                     &lt;noscript&gt;&lt;iframe src=&quot;https://www.googletagmanager.com/ns.html?id=<strong>GTM-XXXXXXX</strong>&quot;
 69 |                                     height=&quot;0&quot; width=&quot;0&quot; style=&quot;display:none;visibility:hidden&quot;&gt;&lt;/iframe&gt;&lt;/noscript&gt;
 70 |                                     &lt;!-- End Google Tag Manager (noscript) --&gt;
 71 |                                 </div>
 72 |                             </div>
 73 |                             <div id="mfgtm_js_example"></div>
 74 |                             If you want to paste the GTM script and noscript manually please use the "Head Script and Body Noscript" option as Google Tag Manager Installation Method.
 75 |                         ]]>
 76 |                     </comment>
 77 |                 </field>
 78 |                 <field id="script_content" translate="label comment" type="textarea" sortOrder="50" showInDefault="1" showInWebsite="1" showInStore="1">
 79 |                     <label>Head Script</label>
 80 |                     <depends>
 81 |                         <field id="enabled">1</field>
 82 |                         <field id="mfgoogletagmanager/web_container/install_gtm">use_head_and_body_script</field>
 83 |                     </depends>
 84 |                     <comment>
 85 |                         <![CDATA[
 86 |                             <p>Please navigate to <a href="https://tagmanager.google.com/" title="Google Tag Manager" target="_blank">Google Tag Manager</a> Workspace > Admin > Install Google Tag Manager and copy the <strong>&lt;head&gt;</strong> script.<br/> E.g.<br/>
 87 |                                 <div style="border: 1px dashed #5f5f5f;padding: 5px;background: #f4f4f4;white-space: pre-line;">&lt;!-- Google Tag Manager --&gt;
 88 |                                     &lt;script&gt;(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({&#39;gtm.start&#39;:
 89 |                                     new Date().getTime(),event:&#39;gtm.js&#39;});var f=d.getElementsByTagName(s)[0],
 90 |                                     j=d.createElement(s),dl=l!=&#39;dataLayer&#39;?&#39;&amp;l=&#39;+l:&#39;&#39;;j.async=true;j.src=
 91 |                                     &#39;https://www.googletagmanager.com/gtm.js?id=&#39;+i+dl;f.parentNode.insertBefore(j,f);
 92 |                                     })(window,document,&#39;script&#39;,&#39;dataLayer&#39;,&#39;<strong>GTM-XXXXXXX</strong>&#39;);&lt;/script&gt;
 93 |                                     &lt;!-- End Google Tag Manager --&gt;
 94 |                                 </div>
 95 |                             </p>
 96 |                             <p>Also you can use scripts from the Stape.io or other alternative services for custom GTM Loaders.</p>
 97 |                         ]]>
 98 |                     </comment>
 99 |                 </field>
100 |                 <field id="noscript_content" translate="label comment" type="textarea" sortOrder="50" showInDefault="1" showInWebsite="1" showInStore="1">
101 |                     <label>Body Noscript</label>
102 |                     <depends>
103 |                         <field id="enabled">1</field>
104 |                         <field id="mfgoogletagmanager/web_container/install_gtm">use_head_and_body_script</field>
105 |                     </depends>
106 |                     <comment>
107 |                         <![CDATA[
108 |                             <p>Please navigate to <a href="https://tagmanager.google.com/" title="Google Tag Manager" target="_blank">Google Tag Manager</a> Workspace > Admin > Install Google Tag Manager and copy the <strong>&lt;body&gt;</strong> noscript.<br/>  E.g.<br/>
109 |                                 <div style="border: 1px dashed #5f5f5f;padding: 5px;background: #f4f4f4;white-space: pre-line;">&lt;!-- Google Tag Manager (noscript) --&gt;
110 |                                     &lt;noscript&gt;&lt;iframe src=&quot;https://www.googletagmanager.com/ns.html?id=<strong>GTM-XXXXXXX</strong>&quot;
111 |                                     height=&quot;0&quot; width=&quot;0&quot; style=&quot;display:none;visibility:hidden&quot;&gt;&lt;/iframe&gt;&lt;/noscript&gt;
112 |                                     &lt;!-- End Google Tag Manager (noscript) --&gt;
113 |                                 </div>
114 |                             </p>
115 |                             <p>Also you can use scripts from the Stape.io or other alternative services for custom GTM Loaders.</p>
116 |                         ]]>
117 |                     </comment>
118 |                 </field>
119 |                 <field id="account_id" translate="label comment" type="text" sortOrder="50" showInDefault="1" showInWebsite="1" showInStore="1">
120 |                     <label>Account ID</label>
121 |                     <depends>
122 |                         <field id="enabled">1</field>
123 |                     </depends>
124 |                     <comment>
125 |                         <![CDATA[
126 |                             <p>Please get the <a href="https://tagmanager.google.com/" title="Google Tag Manager" target="_blank">Google Tag Manager</a> account ID from the GTM Workspace URL path. E.g.<br/>
127 |                             <div style="border: 1px dashed #5f5f5f;padding: 5px;background: #f4f4f4;white-space: pre-line;word-break: break-all;">https://tagmanager.google.com/#/container/accounts/<strong>XXXXXXXXXX</strong>/containers/XXXXXXXXX</div></p>
128 |                         ]]>
129 |                     </comment>
130 |                 </field>
131 |                 <field id="container_id" translate="label comment" type="text" sortOrder="60" showInDefault="1" showInWebsite="1" showInStore="1">
132 |                     <label>Container ID</label>
133 |                     <depends>
134 |                         <field id="enabled">1</field>
135 |                     </depends>
136 |                     <comment>
137 |                         <![CDATA[
138 |                             <p>Please get the <a href="https://tagmanager.google.com/" title="Google Tag Manager" target="_blank">Google Tag Manager</a> container ID from the GTM Workspace URL path. E.g.<br/>
139 |                             <div style="border: 1px dashed #5f5f5f;padding: 5px;background: #f4f4f4;white-space: pre-line;word-break: break-all;">https://tagmanager.google.com/#/container/accounts/XXXXXXXXXX/containers/<strong>XXXXXXXXX</strong></div></p>
140 |                         ]]>
141 |                     </comment>
142 |                 </field>
143 |                 <field id="gtg_enabled" translate="label comment" type="select" sortOrder="70" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
144 |                     <label>Enable Google Tag Gateway</label>
145 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
146 |                     <comment><![CDATA[
147 |                         We recommend Google tag gateway for the most durable tag configuration. Read more about  <a href="https://developers.google.com/tag-platform/tag-manager/gateway/setup-guide?setup=manual" title="Google Tag Gateway" target="_blank">Google tag gateway</a>.
148 |                         ]]>
149 |                     </comment>
150 |                     <depends>
151 |                         <field id="mfgoogletagmanager/web_container/enabled">1</field>
152 |                         <field id="mfgoogletagmanager/web_container/install_gtm">use_public_id</field>
153 |                     </depends>
154 |                 </field>
155 |             </group>
156 |             <group id="server_container" translate="label" type="text" sortOrder="25" showInDefault="1" showInWebsite="1" showInStore="1" >
157 |                 <label>Server Container (GTM Extra)</label>
158 |                 <field id="enabled" translate="label comment" type="select" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
159 |                     <label>Enable Server Container</label>
160 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
161 |                 </field>
162 |                 <field id="public_id" translate="label comment" type="text" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1">
163 |                     <label>Public ID</label>
164 |                     <depends>
165 |                         <field id="enabled">1</field>
166 |                     </depends>
167 |                     <comment><![CDATA[
168 |                         <div class="default_loader_mfgtm_js_example">
169 |                         E.g. <strong>GTM-XXXXXXX</strong><br/>
170 |                     ]]></comment>
171 |                 </field>
172 |                 <field id="account_id" translate="label comment" type="text" sortOrder="50" showInDefault="1" showInWebsite="1" showInStore="1">
173 |                     <label>Account ID</label>
174 |                     <depends>
175 |                         <field id="enabled">1</field>
176 |                     </depends>
177 |                     <comment><![CDATA[
178 |                             <p>Please get the <a href="https://tagmanager.google.com/" title="Google Tag Manager" target="_blank">Google Tag Manager</a> account ID from the GTM Workspace URL path. E.g.<br/>
179 |                             <div style="border: 1px dashed #5f5f5f;padding: 5px;background: #f4f4f4;white-space: pre-line;word-break: break-all;">https://tagmanager.google.com/#/container/accounts/<strong>XXXXXXXXXX</strong>/containers/XXXXXXXXX</div></p>
180 |                         ]]>
181 |                     </comment>
182 |                 </field>
183 |                 <field id="container_id" translate="label comment" type="text" sortOrder="60" showInDefault="1" showInWebsite="1" showInStore="1">
184 |                     <label>Container ID</label>
185 |                     <depends>
186 |                         <field id="enabled">1</field>
187 |                     </depends>
188 |                     <comment><![CDATA[
189 |                             <p>Please get the <a href="https://tagmanager.google.com/" title="Google Tag Manager" target="_blank">Google Tag Manager</a> container ID from the GTM Workspace URL path. E.g.<br/>
190 |                             <div style="border: 1px dashed #5f5f5f;padding: 5px;background: #f4f4f4;white-space: pre-line;word-break: break-all;">https://tagmanager.google.com/#/container/accounts/XXXXXXXXXX/containers/<strong>XXXXXXXXX</strong></div></p>
191 |                         ]]>
192 |                     </comment>
193 |                 </field>
194 |                 <field id="tag_server_url" translate="label comment" type="text" sortOrder="60" showInDefault="1" showInWebsite="1" showInStore="1">
195 |                     <label>Tag Server Url</label>
196 |                     <depends>
197 |                         <field id="enabled">1</field>
198 |                     </depends>
199 |                     <comment><![CDATA[
200 |                             E.g. <strong>https://server.domain</strong><br/>
201 |                         ]]>
202 |                     </comment>
203 |                 </field>
204 | 
205 |                 <field id="headless_storefront" translate="label comment" type="select" sortOrder="70" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
206 |                     <label>Headless Storefront</label>
207 |                     <comment><![CDATA[ Please select "Yes" if you have a PWA storefront.]]>
208 |                     </comment>
209 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
210 |                     <depends>
211 |                         <field id="enabled">1</field>
212 |                     </depends>
213 |                 </field>
214 |                 <field id="track_missing_purchase_events_only" translate="label comment" type="select" sortOrder="80" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
215 |                     <label>Track Missing Purchase Events Only</label>
216 |                     <comment><![CDATA[ Please select "Yes" if you would like to use GTM Server Container to track missing purchase events only.]]>
217 |                     </comment>
218 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
219 |                     <depends>
220 |                         <field id="enabled">1</field>
221 |                         <field id="headless_storefront">0</field>
222 |                     </depends>
223 |                 </field>
224 |                 <group id="preview" translate="label" type="text" sortOrder="90" showInDefault="1" showInWebsite="1" showInStore="1" >
225 |                     <label>Debug View / Preview</label>
226 |                     <field id="enabled" translate="label comment" type="select" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
227 |                         <label>Enable</label>
228 |                         <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
229 |                     </field>
230 |                     <field id="secret" translate="label comment" type="text" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1" >
231 |                         <label>X-Gtm-Server-Preview HTTP Header (optional)</label>
232 |                         <depends>
233 |                             <field id="enabled">1</field>
234 |                         </depends>
235 |                         <comment><![CDATA[
236 |                                 You can get the X-Gtm-Server-Preview value in the <a href="https://tagmanager.google.com/" title="Google Tag Manager" target="_blank">Google Tag Manager</a> container >
237 |                                 Preview > &#10247; > Send requests manually.<br/>
238 |                                 This value is used for debugging and the ability to view events in the preview mode of Google Tag Manager.<br/>
239 |                                 <strong>Important!</strong> This value is changed by Google from time-to-time, before preview, please double check if the value is correct.
240 |                             ]]>
241 |                         </comment>
242 |                     </field>
243 |                     <field id="allow_ips" translate="label comment" type="text" sortOrder="30" showInDefault="1" showInWebsite="1" showInStore="1">
244 |                         <label>Allowed IPs (comma separated)</label>
245 |                         <comment>Leave empty for access from any location.</comment>
246 |                         <backend_model>Magento\Developer\Model\Config\Backend\AllowedIps</backend_model>
247 |                         <depends>
248 |                             <field id="enabled">1</field>
249 |                         </depends>
250 |                     </field>
251 |                 </group>
252 |             </group>
253 |             <group id="analytics" translate="label" type="text" sortOrder="30" showInDefault="1" showInWebsite="1" showInStore="1">
254 |                 <label>Google Analytics 4</label>
255 |                 <field id="enable" translate="label comment" type="select" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
256 |                     <label>Enable</label>
257 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
258 |                 </field>
259 |                 <field id="measurement_id" translate="label comment" type="text" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1">
260 |                     <label>Measurement ID</label>
261 |                     <comment><![CDATA[
262 |                             <p>Please get the measurement ID from the Stream details page (<a href="https://analytics.google.com/analytics/web/" title="Google Analitics" target="_blank" rel="nofollow noopener">Google Analytics</a> > Admin > Data Streams).</p>
263 |                             <p>E.g. G-XXXXXXXXXX
264 |                         ]]>
265 |                     </comment>
266 |                     <depends>
267 |                         <field id="enable">1</field>
268 |                     </depends>
269 |                 </field>
270 |                 <field id="events" translate="label comment" type="text" sortOrder="30" showInDefault="1" showInWebsite="1" showInStore="1">
271 |                     <label>Events</label>
272 |                     <frontend_model>Magefan\GoogleTagManager\Block\Adminhtml\System\Config\Form\EventList</frontend_model>
273 |                 </field>
274 |                 <group id="measurement_protocol" translate="label" type="text" sortOrder="50" showInDefault="1" showInWebsite="1" showInStore="1">
275 |                     <label>Measurement Protocol (GTM Extra)</label>
276 |                     <attribute type="expanded">1</attribute>
277 |                     <field id="info" translate="label comment" type="text" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1">
278 |                         <frontend_model>Magefan\GoogleTagManager\Block\Adminhtml\System\Config\Form\InfoMeasurementProtocol</frontend_model>
279 |                     </field>
280 |                     <field id="measurement_enabled" translate="label comment" type="select" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
281 |                         <label>Enabled</label>
282 |                         <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
283 |                         <comment><![CDATA[
284 |                          The <a href="https://developers.google.com/analytics/devguides/collection/protocol/ga4" target="_blank" rel="nofollow noopener" title="Measurement Protocol (Google Analytics 4)">Google Analytics Measurement Protocol</a> enables server-side GA4 tracking. You can use it to track missing purchase events.
285 |                     ]]>
286 |                         </comment>
287 |                         <depends>
288 |                             <field id="mfgoogletagmanager/server_container/enabled">0</field>
289 |                         </depends>
290 |                     </field>
291 |                     <field id="api_secret" translate="label comment" type='obscure' sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1">
292 |                         <label>API Secret</label>
293 |                         <comment><![CDATA[
294 |                           Required. An API Secret that is generated through the Google Analytics UI.<br/>
295 | 
296 | To create a new secret, navigate in the
297 | <a href="https://analytics.google.com/analytics/web/" title="Google Analitics" target="_blank" rel="nofollow noopener">Google Analytics</a> > Admin > Data Streams > choose your stream > Measurement Protocol > Create.
298 |                     ]]>
299 |                         </comment>
300 |                         <backend_model>Magento\Config\Model\Config\Backend\Encrypted</backend_model>
301 |                         <depends>
302 |                             <field id="measurement_enabled">1</field>
303 |                             <field id="mfgoogletagmanager/server_container/enabled">0</field>
304 |                         </depends>
305 |                     </field>
306 |                 </group>
307 |             </group>
308 |             <group id="ads" translate="label" type="text" sortOrder="40" showInDefault="1" showInWebsite="1" showInStore="1">
309 |                 <label>Google Ads (GTM Plus)</label>
310 |                 <field id="tag_id" translate="label comment" type="text" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1">
311 |                     <label>Tag ID</label>
312 |                     <comment><![CDATA[
313 |                             <p>This option is required if you would like to use Google Ads. <a href="https://support.google.com/tagmanager/answer/12002338#Tag" title="Where to find Tag ID?" target="_blank" rel="nofollow noopener">Where to find Tag ID?</a></p>
314 |                             <p>E.g. AW-XXXXXXXXXXX
315 |                         ]]>
316 |                     </comment>
317 |                 </field>
318 |                 <group id="conversion" translate="label" type="text" sortOrder="40" showInDefault="1" showInWebsite="1" showInStore="1">
319 |                     <label>Conversion Tracking</label>
320 |                     <field id="enable" translate="label comment" type="select" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
321 |                         <label>Enable</label>
322 |                         <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
323 |                     </field>
324 |                     <group id="purchase" translate="label comment" type="text" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1">
325 |                         <attribute type="expanded">1</attribute>
326 |                         <label>Purchase</label>
327 |                         <field id="conversion_id" translate="label comment" type="text" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1">
328 |                             <label>Conversion ID</label>
329 |                             <comment><![CDATA[
330 |                                 <a href="https://support.google.com/tagmanager/answer/6105160" target="_blank" rel="nofollow noopener" title="Where to find Google Ads Conversion ID">Where to find Conversion ID?</a>
331 |                                 ]]>
332 |                             </comment>
333 |                             <depends>
334 |                                 <field id="enable">1</field>
335 |                             </depends>
336 |                         </field>
337 |                         <field id="conversion_label" translate="label comment" type="text" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1">
338 |                             <label>Conversion Label</label>
339 |                             <comment><![CDATA[
340 |                                 <a href="https://support.google.com/tagmanager/answer/6105160" target="_blank" rel="nofollow noopener" title="Where to find Google Ads Conversion Label">Where to find Conversion Label?</a>
341 |                                 ]]>
342 |                             </comment>
343 |                             <depends>
344 |                                 <field id="enable">1</field>
345 |                             </depends>
346 |                         </field>
347 |                         <depends>
348 |                             <field id="enable">1</field>
349 |                         </depends>
350 |                     </group>
351 |                 </group>
352 |                 <group id="remarketing" translate="label" type="text" sortOrder="50" showInDefault="1" showInWebsite="1" showInStore="1">
353 |                     <label>Remarketing</label>
354 |                     <field id="enable" translate="label comment" type="select" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
355 |                         <label>Enable</label>
356 |                         <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
357 |                     </field>
358 |                     <field id="conversion_id" translate="label comment" type="text" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1">
359 |                         <label>Conversion ID</label>
360 |                         <comment><![CDATA[
361 |                                 <a href="https://support.google.com/tagmanager/answer/6106960" target="_blank" rel="nofollow noopener" title="Where to find Google Dynamic Remarketing Conversion ID">Where to find Conversion ID?</a>
362 |                                 ]]>
363 |                         </comment>
364 |                         <depends>
365 |                             <field id="enable">1</field>
366 |                         </depends>
367 |                     </field>
368 |                     <field id="conversion_label" translate="label comment" type="text" sortOrder="30" showInDefault="1" showInWebsite="1" showInStore="1">
369 |                         <label>Conversion Label</label>
370 |                         <comment><![CDATA[
371 |                                 <a href="https://support.google.com/tagmanager/answer/6106960" target="_blank" rel="nofollow noopener" title="Where to find Google Dynamic Remarketing Conversion Label">Where to find Conversion Label?</a>
372 |                                 ]]>
373 |                         </comment>
374 |                         <depends>
375 |                             <field id="enable">1</field>
376 |                         </depends>
377 |                     </field>
378 |                 </group>
379 |             </group>
380 |             <group id="attributes" translate="label" type="text" sortOrder="60" showInDefault="1" showInWebsite="1" showInStore="1">
381 |                 <label>Product Attributes Mapping</label>
382 |                 <field id="product" translate="label comment" type="select" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
383 |                     <label>Product Identifier</label>
384 |                     <source_model>Magefan\GoogleTagManager\Model\Config\Source\ProductAttribute</source_model>
385 |                 </field>
386 |                 <field id="brand" translate="label comment" type="select" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
387 |                     <label>Brand Identifier</label>
388 |                     <source_model>Magefan\GoogleTagManager\Model\Config\Source\BrandAttribute</source_model>
389 |                 </field>
390 |                 <field id="categories" translate="label comment" type="select" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
391 |                     <label>Include Categories</label>
392 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
393 |                     <comment><![CDATA[<strong class="colorRed">Warning!</strong> Enabling this option may cause the performance impact.]]></comment>
394 |                 </field>
395 |             </group>
396 |             <group id="events" translate="label" type="text" sortOrder="62" showInDefault="1" showInWebsite="1" showInStore="1">
397 |                 <label>Events</label>
398 |                 <group id="purchase" translate="label" type="text" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1">
399 |                     <label>Purchase</label>
400 |                     <field id="shipping_enabled" translate="label comment" type="select" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
401 |                         <label>Include Shipping In Purchase Value</label>
402 |                         <comment>If enabled, shipping amount will be included into purchase value (the monetary value of the event).</comment>
403 |                         <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
404 |                     </field>
405 |                     <field id="tax_enabled" translate="label comment" type="select" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
406 |                         <label>Include Tax In Purchase Value</label>
407 |                         <comment>If enabled, TAX price amount will be included into purchase value (the monetary value of the event).</comment>
408 |                         <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
409 |                     </field>
410 |                     <field id="track_admin_orders" translate="label comment" type="select" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
411 |                         <label>Track Admin Orders (GTM Extra)</label>
412 |                         <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
413 |                     </field>
414 |                     <field id="allowed_order_status" translate="label" type="multiselect" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
415 |                         <label>Allowed Order Status (GTM Extra)</label>
416 |                         <source_model>Magefan\GoogleTagManager\Model\Config\Source\OrderStatuses</source_model>
417 |                         <comment><![CDATA[
418 |                             <p>Only orders with this status will be tracked.</p>
419 |                             <p><strong>Note:</strong> This option will be ignored if the GTM Server Container and the Measurement Protocol are disabled.</p>
420 |                         ]]>
421 |                         </comment>
422 |                     </field>
423 |                 </group>
424 |             </group>
425 |             <group id="page_speed_optimization" translate="label" type="text" sortOrder="65" showInDefault="1" showInWebsite="1" showInStore="1">
426 |                 <label>Page Speed Optimization</label>
427 |                 <field id="enabled" translate="label comment" type="select" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
428 |                     <label>Enable Deferred Script Load</label>
429 |                     <comment>If enabled Google Tag Manager JavaScript will be loaded only after users first click, scroll, or mouse touch. You can enable it for better page speed performance.</comment>
430 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
431 |                 </field>
432 |             </group>
433 |             <group id="third_party_ga" translate="label" type="text" sortOrder="65" showInDefault="1" showInWebsite="1" showInStore="1">
434 |                 <label>Third-Party Google Analytics and Google Ads</label>
435 |                 <field id="enabled" translate="label comment" type="select" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
436 |                     <label>Enable</label>
437 |                     <comment>If disabled, Magefan Google Tag Manager Extension prevents the execution of default Magento and custom JavaScripts for Google Analytics, Google Ads, and GTM. Please note that enabling this option can lead to event duplications and double tracking.</comment>
438 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
439 |                 </field>
440 |             </group>
441 |             <group id="customer_data" translate="label" type="text" sortOrder="70" showInDefault="1" showInWebsite="1" showInStore="1">
442 |                 <label>GDPR/CCPA/LGPD (Customer Data Protection Regulation)</label>
443 |                 <field id="protect" translate="label comment" type="select" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
444 |                     <label>Enable Google Consent Mode</label>
445 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
446 |                     <comment>
447 |                         <![CDATA[
448 |                             <p>If set to "Yes" Google Tag Manager Extension will set consent as "denied" by default for measurement capabilities. For example:
449 |     <div style="border: 1px dashed #5f5f5f;padding: 5px;background: #f4f4f4;white-space: pre;">    gtag('consent', 'default', {
450 |         'ad_storage': 'denied',
451 |         'ad_user_data': 'denied',
452 |         'ad_personalization': 'denied',
453 |         'analytics_storage': 'denied'
454 |         ...
455 |         wait_for_update: 2000
456 |     });</div>
457 |                             Lear more about <a href="https://developers.google.com/tag-platform/security/guides/consent?consentmode=advanced" target="_blank" title="Google Consent Mode">Google Consent Mode</a>.<br/>
458 |                             This option is also compatible with Google Consent Mode V2.
459 |                         ]]>
460 |                     </comment>
461 |                 </field>
462 |                 <field id="load_before_consent" translate="label comment" type="select" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
463 |                     <label>Load GTM Script Before Consent</label>
464 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
465 |                     <frontend_model>Magefan\GoogleTagManager\Block\Adminhtml\System\Config\Form\ProtectCustomerData</frontend_model>
466 |                     <depends>
467 |                         <field id="protect">1</field>
468 |                     </depends>
469 |                 </field>
470 |             </group>
471 |             <group id="container" translate="label" type="text" sortOrder="80" showInDefault="1" showInWebsite="1" showInStore="1">
472 |                 <label>Export Web Container</label>
473 |                 <depends>
474 |                     <field id="mfgoogletagmanager/web_container/enabled">1</field>
475 |                 </depends>
476 |                 <field id="export" translate="label comment" type="select" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1">
477 |                     <frontend_model>Magefan\GoogleTagManager\Block\Adminhtml\System\Config\Form\ExportWebContainerButton</frontend_model>
478 |                 </field>
479 |             </group>
480 | 
481 |             <group id="servercontainer" translate="label" type="text" sortOrder="90" showInDefault="1" showInWebsite="1" showInStore="1">
482 |                 <label>Export Server Container</label>
483 |                 <depends>
484 |                     <field id="mfgoogletagmanager/server_container/enabled">1</field>
485 |                 </depends>
486 |                 <field id="export" translate="label comment" type="select" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1">
487 |                     <frontend_model>Magefan\GoogleTagManager\Block\Adminhtml\System\Config\Form\ExportServerContainerButton</frontend_model>
488 |                 </field>
489 |             </group>
490 |         </section>
491 |     </system>
492 | </config>
493 | 


--------------------------------------------------------------------------------
/etc/config.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" ?>
 2 | <!--
 3 | /**
 4 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 5 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 6 |  */
 7 | -->
 8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Store:etc/config.xsd">
 9 |     <default>
10 |         <mfgoogletagmanager>
11 |             <general>
12 |                 <enabled>0</enabled>
13 |                 <mfmodule>GoogleTagManager</mfmodule>
14 |                 <mftype>1</mftype>
15 |             </general>
16 |             <web_container>
17 |                 <enabled>1</enabled>
18 |                 <install_gtm>use_public_id</install_gtm>
19 |                 <gtg_enabled>0</gtg_enabled>
20 |                 <script_content/>
21 |                 <noscript_content/>
22 |                 <enable>1</enable>
23 |                 <account_id/>
24 |                 <container_id/>
25 |                 <public_id/>
26 |             </web_container>
27 |             <server_container>
28 |                 <enabled>0</enabled>
29 |                 <public_id/>
30 |                 <account_id/>
31 |                 <container_id/>
32 |                 <tag_server_url/>
33 |                 <headless_storefront>0</headless_storefront>
34 |                 <track_missing_purchase_events_only>0</track_missing_purchase_events_only>
35 |                 <preview>
36 |                     <enabled>0</enabled>
37 |                     <secret/>
38 |                     <allow_ips/>
39 |                 </preview>
40 |             </server_container>
41 |             <analytics>
42 |                 <enable>1</enable>
43 |                 <measurement_id/>
44 |                 <measurement_protocol>
45 |                     <measurement_enabled/>
46 |                     <api_secret backend_model="Magento\Config\Model\Config\Backend\Encrypted"/>
47 | 
48 |                 </measurement_protocol>
49 |             </analytics>
50 |             <ads>
51 |                 <tag_id/>
52 |                 <conversion>
53 |                     <enable>0</enable>
54 |                     <purchase>
55 |                         <conversion_id/>
56 |                         <conversion_label/>
57 |                     </purchase>
58 |                 </conversion>
59 |                 <remarketing>
60 |                     <enable>0</enable>
61 |                     <conversion_id/>
62 |                     <conversion_label/>
63 |                 </remarketing>
64 |             </ads>
65 |             <attributes>
66 |                 <product>sku</product>
67 |                 <brand/>
68 |                 <categories/>
69 |             </attributes>
70 |             <events>
71 |                 <purchase>
72 |                     <shipping_enabled>1</shipping_enabled>
73 |                     <tax_enabled>1</tax_enabled>
74 |                     <track_admin_orders>1</track_admin_orders>
75 |                     <allowed_order_status>any</allowed_order_status>
76 |                 </purchase>
77 |             </events>
78 |             <page_speed_optimization>
79 |                 <enabled>0</enabled>
80 |             </page_speed_optimization>
81 |             <third_party_ga>
82 |                 <enabled>0</enabled>
83 |             </third_party_ga>
84 |             <customer_data>
85 |                 <protect>0</protect>
86 |                 <load_before_consent>0</load_before_consent>
87 |             </customer_data>
88 |         </mfgoogletagmanager>
89 |     </default>
90 | </config>
91 | 


--------------------------------------------------------------------------------
/etc/csp_whitelist.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 5 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 6 |  */
 7 | -->
 8 | <csp_whitelist xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 9 |         xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Csp:etc/csp_whitelist.xsd">
10 |     <policies>
11 |         <policy id="script-src">
12 |             <values>
13 |                 <value id="mg-google" type="host">*.google.com</value>
14 |                 <value id="mg-google-ua" type="host">*.google.com.ua</value>
15 |                 <value id="mg-google-uk" type="host">*.google.co.uk</value>
16 |                 <value id="mg-google-nl" type="host">*.google.nl</value>
17 |                 <value id="mg-google-be" type="host">*.google.be</value>
18 |                 <value id="mg-google-de" type="host">*.google.de</value>
19 |                 <value id="mg-gstatic" type="host">*.gstatic.com</value>
20 |                 <value id="mg-googletagmanager-com" type="host">*.googletagmanager.com</value>
21 |                 <value id="mg-doubleclick-net" type="host">*.doubleclick.net</value>
22 |             </values>
23 |         </policy>
24 |         <policy id="style-src">
25 |             <values>
26 |                 <value id="mg-googleapis-com" type="host">*.googleapis.com</value>
27 |                 <value id="mg-googletagmanager-com" type="host">*.googletagmanager.com</value>
28 |             </values>
29 |         </policy>
30 |         <policy id="connect-src">
31 |             <values>
32 |                 <value id="mg-googleanalytics" type="host">*.google-analytics.com</value>
33 |                 <value id="mg-google-com" type="host">*.google.com</value>
34 |                 <value id="mg-doubleclick-net" type="host">*.doubleclick.net</value>
35 |                 <value id="mg-googlesyndication-com" type="host">*.googlesyndication.com</value>
36 |             </values>
37 |         </policy>
38 |         <policy id="img-src">
39 |             <values>
40 |                 <value id="mg-google" type="host">*.google.com</value>
41 |                 <value id="mg-google-ua" type="host">*.google.com.ua</value>
42 |                 <value id="mg-google-uk" type="host">*.google.co.uk</value>
43 |                 <value id="mg-google-nl" type="host">*.google.nl</value>
44 |                 <value id="mg-google-be" type="host">*.google.be</value>
45 |                 <value id="mg-google-de" type="host">*.google.de</value>
46 |                 <value id="mg-gstatic-com" type="host">*.gstatic.com</value>
47 |                 <value id="mg-doubleclick-net" type="host">*.doubleclick.net</value>
48 |                 <value id="mg-googletagmanager-com" type="host">*.googletagmanager.com</value>
49 |             </values>
50 |         </policy>
51 |         <policy id="font-src">
52 |             <values>
53 |                 <value id="mg-gstatic-com" type="host">*.gstatic.com</value>
54 |             </values>
55 |         </policy>
56 |         <policy id="frame-src">
57 |             <values>
58 |                 <value id="mg-google" type="host">*.google.com</value>
59 |                 <value id="mg-google-ua" type="host">*.google.com.ua</value>
60 |                 <value id="mg-google-uk" type="host">*.google.co.uk</value>
61 |                 <value id="mg-google-nl" type="host">*.google.nl</value>
62 |                 <value id="mg-google-be" type="host">*.google.be</value>
63 |                 <value id="mg-google-de" type="host">*.google.de</value>
64 |                 <value id="mg-googletagmanager-com" type="host">*.googletagmanager.com</value>
65 |             </values>
66 |         </policy>
67 |     </policies>
68 | </csp_whitelist>
69 | 


--------------------------------------------------------------------------------
/etc/db_schema.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" ?>
 2 | <!--
 3 | /**
 4 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 5 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 6 |  */
 7 | -->
 8 | 
 9 | <schema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
10 |         xsi:noNamespaceSchemaLocation="urn:magento:framework:Setup/Declaration/Schema/etc/schema.xsd">
11 |     <table name="magefan_gtm_transaction">
12 |         <column xsi:type="int"      name="id" identity="true"  unsigned="true" nullable="false" padding="10" comment="ID"/>
13 |         <column xsi:type="varchar"  name="transaction_id"    nullable="false" default=" " comment="Transaction Id"/>
14 |         <column xsi:type="int"      name="store_id"     nullable="false" default="0" comment="Store Id"/>
15 |         <column xsi:type="varchar"  name="requester"    nullable="false" default=" " comment="Requester"/>
16 |         <constraint xsi:type="primary" referenceId="PRIMARY">
17 |             <column name="id"/>
18 |         </constraint>
19 |         <index referenceId="TRANSACTION_ID_LINK_REFERENCE" indexType="btree">
20 |             <column name="transaction_id"/>
21 |         </index>
22 |         <index referenceId="STORE_ID_LINK_REFERENCE" indexType="btree">
23 |             <column name="store_id"/>
24 |         </index>
25 |         <index referenceId="REQUESTER_LINK_REFERENCE" indexType="btree">
26 |             <column name="requester"/>
27 |         </index>
28 |     </table>
29 | </schema>
30 | 


--------------------------------------------------------------------------------
/etc/di.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" ?>
 2 | <!--
 3 | /**
 4 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 5 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 6 |  */
 7 | -->
 8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
 9 |     <preference for="Magefan\GoogleTagManager\Api\DataLayer\BeginCheckoutInterface" type="Magefan\GoogleTagManager\Model\DataLayer\BeginCheckout" />
10 |     <preference for="Magefan\GoogleTagManager\Api\DataLayer\PurchaseInterface" type="Magefan\GoogleTagManager\Model\DataLayer\Purchase" />
11 |     <preference for="Magefan\GoogleTagManager\Api\DataLayer\ViewCartInterface" type="Magefan\GoogleTagManager\Model\DataLayer\ViewCart" />
12 |     <preference for="Magefan\GoogleTagManager\Api\DataLayer\ViewItemInterface" type="Magefan\GoogleTagManager\Model\DataLayer\ViewItem" />
13 |     <preference for="Magefan\GoogleTagManager\Api\DataLayer\Cart\ItemInterface" type="Magefan\GoogleTagManager\Model\DataLayer\Cart\Item" />
14 |     <preference for="Magefan\GoogleTagManager\Api\DataLayer\Order\ItemInterface" type="Magefan\GoogleTagManager\Model\DataLayer\Order\Item" />
15 |     <preference for="Magefan\GoogleTagManager\Api\DataLayer\Product\ItemInterface" type="Magefan\GoogleTagManager\Model\DataLayer\Product\Item" />
16 |     <preference for="Magefan\GoogleTagManager\Api\Transaction\LogInterface" type="Magefan\GoogleTagManager\Model\Transaction\Log" />
17 |     <type name="Magefan\GoogleTagManager\Api\DataLayer\PurchaseInterface">
18 |         <plugin name="Plugin_Magefan_GoogleTagManager_Api_DataLayer_PurchaseInterface" type="Magefan\GoogleTagManager\Plugin\Magefan\GoogleTagManager\Api\DataLayer\PurchaseInterface" sortOrder="10" disabled="false"/>
19 |     </type>
20 |     <type name="Magefan\GoogleTagManager\Controller\Adminhtml\WebContainer\Generate">
21 |         <arguments>
22 |             <argument name="container" xsi:type="object">Magefan\GoogleTagManager\Model\WebContainer</argument>
23 |         </arguments>
24 |     </type>
25 | </config>
26 | 


--------------------------------------------------------------------------------
/etc/frontend/di.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" ?>
 2 | <!--
 3 | /**
 4 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 5 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 6 |  */
 7 | -->
 8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
 9 |     <type name="Magento\Framework\App\Config\ScopeConfigInterface">
10 |         <plugin name="Plugin_Magefan_GoogleTagManager_ScopeConfigInterface" type="Magefan\GoogleTagManager\Plugin\Magento\Framework\App\Config\ScopeConfig" sortOrder="10" disabled="false"/>
11 |     </type>
12 |     <type name="Magento\Customer\CustomerData\Customer">
13 |         <plugin name="Magefan_GoogleTagManager_Plugin_Magento_Customer_CustomerData_Customer" type="Magefan\GoogleTagManager\Plugin\Magento\Customer\CustomerData\Customer" sortOrder="10" disabled="false"/>
14 |     </type>
15 | </config>
16 | 


--------------------------------------------------------------------------------
/etc/frontend/routes.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 5 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 6 |  */
 7 | -->
 8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:App/etc/routes.xsd">
 9 |     <router id="standard">
10 |         <route id="mfgoogletagmanager" frontName="mfgoogletagmanager">
11 |             <module name="Magefan_GoogleTagManager" />
12 |         </route>
13 |     </router>
14 | </config>


--------------------------------------------------------------------------------
/etc/module.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" ?>
 2 | <!--
 3 | /**
 4 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 5 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 6 |  */
 7 | -->
 8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
 9 | 	<module name="Magefan_GoogleTagManager">
10 |         <sequence>
11 |             <module name="Magefan_Community" />
12 |             <module name="Magento_Customer"/>
13 |         </sequence>
14 |     </module>
15 | </config>
16 | 


--------------------------------------------------------------------------------
/registration.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | use Magento\Framework\Component\ComponentRegistrar;
10 | 
11 | ComponentRegistrar::register(ComponentRegistrar::MODULE, 'Magefan_GoogleTagManager', __DIR__);
12 | 


--------------------------------------------------------------------------------
/view/adminhtml/templates/system/config/button/export-container-button.phtml:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | /** @var \Magefan\GoogleTagManager\Block\Adminhtml\System\Config\Form\Button $block */
 7 | /** @var \Magento\Framework\Escaper $escaper */
 8 | /** @var \Magefan\Community\Api\SecureHtmlRendererInterface $mfSecureRenderer */
 9 | // phpcs:ignoreFile
10 | ?>
11 | <?php
12 | if (!isset($escaper)) {
13 |     /* Compatability fix for old Magento versions */
14 |     $escaper = $block;
15 | }
16 | ?>
17 | <div class="pp-buttons-container">
18 |     <button type="button" id="mf_download_<?= $block->escapeHtml($block->getConteinderType()) ?>">
19 |         <?= $escaper->escapeHtml(__('Generate JSON Container & Download File')); ?>
20 |     </button>
21 |     <p>
22 |         <br/>
23 |         <?= __('Once the JSON file is downloaded, upload it to %1 > Choose %2 Container > Admin > Import Container.', '<a href="https://tagmanager.google.com/" title="Google Tag Manager" target="_blank">Google Tag Manager</a>', ucfirst($block->getConteinderType())) ?>
24 |     </p>
25 |     <?php $script = "
26 |         require([
27 |             'jquery',
28 |             'domReady!'
29 |         ], function ($) {
30 |             $('#mf_download_{$block->escapeHtml($block->getConteinderType())}').on('click', function(event) {
31 |                 event.preventDefault;
32 |                 window.location='{$escaper->escapeUrl($block->getContainerGenerateUrl())}';
33 |             });
34 |         });
35 |     "; ?>
36 |     <?= /* @noEscape */ $mfSecureRenderer->renderTag('script', [], $script, false) ?>
37 | </div>
38 | 
39 | 


--------------------------------------------------------------------------------
/view/adminhtml/templates/system/config/event/list.phtml:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | /** @var \Magefan\GoogleTagManager\Block\Adminhtml\System\Config\Form\EventList $block */
 7 | /** @var \Magento\Framework\Escaper $escaper */
 8 | ?>
 9 | <?php
10 | if (!isset($escaper)) {
11 |     /* Compatability fix for old Magento versions */
12 |     $escaper = $block;
13 | }
14 | ?>
15 | <?php
16 | $events = [
17 |     'Page View',
18 |     'Clicks, Scroll, Form Submit, File Download',
19 |     'View Product (view_item)',
20 |     'View Shopping Cart (view_cart)',
21 |     'View Checkout (begin_checkout)',
22 |     'Checkout Success Page (purchase)'
23 | ];
24 | $eventsPlus = [
25 |     'Add To Cart (add_to_cart)',
26 |     'Remove From Cart (remove_from_cart)',
27 |     'Add To Wishlist (add_to_wishlist)',
28 |     'View Product List on category page, related/up-sell/cross-sell products (view_item_list)',
29 |     'Click On Prodcuct on category page, related/up-sell/cross-sell products (select_item)',
30 |     'Shipping Step on Checkout Page (add_shipping_info)',
31 |     'Payments Step on Checkout Page (add_payment_info)',
32 |     'Google Ads - Conversion Tracking',
33 |     'Google Ads - Dynamic Remarketing'
34 | ];
35 | $eventsExtra = [
36 |     'Sign In (login)',
37 |     'Create an Account (sign_up)',
38 |     'Search (search)',
39 |     'Create New Order In Admin Panel (purchase)'
40 |     /*
41 |     'Earn Virtual Currency (earn_virtual_currency)',
42 |     'Spend Virtual Currency (spend_virtual_currency)'
43 |     */
44 | ];
45 | ?>
46 | <br/>
47 | <div>
48 |     <ul>
49 |         <li>
50 |             <?= implode('</li><li>', $events) ?>
51 |         </li>
52 |     </ul>
53 |     <p <?php if (!$block->isPlusEnabled()) { ?>style="color: #ef672f"<?php } ?>>
54 |         <strong>
55 |             <?= $escaper->escapeHtml(__(!$block->isPlusEnabled() ? 'Available in Plus or Extra plans only' : 'GTM Plus')) ?>
56 |             <?php if (!$block->isPlusEnabled()) { ?>
57 |                 (<a style="color: #ef672f; text-decoration: underline;" href="https://magefan.com/magento-2-google-tag-manager/pricing" target="_blank">read more</a>):
58 |             <?php } ?>
59 |         </strong>
60 |     </p>
61 |     <div <?php if (!$block->isPlusEnabled()) { ?>style="opacity: 0.7; color: #ef672f"<?php } ?>>
62 |         <ul>
63 |             <li>
64 |                 <?= implode('</li><li>', $eventsPlus) ?>
65 |             </li>
66 |         </ul>
67 |     </div>
68 |     <p <?php if (!$block->isExtraEnabled()) { ?>style="color: #ef672f"<?php } ?>>
69 |         <strong>
70 |             <?= $escaper->escapeHtml(__(!$block->isExtraEnabled() ? 'Available in Extra plan only' : 'GTM Extra')) ?>
71 |             <?php if (!$block->isExtraEnabled()) { ?>
72 |                 (<a style="color: #ef672f; text-decoration: underline;"  href="https://magefan.com/magento-2-google-tag-manager/pricing" target="_blank">read more</a>):
73 |             <?php } ?>
74 |         </strong>
75 |     </p>
76 |     <div <?php if (!$block->isExtraEnabled()) { ?>style="opacity: 0.7; color: #ef672f"<?php } ?>>
77 |         <ul>
78 |             <li>
79 |                 <?= implode('</li><li>', $eventsExtra) ?>
80 |             </li>
81 |         </ul>
82 |     </div>
83 |     <?php if (!$block->isPlusEnabled() || !$block->isExtraEnabled()) { ?>
84 |     <button title="Upgrade" type="button" class="primary" onclick="window.open('https://magefan.com/magento-2-google-tag-manager/pricing')">
85 |         <span>Upgrade to <?php if (!$block->isPlusEnabled()) { echo 'Plus or'; } ?> Extra plan</span>
86 |     </button>
87 |     <?php } ?>
88 | </div>
89 | 


--------------------------------------------------------------------------------
/view/frontend/layout/catalog_product_view.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 5 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 6 |  */
 7 | -->
 8 | <page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
 9 |     <body>
10 |         <referenceBlock name="head.additional">
11 |             <block class="Magefan\GoogleTagManager\Block\DataLayer\ViewItem" name="mfgtm.data.layer"/>
12 |         </referenceBlock>
13 |     </body>
14 | </page>
15 | 


--------------------------------------------------------------------------------
/view/frontend/layout/checkout_cart_index.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 5 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 6 |  */
 7 | -->
 8 | <page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
 9 |     <body>
10 |         <referenceBlock name="head.additional">
11 |             <block class="Magefan\GoogleTagManager\Block\DataLayer\ViewCart" name="mfgtm.data.layer"/>
12 |         </referenceBlock>
13 |     </body>
14 | </page>
15 | 


--------------------------------------------------------------------------------
/view/frontend/layout/checkout_index_index.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 5 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 6 |  */
 7 | -->
 8 | <page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
 9 |     <body>
10 |         <referenceBlock name="head.additional">
11 |             <block class="Magefan\GoogleTagManager\Block\DataLayer\BeginCheckout" name="mfgtm.data.layer"/>
12 |         </referenceBlock>
13 |     </body>
14 | </page>
15 | 


--------------------------------------------------------------------------------
/view/frontend/layout/checkout_onepage_success.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 5 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 6 |  */
 7 | -->
 8 | <page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
 9 |     <body>
10 |         <referenceBlock name="head.additional">
11 |             <block class="Magefan\GoogleTagManager\Block\DataLayer\Purchase" name="mfgtm.data.layer"/>
12 |         </referenceBlock>
13 |     </body>
14 | </page>
15 | 


--------------------------------------------------------------------------------
/view/frontend/layout/default.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" ?>
 2 | <!--
 3 | /**
 4 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 5 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 6 |  */
 7 | -->
 8 | <page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
 9 |     <body>
10 |         <referenceBlock name="head.additional">
11 |             <block
12 |                 class="Magefan\GoogleTagManager\Block\GtmCode"
13 |                 name="mfgtm.jscode"
14 |                 before="-"
15 |                 template="Magefan_GoogleTagManager::js_code.phtml"
16 |             />
17 |             <block class="Magefan\GoogleTagManager\Block\DataLayer\Other" name="mfgtm.data.layer"/>
18 |         </referenceBlock>
19 |         <referenceContainer name="after.body.start">
20 |             <block
21 |                 class="Magefan\GoogleTagManager\Block\GtmCode"
22 |                 name="mfgtm.nojscode"
23 |                 before="-"
24 |                 template="Magefan_GoogleTagManager::no_js_code.phtml"
25 |             />
26 |         </referenceContainer>
27 |     </body>
28 | </page>
29 | 


--------------------------------------------------------------------------------
/view/frontend/layout/hyva_checkout_index_index.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 5 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 6 |  */
 7 | -->
 8 | <page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
 9 |     <body>
10 |         <referenceBlock name="head.additional">
11 |             <block class="Magefan\GoogleTagManager\Block\DataLayer\BeginCheckout" name="mfgtm.data.layer"/>
12 |         </referenceBlock>
13 |     </body>
14 | </page>
15 | 


--------------------------------------------------------------------------------
/view/frontend/layout/p2c2p_payment_success.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" ?>
 2 | <!--
 3 | /**
 4 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 5 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 6 |  */
 7 | -->
 8 | <page layout="1column" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
 9 |     <body>
10 |         <referenceContainer name="content">
11 |             <block class="Magefan\GoogleTagManager\Block\DataLayer\PurchaseGetOrderFromRequest" name="mfgtm.data.layer"/>
12 |         </referenceContainer>
13 |     </body>
14 | </page>
15 | 


--------------------------------------------------------------------------------
/view/frontend/layout/redsys_checkout_success.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 5 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 6 |  */
 7 | -->
 8 | <page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
 9 |     <body>
10 |         <referenceBlock name="head.additional">
11 |             <block class="Magefan\GoogleTagManager\Block\DataLayer\Purchase" name="mfgtm.data.layer"/>
12 |         </referenceBlock>
13 |     </body>
14 | </page>
15 | 


--------------------------------------------------------------------------------
/view/frontend/templates/js_code.phtml:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
  4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
  5 |  */
  6 | /**
  7 |  * @var $block \Magefan\GoogleTagManager\Block\GtmCode
  8 |  * @var $mfSecureRenderer \Magefan\Community\Api\SecureHtmlRendererInterface
  9 |  * @var $mfHyvaThemeDetection \Magefan\Community\Api\HyvaThemeDetectionInterface
 10 |  */
 11 | ?>
 12 | <?php
 13 | if (!isset($escaper)) {
 14 |     /* Compatability fix for old Magento versions */
 15 |     $escaper = $block;
 16 | }
 17 | 
 18 | $script = '';
 19 | ?>
 20 | <!-- Google Tag Manager -->
 21 | <?php if ($block->isSpeedOptimizationEnabled() && $block->getRequest()->getModuleName() !== 'checkout') { ?>
 22 |     <?php $script .= "
 23 |         document.addEventListener('scroll', mfGtmUserActionDetect);
 24 |         document.addEventListener('mousemove', mfGtmUserActionDetect);
 25 |         document.addEventListener('touchstart', mfGtmUserActionDetect);
 26 |         function mfGtmUserActionDetect()
 27 |         {
 28 |             document.removeEventListener('scroll', mfGtmUserActionDetect);
 29 |             document.removeEventListener('mousemove', mfGtmUserActionDetect);
 30 |             document.removeEventListener('touchstart', mfGtmUserActionDetect);
 31 |             window.mfGtmUserActionDetected = true;
 32 |             mfLoadGtm();
 33 |         }
 34 |     "; ?>
 35 | <?php } else { ?>
 36 |     <?php $script .= "
 37 |         window.mfGtmUserActionDetected = true;
 38 |         "; ?>
 39 | <?php } ?>
 40 | 
 41 | <?php if ($block->isProtectCustomerDataEnabled()) { ?>
 42 |     <?php
 43 |     if (!$block->isMfCookieConsentExtensionEnabled()) {
 44 |         $script .= "
 45 |                 window.dataLayer = window.dataLayer || [];
 46 |                 function gtag() { dataLayer.push(arguments); }
 47 |                 gtag('consent', 'default', {
 48 |                     'ad_user_data': 'denied',
 49 |                     'ad_personalization': 'denied',
 50 |                     'ad_storage': 'denied',
 51 |                     'analytics_storage': 'denied',
 52 |                     /* cookieyes.com start */
 53 |         
 54 |                     'functionality_storage': 'denied',
 55 |                     'personalization_storage': 'denied',
 56 |                     'security_storage': 'granted',
 57 |                     /* cookieyes.com end */
 58 |         
 59 |                     'wait_for_update': 2000
 60 |                 });
 61 |                 /* cookieyes.com start */
 62 |                 gtag('set', 'ads_data_redaction', true);
 63 |                 gtag('set', 'url_passthrough', true);
 64 |                 /* cookieyes.com end */
 65 |             ";
 66 |     }
 67 |     ?>
 68 | 
 69 |     <?php if ($block->isLoadBeforeConsent()) { ?>
 70 |         <?php $script .= "
 71 |             window.mfGtmLoadBeforeCookieAllowed = true;
 72 |             mfLoadGtm();
 73 |             "; ?>
 74 |     <?php } ?>
 75 | 
 76 |     <?php if ($block->isCookieRestrictionModeEnabled()) { ?>
 77 |         <?php $script .= "
 78 |         (function () {
 79 |             function getCookieValue(cookieName) {
 80 |                 let name = cookieName + '=';
 81 |                 let cookieSplit = document.cookie.split(';');
 82 | 
 83 |                 for (let i = 0; i < cookieSplit.length; i++) {
 84 |                     let a = cookieSplit[i];
 85 | 
 86 |                     while (a.charAt(0) === ' ') {
 87 |                         a = a.substring(1);
 88 |                     }
 89 | 
 90 |                     if (a.indexOf(name) === 0) {
 91 |                         return a.substring(name.length, a.length);
 92 |                     }
 93 |                 }
 94 |                 return '';
 95 |             };
 96 | 
 97 |             function customerDataAllowed() {
 98 |                 if (getCookieValue('mf_cookie_consent')) {
 99 |                     return true;
100 |                 };
101 |                 let cookie = getCookieValue(
102 |                     '{$escaper->escapeHtml(\Magento\Cookie\Helper\Cookie::IS_USER_ALLOWED_SAVE_COOKIE)}'
103 |                 );
104 |                 if (cookie) {
105 |                     cookie = JSON.parse(decodeURIComponent(cookie));
106 |                     if (cookie[{$escaper->escapeHtml($block->getWebsiteId())}]) {
107 |                         return true;
108 |                     }
109 |                 };
110 | 
111 |                 if (window.dataLayer) {
112 |                     var consentData;
113 |                     for (var i = 0; i < window.dataLayer.length; i++) {
114 |                         if (dataLayer[i][0] === 'consent') {
115 |                             consentData = dataLayer[i];
116 |                         }
117 |                     };
118 |                     if (consentData && consentData[2]) {
119 |                         var ads = consentData[2];
120 |                         if (ads.ad_user_data === 'granted' &&
121 |                             ads.ad_personalization === 'granted' &&
122 |                             ads.ad_storage === 'granted') {
123 |                                 return true;
124 |                         }
125 |                     };
126 |                 };
127 | 
128 |                 return false;
129 |             };
130 | 
131 |             function grantConsent()
132 |             {
133 |                 window.mfGtmUserCookiesAllowed = true;
134 |             ";
135 | 
136 |         if (!$block->isMfCookieConsentExtensionEnabled()) {
137 |             $script .= "gtag('consent', 'update', {
138 |                     'ad_user_data': 'granted',
139 |                     'ad_personalization': 'granted',
140 |                     'ad_storage': 'granted',
141 |                     'analytics_storage': 'granted',
142 |                     'functionality_storage': 'granted',
143 |                     'personalization_storage': 'granted',
144 |                     'security_storage': 'granted'
145 |                 });";
146 |         }
147 | 
148 |         $script .= "
149 |             };
150 | 
151 |             if (customerDataAllowed()) {
152 |                 grantConsent();
153 |                 mfLoadGtm();
154 |             } else {
155 |                 let interval = setInterval(function () {
156 |                     if (!customerDataAllowed()) return;
157 |                     clearInterval(interval);
158 |                     grantConsent();
159 |                     mfLoadGtm();
160 |                 }, 1000);
161 |             };
162 |         })();
163 |         "; ?>
164 |     <?php } ?>
165 | 
166 | <?php } else { ?>
167 |     <?php $script .= "
168 |         window.mfGtmUserCookiesAllowed = true;
169 |         mfLoadGtm();
170 |         "; ?>
171 | <?php } ?>
172 | <?php $script .= "
173 | 
174 |     function getMfGtmCustomerIdentifier() {
175 |         return localStorage.getItem('mf_gtm_customer_identifier') ? localStorage.getItem('mf_gtm_customer_identifier') : null;
176 |     };
177 | 
178 |     function mfLoadGtm() {
179 |         if (!window.mfGtmUserActionDetected) return false;
180 |         if (!window.mfGtmLoadBeforeCookieAllowed && !window.mfGtmUserCookiesAllowed) return false;
181 | 
182 |         if (window.mfGTMTriedToLoad) return;
183 |         window.mfGTMTriedToLoad = true;
184 |         "; ?>
185 | <?php if ($block->getConfig()->isWebContainerEnabled() && $block->getPublicId()) { ?>
186 |     <?php if ('use_public_id' === $block->getConfig()->getInstallGtm()) { ?>
187 |         <?php $script .= "
188 |             (function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
189 |                     new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
190 |                 j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.setAttributeNode(d.createAttribute('data-ot-ignore'));j.async=true;
191 |                 j.src='" . $block->getGtmJsUrl() . "?id='+i+dl;f.parentNode.insertBefore(j,f);
192 |             })(window,document,'script','dataLayer','{$escaper->escapeHtml($block->getPublicId())}');
193 |         "; ?>
194 |     <?php } elseif ('use_head_and_body_script' === $block->getConfig()->getInstallGtm()) { ?>
195 |         <?php $script .= $block->getGtmScript(); ?>
196 |     <?php } ?>
197 | <?php } ?>
198 | <?php $script .= "
199 |     };
200 |     "; ?>
201 | <?= /* @noEscape */ $mfSecureRenderer->renderTag('script', [], $script, false) ?>
202 | 
203 | <?php if (!$mfHyvaThemeDetection->execute()) { ?>
204 |     <?php $script = "
205 |         if (!window.MagefanRocketJsCustomOptimization && window.require)
206 |         require(['jquery', 'Magento_Customer/js/customer-data'], function ($, customer) {
207 |             function updateMfGtmCustomerIdentifier(data) {
208 |                 if (data.mf_gtm_customer_identifier) {
209 |                     localStorage.setItem('mf_gtm_customer_identifier', data.mf_gtm_customer_identifier);
210 |                 }
211 |             }
212 |             let customerData = customer.get('customer');
213 | 
214 |             customerData.subscribe(function (data) {
215 |                 updateMfGtmCustomerIdentifier(data);
216 |             }.bind(this));
217 |             updateMfGtmCustomerIdentifier(customerData());
218 |         });
219 |     "; ?>
220 |     <?= /* @noEscape */ $mfSecureRenderer->renderTag('script', [], $script, false) ?>
221 | <?php } else { ?>
222 |     <?php $script = "
223 |         /* Hyva code */
224 |         function mfHyvaGtmSetCustomerIdentifier(event) {
225 |             let data, j;
226 |             let sections = event.detail.data;
227 |             for (j in sections) {
228 |                 data = sections[j];
229 |                 if (data.mf_gtm_customer_identifier) {
230 |                     localStorage.setItem('mf_gtm_customer_identifier', 'data.mf_gtm_customer_identifier');
231 |                     return;
232 |                 }
233 |             }
234 |         };
235 |         window.addEventListener('private-content-loaded', mfHyvaGtmSetCustomerIdentifier);
236 |         /* End Hyva code */
237 |     "; ?>
238 |     <?= /* @noEscape */ $mfSecureRenderer->renderTag('script', [], $script, false) ?>
239 | <?php } ?>
240 | <!-- End Google Tag Manager -->
241 | 


--------------------------------------------------------------------------------
/view/frontend/templates/no_js_code.phtml:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magefan (support@magefan.com). All rights reserved.
 4 |  * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
 5 |  */
 6 | /** @var \Magefan\GoogleTagManager\Block\GtmCode $block */
 7 | /** @var \Magento\Framework\Escaper $escaper */
 8 | ?>
 9 | <?php
10 | if (!isset($escaper)) {
11 |     /* Compatability fix for old Magento versions */
12 |     $escaper = $block;
13 | }
14 | ?>
15 | <?php if ($block->getConfig()->isWebContainerEnabled() && $block->getPublicId() && (!$block->isProtectCustomerDataEnabled() || $block->isLoadBeforeConsent())) { ?>
16 |     <!-- Google Tag Manager (noscript) -->
17 |     <?php if ('use_public_id' === $block->getConfig()->getInstallGtm()) { ?>
18 |         <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=<?= $escaper->escapeHtml($block->getPublicId()) ?>"
19 |                           height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
20 |         <!-- End Google Tag Manager (noscript) -->
21 |     <?php } elseif ('use_head_and_body_script' === $block->getConfig()->getInstallGtm()) { ?>
22 |         <?= $block->getGtmNoScript() ?>
23 |     <?php } ?>
24 | <?php } ?>
25 | 


--------------------------------------------------------------------------------