MageWire support

yireo · Dec 7, 2023 · 267eaf6 · 267eaf6
1 parent d87b343
commit 267eaf6
Show file tree

Hide file tree

Showing 6 changed files with 104 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.7.0] - 7 December 2023
+### Added
+- Hyva Checkout support (@hans-vereyken)
+
 ## [3.6.5] - 28 November 2023
 ### Fixed
 - Make sure to use `gtm-checkout` in the checkout, not customerData `cart`

diff --git a/MageWire/Checkout.php b/MageWire/Checkout.php
@@ -0,0 +1,42 @@
+<?php
+declare(strict_types=1);
+
+namespace Yireo\GoogleTagManager2\MageWire;
+
+use Magento\Checkout\Model\Session as CheckoutSession;
+use Yireo\GoogleTagManager2\DataLayer\Event\AddPaymentInfo;
+use Yireo\GoogleTagManager2\DataLayer\Event\AddShippingInfo;
+use Yireo\GoogleTagManager2\DataLayer\Event\BeginCheckout;
+
+class Checkout extends Component
+{
+    protected $listeners = [
+        'shipping_method_selected' => 'triggerShippingMethod',
+        'payment_method_selected' => 'triggerPaymentMethod',
+    ];
+
+    public function __construct(
+        private readonly CheckoutSession $checkoutSession,
+        private readonly BeginCheckout $beginCheckout,
+        private readonly AddShippingInfo $addShippingInfo,
+        private readonly AddPaymentInfo $addPaymentInfo,
+    ) {
+    }
+
+    public function triggerBeginCheckout()
+    {
+        $this->dispatchBrowserEvent('ga:trigger-event', $this->beginCheckout->get());
+    }
+
+    public function triggerShippingMethod()
+    {
+        $this->dispatchBrowserEvent('ga:trigger-event', $this->addShippingInfo->get());
+    }
+
+    public function triggerPaymentMethod()
+    {
+        $this->addPaymentInfo->setCartId((int) $this->checkoutSession->getQuote()->getId());
+        $this->addPaymentInfo->setPaymentMethod((string) $this->checkoutSession->getQuote()->getPayment()->getMethod());
+        $this->dispatchBrowserEvent('ga:trigger-event', $this->addPaymentInfo->get());
+    }
+}
diff --git a/MageWire/Component.php b/MageWire/Component.php
@@ -0,0 +1,9 @@
+<?php declare(strict_types=1);
+
+namespace Yireo\GoogleTagManager2\MageWire;
+
+if (class_exists('\Magewirephp\Magewire\Component')) {
+    class Component extends \Magewirephp\Magewire\Component {}
+} else {
+    class Component {}
+}
diff --git a/composer.json b/composer.json
@@ -1,6 +1,6 @@
 {
   "name": "yireo/magento2-googletagmanager2",
-  "version": "3.6.5",
+  "version": "3.7.0",
   "license": "OSL-3.0",
   "type": "magento2-module",
   "homepage": "https://www.yireo.com/software/magento-extensions/googletagmanager2",

diff --git a/view/frontend/layout/hyva_checkout_index_index.xml b/view/frontend/layout/hyva_checkout_index_index.xml
@@ -0,0 +1,16 @@
+<?xml version="1.0"?>
+<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+      layout="checkout"
+      xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
+    <body>
+        <referenceContainer name="main">
+            <block template="Yireo_GoogleTagManager2::hyva_checkout/data-layer.phtml"
+                   ifconfig="googletagmanager2/settings/enabled">
+                <arguments>
+                    <argument name="magewire" xsi:type="object">Yireo\GoogleTagManager2\MageWire\Checkout</argument>
+                    <argument name="begin_checkout_event" xsi:type="object">Yireo\GoogleTagManager2\DataLayer\Event\BeginCheckout</argument>
+                </arguments>
+            </block>
+        </referenceContainer>
+    </body>
+</page>
diff --git a/view/frontend/templates/hyva_checkout/data-layer.phtml b/view/frontend/templates/hyva_checkout/data-layer.phtml
@@ -0,0 +1,32 @@
+<?php
+declare(strict_types=1);
+
+use Magento\Framework\View\Element\Template;
+use Yireo\GoogleTagManager2\DataLayer\Event\BeginCheckout;
+
+/** @var Template $block */
+/** @var BeginCheckout $beginCheckoutEvent */
+
+$beginCheckoutEvent = $block->getData('begin_checkout_event');
+?>
+<script>
+    function triggerEvent(event) {
+        yireoGoogleTagManager2Pusher(event.detail);
+    }
+
+    function initYireoGoogleTagManager() {
+        "use strict";
+
+        triggerEvent(new CustomEvent('ga:trigger-event', {detail:<?= json_encode($beginCheckoutEvent->get()) ?>}));
+
+        return {
+            triggerEvent
+        }
+    }
+</script>
+<div id="ga-trigger"
+     x-data="initYireoGoogleTagManager()"
+     class="hidden"
+     @ga:trigger-event.window="triggerEvent($event)"
+></div>
+