Merge pull request #16 from stape-io/feature/hyva-support

Implemented Hyva compatibility

CHANGELOG.md

@@ -1,4 +1,6 @@
 # Changelog
+v1.0.17
+- Hyva theme compatibility added.
 
 v1.0.16
 - acl.xml added.

Model/Data/DataProviderInterface.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Stape\Gtm\Model\Data;
+
+interface DataProviderInterface
+{
+    public function get();
+    public function add($eventName, $data);
+    public function clear();
+}

Model/Data/SessionDataProvider.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace Stape\Gtm\Model\Data;
+
+class SessionDataProvider implements DataProviderInterface
+{
+
+    private $checkoutSession;
+
+    /**
+     * Define class dependencies
+     *
+     * @param \Magento\Checkout\Model\Session $checkoutSession
+     */
+    public function __construct(\Magento\Checkout\Model\Session $checkoutSession)
+    {
+        $this->checkoutSession = $checkoutSession;
+    }
+
+    /**
+     * Retrieve Stape GTM events data
+     *
+     * @return array
+     */
+    public function get()
+    {
+        return $this->checkoutSession->getStapeGtmEvents() ?? [];
+    }
+
+    /**
+     * Add gtm events data
+     *
+     * @param string $eventName
+     * @param array $data
+     * @return void
+     */
+    public function add($eventName, $data)
+    {
+        $gtmEvents = $this->get();
+        $gtmEvents[$eventName] = $data;
+        $this->checkoutSession->setStapeGtmEvents($gtmEvents);
+    }
+
+    /**
+     * Clear gtm events
+     *
+     * @return void
+     */
+    public function clear()
+    {
+        $this->checkoutSession->setStapeGtmEvents([]);
+    }
+}

Observer/AddToCartComplete.php

@@ -0,0 +1,102 @@
+<?php
+
+namespace Stape\Gtm\Observer;
+
+use Magento\Checkout\Model\Session;
+use Magento\Framework\Event\Observer;
+use Magento\Framework\Event\ObserverInterface;
+use Magento\Framework\Pricing\PriceCurrencyInterface;
+use Stape\Gtm\Model\ConfigProvider;
+use Stape\Gtm\Model\Data\DataProviderInterface;
+use Stape\Gtm\Model\Product\CategoryResolver;
+
+class AddToCartComplete implements ObserverInterface
+{
+
+    /**
+     * @var CategoryResolver $categoryResolver
+     */
+    private $categoryResolver;
+
+    /**
+     * @var Session $checkoutSession
+     */
+    private $checkoutSession;
+
+    /**
+     * @var ConfigProvider $configProvider
+     */
+    private $configProvider;
+
+    /**
+     * @var DataProviderInterface $dataProvider
+     */
+    private $dataProvider;
+
+    /**
+     * @var PriceCurrencyInterface $priceCurrency
+     */
+    private $priceCurrency;
+
+    /**
+     * Define class dependencies
+     *
+     * @param CategoryResolver $categoryResolver
+     * @param Session $checkoutSession
+     * @param ConfigProvider $configProvider
+     * @param DataProviderInterface $dataProvider
+     * @param PriceCurrencyInterface $priceCurrency
+     */
+    public function __construct(
+        CategoryResolver $categoryResolver,
+        Session $checkoutSession,
+        ConfigProvider $configProvider,
+        DataProviderInterface $dataProvider,
+        PriceCurrencyInterface $priceCurrency
+    ) {
+        $this->categoryResolver = $categoryResolver;
+        $this->checkoutSession = $checkoutSession;
+        $this->configProvider = $configProvider;
+        $this->dataProvider = $dataProvider;
+        $this->priceCurrency = $priceCurrency;
+    }
+
+    /**
+     * Execute observer logic
+     *
+     * @param Observer $observer
+     * @return void
+     */
+    public function execute(Observer $observer)
+    {
+        if (!$this->configProvider->isActive()) {
+            return;
+        }
+
+        /** @var \Magento\Catalog\Model\Product $product */
+        $product = $observer->getData('product');
+
+        /** @var \Magento\Quote\Model\Quote\Item $quote */
+        $quoteItem = $this->checkoutSession->getQuote()->getItemByProduct($product);
+
+        $qty = (int)$observer->getData('request')->getParam('qty');
+        if ($qty === 0) {
+            $qty = 1;
+        }
+        $category = $this->categoryResolver->resolve($product);
+        $this->dataProvider->add('add_to_cart_stape', [
+            'currency' => $this->checkoutSession->getQuote()->getBaseCurrencyCode(),
+            'items' => [
+                [
+                    'item_name' => $product->getName(),
+                    'item_id' => $product->getId(),
+                    'item_sku' => $product->getSku(),
+                    'item_category' => $category ? $category->getName() : null,
+                    'price' => $this->priceCurrency->round($quoteItem->getBasePriceInclTax()),
+                    'quantity' => $qty,
+                    'variation_id' => $quoteItem->getHasChildren() ? current($quoteItem->getChildren())->getProductId() : null
+                ]
+            ]
+        ]);
+    }
+}

