Add event list to config

Author: andriysvyryda

Block/Adminhtml/System/Config/Form/EventList.php

@@ -0,0 +1,91 @@
+<?php
+/**
+ * Copyright © Magefan ([email protected]). All rights reserved.
+ * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
+ */
+
+declare(strict_types=1);
+
+namespace Magefan\GoogleTagManager\Block\Adminhtml\System\Config\Form;
+
+use Magento\Backend\Block\Template\Context;
+use Magento\Config\Block\System\Config\Form\Field;
+use Magento\Framework\Data\Form\Element\AbstractElement;
+use Magento\Framework\Module\Manager;
+use Magento\Framework\View\Helper\SecureHtmlRenderer;
+
+class EventList extends Field
+{
+    public const EVENT_LIST_TEMPLATE = 'system/config/event/list.phtml';
+
+    /**
+     * @var Manager
+     */
+    private $moduleManager;
+
+    /**
+     * EventList constructor.
+     *
+     * @param Context $context
+     * @param Manager $moduleManager
+     * @param array $data
+     * @param SecureHtmlRenderer|null $secureRenderer
+     */
+    public function __construct(
+        Context $context,
+        Manager $moduleManager,
+        array $data = [],
+        ?SecureHtmlRenderer $secureRenderer = null
+    ) {
+        $this->moduleManager = $moduleManager;
+        parent::__construct($context, $data, $secureRenderer);
+    }
+
+    /**
+     * Set template to itself
+     *
+     * @return $this
+     */
+    protected function _prepareLayout(): EventList
+    {
+        parent::_prepareLayout();
+        if (!$this->getTemplate()) {
+            $this->setTemplate(static::EVENT_LIST_TEMPLATE);
+        }
+        return $this;
+    }
+
+    /**
+     * Render event list
+     *
+     * @param  AbstractElement $element
+     * @return string
+     */
+    public function render(AbstractElement $element): string
+    {
+        // Remove scope label
+        $element->unsScope()->unsCanUseWebsiteValue()->unsCanUseDefaultValue();
+        return parent::render($element);
+    }
+
+    /**
+     * Get the event list and scripts contents
+     *
+     * @param AbstractElement $element
+     * @return string
+     */
+    protected function _getElementHtml(AbstractElement $element): string
+    {
+        return $this->_toHtml();
+    }
+
+    /**
+     * Retrieve true if GTM Plus is enabled
+     *
+     * @return bool
+     */
+    public function isPlusEnabled()
+    {
+        return (bool)$this->moduleManager->isEnabled('Magefan_GoogleTagManagerPlus');
+    }
+}

etc/adminhtml/system.xml

@@ -64,6 +64,10 @@
                         <field id="enable">1</field>
                     </depends>
                 </field>
+                <field id="events" translate="label comment" type="text" sortOrder="30" showInDefault="1" showInWebsite="1" showInStore="1">
+                    <label>Events</label>
+                    <frontend_model>Magefan\GoogleTagManager\Block\Adminhtml\System\Config\Form\EventList</frontend_model>
+                </field>
             </group>
             <group id="attributes" translate="label" type="text" sortOrder="60" showInDefault="1" showInWebsite="1" showInStore="1">
                 <label>Product Attributes Mapping</label>

view/adminhtml/templates/system/config/event/list.phtml

@@ -0,0 +1,47 @@
+<?php
+/**
+ * Copyright © Magefan ([email protected]). All rights reserved.
+ * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
+ */
+/** @var \Magefan\GoogleTagManager\Block\Adminhtml\System\Config\Form\EventList $block */
+/** @var \Magento\Framework\Escaper $escaper */
+?>
+<?php
+$events = [
+    'View Product (view_item)',
+    'View Shopping Cart (view_cart)',
+    'View Checkout (begin_checkout)',
+    'Checkout Success Page (purchase)'
+];
+$eventsPlus = [
+    'Add To Cart (add_to_cart)',
+    'Remove From Cart (remove_from_cart)',
+    'Add To Wishlist (add_to_wishlist)',
+    'View Product List on category page, related/upsale/crossale products (view_item_list)',
+    'Shipping Step on Checkout Page (add_shipping_info)',
+    'Payments Step on Checkout Page (add_payment_info)'
+];
+?>
+<br/>
+<div>
+    <ul>
+        <li>
+            <?= $escaper->escapeHtml(implode('</li><li>', $events), ['li']) ?>
+        </li>
+    </ul>
+    <p <?php if (!$block->isPlusEnabled()) { ?>style="color: red"<?php } ?>>
+        <strong>
+            <?= $escaper->escapeHtml(__(!$block->isPlusEnabled() ? 'Available in GTM Plus Only' : 'GTM Plus')) ?>
+            <?php if (!$block->isPlusEnabled()) { ?>
+                (<a href="https://magefan.com/magento-2-google-tag-manager/pricing" target="_blank">Read More</a>):
+            <?php } ?>
+        </strong>
+    </p>
+    <div <?php if (!$block->isPlusEnabled()) { ?>style="opacity: 0.7; color: red"<?php } ?>>
+        <ul>
+            <li>
+                <?= $escaper->escapeHtml(implode('</li><li>', $eventsPlus), ['li']) ?>
+            </li>
+        </ul>
+    </div>
+</div>