Initital commit

Author: ihorvansach

Api/DataLayer/BeginCheckoutInterface.php

@@ -0,0 +1,24 @@
+<?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\Api\DataLayer;
+
+use Magento\Framework\Exception\NoSuchEntityException;
+use Magento\Quote\Model\Quote;
+
+interface BeginCheckoutInterface
+{
+    /**
+     * Get GTM datalayer
+     *
+     * @param Quote $quote
+     * @return array
+     * @throws NoSuchEntityException
+     */
+    public function get(Quote $quote): array;
+}

Api/DataLayer/Cart/ItemInterface.php

@@ -0,0 +1,24 @@
+<?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\Api\DataLayer\Cart;
+
+use Magento\Framework\Exception\NoSuchEntityException;
+use Magento\Quote\Model\Quote\Item;
+
+interface ItemInterface
+{
+    /**
+     * Get quote Item
+     *
+     * @param Item $quoteItem
+     * @return array
+     * @throws NoSuchEntityException
+     */
+    public function get(Item $quoteItem): array;
+}

Api/DataLayer/Order/ItemInterface.php

@@ -0,0 +1,24 @@
+<?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\Api\DataLayer\Order;
+
+use Magento\Framework\Exception\NoSuchEntityException;
+use Magento\Sales\Api\Data\OrderItemInterface;
+
+interface ItemInterface
+{
+    /**
+     * Get order item
+     *
+     * @param OrderItemInterface $orderItem
+     * @return array
+     * @throws NoSuchEntityException
+     */
+    public function get(OrderItemInterface $orderItem): array;
+}

Api/DataLayer/Product/ItemInterface.php

@@ -0,0 +1,24 @@
+<?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\Api\DataLayer\Product;
+
+use Magento\Framework\Exception\NoSuchEntityException;
+use Magento\Catalog\Model\Product;
+
+interface ItemInterface
+{
+    /**
+     * Get product item
+     *
+     * @param Product $product
+     * @return array
+     * @throws NoSuchEntityException
+     */
+    public function get(Product $product): array;
+}

Api/DataLayer/PurchaseInterface.php

@@ -0,0 +1,24 @@
+<?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\Api\DataLayer;
+
+use Magento\Framework\Exception\NoSuchEntityException;
+use Magento\Sales\Model\Order;
+
+interface PurchaseInterface
+{
+    /**
+     * Get GTM datalayer
+     *
+     * @param Order $order
+     * @return array
+     * @throws NoSuchEntityException
+     */
+    public function get(Order $order): array;
+}

Api/DataLayer/ViewCartInterface.php

@@ -0,0 +1,24 @@
+<?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\Api\DataLayer;
+
+use Magento\Framework\Exception\NoSuchEntityException;
+use Magento\Quote\Model\Quote;
+
+interface ViewCartInterface
+{
+    /**
+     * Get GTM datalayer
+     *
+     * @param Quote $quote
+     * @return array
+     * @throws NoSuchEntityException
+     */
+    public function get(Quote $quote): array;
+}

Api/DataLayer/ViewItemInterface.php

@@ -0,0 +1,24 @@
+<?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\Api\DataLayer;
+
+use Magento\Framework\Exception\NoSuchEntityException;
+use Magento\Catalog\Model\Product;
+
+interface ViewItemInterface
+{
+    /**
+     * Get GTM datalayer
+     *
+     * @param Product $product
+     * @return array
+     * @throws NoSuchEntityException
+     */
+    public function get(Product $product): array;
+}

Block/AbstractDataLayer.php

@@ -0,0 +1,65 @@
+<?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;
+
+use Magento\Framework\View\Element\AbstractBlock;
+use Magento\Framework\View\Element\Context;
+use Magefan\GoogleTagManager\Model\Config;
+
+abstract class AbstractDataLayer extends AbstractBlock
+{
+    /**
+     * @var Config
+     */
+    protected $config;
+
+    /**
+     * AbstractDataLayer constructor.
+     *
+     * @param Context $context
+     * @param Config $config
+     * @param array $data
+     */
+    public function __construct(
+        Context $context,
+        Config $config,
+        array $data = []
+    ) {
+        $this->config = $config;
+        parent::__construct($context, $data);
+    }
+
+    /**
+     * Get GTM datalayer
+     *
+     * @return array
+     */
+    abstract protected function getDataLayer(): array;
+
+    /**
+     * Init GTM datalayer
+     *
+     * @return string
+     */
+    protected function _toHtml(): string
+    {
+        if ($this->config->isEnabled()) {
+            $dataLayer = $this->getDataLayer();
+            if ($dataLayer) {
+                return '<script>
+                    require(["mfPushDataLayer"], function(mfPushDataLayer) {
+                        mfPushDataLayer(' . json_encode($dataLayer) . ');
+                    })
+                </script>';
+            }
+        }
+
+        return '';
+    }
+}

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

@@ -0,0 +1,55 @@
+<?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\Config\Block\System\Config\Form\Field;
+use Magento\Framework\Data\Form\Element\AbstractElement;
+
+class Button extends Field
+{
+    public const BUTTON_TEMPLATE = 'system/config/button/button.phtml';
+
+    /**
+     * Set template to itself
+     *
+     * @return $this
+     */
+    protected function _prepareLayout(): Button
+    {
+        parent::_prepareLayout();
+        if (!$this->getTemplate()) {
+            $this->setTemplate(static::BUTTON_TEMPLATE);
+        }
+        return $this;
+    }
+
+    /**
+     * Render button
+     *
+     * @param  AbstractElement $element
+     * @return string
+     */
+    public function render(AbstractElement $element): string
+    {
+        // Remove scope label
+        $element->unsScope()->unsCanUseWebsiteValue()->unsCanUseDefaultValue();
+        return parent::render($element);
+    }
+
+    /**
+     * Get the button and scripts contents
+     *
+     * @param AbstractElement $element
+     * @return string
+     */
+    protected function _getElementHtml(AbstractElement $element): string
+    {
+        return $this->_toHtml();
+    }
+}

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

@@ -0,0 +1,33 @@
+<?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;
+
+class Info extends \Magefan\Community\Block\Adminhtml\System\Config\Form\Info
+{
+    /**
+     * Return extension url
+     *
+     * @return string
+     */
+    protected function getModuleUrl(): string
+    {
+        return 'https://mage' .
+            'fan.com/magento2-extensions?utm_source=gtm_config&utm_medium=link&utm_campaign=regular';
+    }
+
+    /**
+     * Return extension title
+     *
+     * @return string
+     */
+    protected function getModuleTitle(): string
+    {
+        return 'Google Tag Manager Extension';
+    }
+}