Plugin/CustomerData/CartPlugin.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace Stape\Gtm\Plugin\CustomerData;
+
+use Stape\Gtm\Model\Data\DataProviderInterface;
+
+class CartPlugin
+{
+    /**
+     * @var DataProviderInterface
+     */
+    private $dataProvider;
+
+    /**
+     * @param DataProviderInterface $dataProvider
+     */
+    public function __construct(DataProviderInterface $dataProvider)
+    {
+        $this->dataProvider = $dataProvider;
+    }
+
+    /**
+     * Add stape_gtm_events data to the cart section data
+     *
+     * @param $subject
+     * @param $result
+     * @return mixed
+     */
+    public function afterGetSectionData($subject, $result)
+    {
+        $eventsData = $this->dataProvider->get();
+        $this->dataProvider->clear();
+
+        if (!empty($eventsData)) {
+            $result['stape_gtm_events'] = $eventsData;
+        }
+
+        return $result;
+    }
+}

ViewModel/Cart.php

@@ -9,7 +9,7 @@
 use Magento\Store\Model\StoreManagerInterface;
 use Stape\Gtm\Model\Product\CategoryResolver;
 
-class Cart implements ArgumentInterface
+class Cart implements ArgumentInterface, DatalayerInterface
 {
     /**
      * @var Json $json
@@ -77,7 +77,7 @@ public function prepareItems(\Magento\Quote\Model\Quote $quote)
                 'item_sku' => $item->getSku(),
                 'item_category' => $category ? $category->getName() : null,
                 'price' => $this->priceCurrency->round($item->getBasePrice()),
-                'quantity' => (int) $item->getQtyOrdered(),
+                'quantity' => (int) $item->getQty(),
                 'variation_id' => $item->getHasChildren() ? current($item->getChildren())->getProductId() : null
             ];
         }

ViewModel/Category.php

@@ -10,7 +10,7 @@
 use Magento\Framework\View\Layout;
 use Magento\Store\Model\StoreManagerInterface;
 
-class Category implements ArgumentInterface
+class Category implements ArgumentInterface, DatalayerInterface
 {
     /**
      * @var Json $json
@@ -77,7 +77,6 @@ private function getCategoryName()
      */
     public function prepareItems()
     {
-
         /** @var \Magento\Catalog\Block\Product\ListProduct $productList */
         $productList = $this->layout->createBlock(\Magento\Catalog\Block\Product\ListProduct::class);
         $collection = $productList->getLoadedProductCollection();

ViewModel/Checkout.php

@@ -76,7 +76,7 @@ public function prepareItems(\Magento\Quote\Model\Quote $quote)
                 'item_id' => $item->getProductId(),
                 'item_sku' => $item->getSku(),
                 'item_category' => $category ? $category->getName() : null,
-                'price' => $this->priceCurrency->round($item->getBasePrice()),
+                'price' => $this->priceCurrency->round($item->getBasePriceInclTax()),
                 'quantity' => (int) $item->getQty(),
                 'variation_id' => (int) $item->getHasChildren() ? current($item->getChildren())->getProductId() : null,
             ];

ViewModel/DatalayerInterface.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Stape\Gtm\ViewModel;
+
+interface DatalayerInterface
+{
+    /**
+     * @return string
+     */
+    public function getJson();
+}

ViewModel/Product.php

@@ -10,7 +10,7 @@
 use Magento\Store\Model\StoreManagerInterface;
 use Stape\Gtm\Model\Product\CategoryResolver;
 
-class Product implements ArgumentInterface
+class Product implements ArgumentInterface, DatalayerInterface
 {
     /**
      * @var Json $json

composer.json

@@ -5,7 +5,7 @@
     "license": [
         "GPL-3.0-only"
     ],
-    "version": "1.0.16",
+    "version": "1.0.17",
     "require": {
         "php": ">=7.4.0"
     },

etc/frontend/di.xml

@@ -1,5 +1,6 @@
 <?xml version="1.0"?>
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
+    <preference type="Stape\Gtm\Model\Data\SessionDataProvider" for="Stape\Gtm\Model\Data\DataProviderInterface"/>
     <type name="Magento\Framework\App\Response\Http">
         <plugin name="stape_gtm_server_side_cookie" type="Stape\Gtm\Plugin\HttpPlugin" sortOrder="1"/>
     </type>
@@ -12,4 +13,7 @@
     <type name="Magento\Csp\Observer\Render">
         <plugin name="stape_gtm_csp" type="Stape\Gtm\Plugin\CspObserverPlugin" />
     </type>
+    <type name="Magento\Checkout\CustomerData\Cart">
+        <plugin name="stape_gtm_customer_cart" type="Stape\Gtm\Plugin\CustomerData\CartPlugin" />
+    </type>
 </config>

etc/frontend/events.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0"?>
+
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
+    <event name="checkout_cart_add_product_complete">
+        <observer name="stape_gtm_checkout_cart_add_product_complete" instance="Stape\Gtm\Observer\AddToCartComplete" />
+    </event>
+</config>

etc/module.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0"?>
 
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../../../lib/internal/Magento/Framework/Module/etc/module.xsd">
-    <module name="Stape_Gtm" schema_version="1.0.15" setup_version="1.0.15">
+    <module name="Stape_Gtm" schema_version="1.0.17" setup_version="1.0.17">
         <sequence>
             <module name="Magento_Backend" />
             <module name="Magento_Catalog" />

view/frontend/layout/hyva_default.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0"?>
+
+<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+      xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
+    <body>
+        <referenceBlock name="stape.gtm" template="Stape_Gtm::hyva/html/gtm.phtml" />
+    </body>
+</page>