AC-2574: Moved Block to view model, created config Model to remove Helper

Author: mahesh-singh-rajawat

app/code/Magento/GoogleGtag/Block/Code.php

@@ -8,11 +8,12 @@
 namespace Magento\GoogleGtag\Block;
 
 use Magento\Cookie\Helper\Cookie;
+use Magento\Framework\Api\SearchCriteriaBuilder;
+use Magento\Framework\Serialize\SerializerInterface;
 use Magento\Framework\View\Element\Template;
 use Magento\Framework\View\Element\Template\Context;
-use Magento\GoogleGtag\Helper\GtagConfiguration;
-use Magento\Sales\Model\ResourceModel\Order\CollectionFactory;
-use Magento\Store\Model\ScopeInterface;
+use Magento\GoogleGtag\Model\Config\GtagConfig as GtagConfiguration;
+use Magento\Sales\Api\OrderRepositoryInterface;
 
 /**
  * GoogleAnalytics Page Block
@@ -27,56 +28,51 @@ class Ga extends Template
     private $googleGtagConfig;
 
     /**
-     * @var CollectionFactory
+     * @var Cookie
      */
-    private $salesOrderCollection;
+    private $cookieHelper;
 
     /**
-     * @var Cookie
+     * @var SerializerInterface
      */
-    private $cookieHelper;
+    private $serializer;
+
+    /**
+     * @var OrderRepositoryInterface
+     */
+    private $orderRepository;
+
+    /**
+     * @var SearchCriteriaBuilder
+     */
+    private $searchCriteriaBuilder;
 
     /**
      * @param Context $context
-     * @param CollectionFactory $salesOrderCollection
      * @param GtagConfiguration $googleGtagConfig
-     * @param array $data
      * @param Cookie $cookieHelper
+     * @param SerializerInterface $serializer
+     * @param SearchCriteriaBuilder $searchCriteriaBuilder
+     * @param OrderRepositoryInterface $orderRepository
+     * @param array $data
      */
     public function __construct(
         Context $context,
-        CollectionFactory $salesOrderCollection,
         GtagConfiguration $googleGtagConfig,
         Cookie $cookieHelper,
+        SerializerInterface $serializer,
+        SearchCriteriaBuilder $searchCriteriaBuilder,
+        OrderRepositoryInterface $orderRepository,
         array $data = []
     ) {
         $this->googleGtagConfig = $googleGtagConfig;
-        $this->salesOrderCollection = $salesOrderCollection;
         $this->cookieHelper = $cookieHelper;
+        $this->serializer = $serializer;
+        $this->orderRepository = $orderRepository;
+        $this->searchCriteriaBuilder = $searchCriteriaBuilder;
         parent::__construct($context, $data);
     }
 
-    /**
-     * Get config
-     *
-     * @param string $path
-     * @return mixed
-     */
-    public function getConfig($path): string
-    {
-        return $this->_scopeConfig->getValue($path, ScopeInterface::SCOPE_STORE);
-    }
-
-    /**
-     * Get helper
-     *
-     * @return GtagConfiguration
-     */
-    public function getHelper(): GtagConfiguration
-    {
-        return $this->googleGtagConfig;
-    }
-
     /**
      * Get a specific page name (may be customized via layout)
      *
@@ -147,7 +143,6 @@ public function getPageTrackingData($measurementId): array
      * @link https://developers.google.com/gtagjs/reference/event#purchase
      *
      * @return array
-     * @since 100.2.0
      */
     public function getOrdersTrackingData(): array
     {
@@ -156,25 +151,28 @@ public function getOrdersTrackingData(): array
         if (empty($orderIds) || !is_array($orderIds)) {
             return $result;
         }
-
-        $collection = $this->salesOrderCollection->create();
-        $collection->addFieldToFilter('entity_id', ['in' => $orderIds]);
-
-        foreach ($collection as $order) {
+        $this->searchCriteriaBuilder->addFilter(
+            'entity_id',
+            $orderIds,
+            'in'
+        );
+        $collection = $this->orderRepository->getList($this->searchCriteriaBuilder->create());
+
+        foreach ($collection->getItems() as $order) {
             foreach ($order->getAllVisibleItems() as $item) {
                 $result['products'][] = [
                     'item_id' => $this->escapeJsQuote($item->getSku()),
                     'item_name' =>  $this->escapeJsQuote($item->getName()),
-                    'price' => $this->googleGtagConfig->formatToDec((float) $item->getPrice()),
+                    'price' => number_format((float) $item->getPrice(), 2),
                     'quantity' => (int)$item->getQtyOrdered(),
                 ];
             }
             $result['orders'][] = [
                 'transaction_id' =>  $order->getIncrementId(),
                 'affiliation' => $this->escapeJsQuote($this->_storeManager->getStore()->getFrontendName()),
-                'value' => $this->googleGtagConfig->formatToDec((float) $order->getGrandTotal()),
-                'tax' => $this->googleGtagConfig->formatToDec((float) $order->getTaxAmount()),
-                'shipping' => $this->googleGtagConfig->formatToDec((float) $order->getShippingAmount()),
+                'value' => number_format((float) $order->getGrandTotal(), 2),
+                'tax' => number_format((float) $order->getTaxAmount(), 2),
+                'shipping' => number_format((float) $order->getShippingAmount(), 2),
             ];
             $result['currency'] = $order->getOrderCurrencyCode();
         }
@@ -195,4 +193,21 @@ private function getOptPageUrl(): string
         }
         return $optPageURL;
     }
+
+    /**
+     * Provide analytics events data
+     *
+     * @return bool|string
+     */
+    public function getAnalyticsData()
+    {
+        $analyticData = [
+            'isCookieRestrictionModeEnabled' => $this->isCookieRestrictionModeEnabled(),
+            'currentWebsite' => $this->getCurrentWebsiteId(),
+            'cookieName' => Cookie::IS_USER_ALLOWED_SAVE_COOKIE,
+            'pageTrackingData' => $this->getPageTrackingData($this->googleGtagConfig->getMeasurementId()),
+            'ordersTrackingData' => $this->getOrdersTrackingData()
+        ];
+        return $this->serializer->serialize($analyticData);
+    }
 }

app/code/Magento/GoogleGtag/Block/Ga.php

@@ -5,46 +5,47 @@
  */
 declare(strict_types=1);
 
-namespace Magento\GoogleGtag\Helper;
+namespace Magento\GoogleGtag\Model\Config;
 
-use Magento\Framework\App\Helper\AbstractHelper;
+use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Store\Model\ScopeInterface;
 use Magento\Store\Model\Store;
 
-/**
- * GoogleAnalytics data helper
- *
- * @api
- */
-class GtagConfiguration extends AbstractHelper
+class GtagConfig
 {
     /**
      * Config paths for using throughout the code
      */
-    public const XML_PATH_ACTIVE = 'google/gtag/analytics4/active';
+    private const XML_PATH_ACTIVE = 'google/gtag/analytics4/active';
 
-    public const XML_PATH_MEASUREMENT_ID = 'google/gtag/analytics4/measurement_id';
+    private const XML_PATH_MEASUREMENT_ID = 'google/gtag/analytics4/measurement_id';
 
     /**
-     * Anonymize IP Default Yes
-     */
-    public const DEFAULT_YES = 1;
-
-    /**#@-*/
-
-    /**#@+
      * Google AdWords conversion src
      */
-    public const GTAG_GLOBAL_SITE_TAG_SRC = 'https://www.googletagmanager.com/gtag/js?id=';
+    private const GTAG_GLOBAL_SITE_TAG_SRC = 'https://www.googletagmanager.com/gtag/js?id=';
 
     /**#@+
      * Google AdWords config data
      */
-    public const XML_PATH_ADWORD_ACTIVE = 'google/gtag/adwords/active';
+    private const XML_PATH_ADWORD_ACTIVE = 'google/gtag/adwords/active';
+
+    private const XML_PATH_CONVERSION_ID = 'google/gtag/adwords/conversion_id';
+
+    private const XML_PATH_CONVERSION_LABEL = 'google/gtag/adwords/conversion_label';
 
-    public const XML_PATH_CONVERSION_ID = 'google/gtag/adwords/conversion_id';
+    /**
+     * @var ScopeConfigInterface
+     */
+    private $scopeConfig;
 
-    public const XML_PATH_CONVERSION_LABEL = 'google/gtag/adwords/conversion_label';
+    /**
+     * @param ScopeConfigInterface $scopeConfig
+     */
+    public function __construct(ScopeConfigInterface $scopeConfig)
+    {
+        $this->scopeConfig = $scopeConfig;
+    }
 
     /**
      * Whether GA is ready to use
@@ -62,7 +63,7 @@ public function isGoogleAnalyticsAvailable($store = null): bool
     }
 
     /**
-     * Get Account Id, depending on property type Tracking Id (UA) or Measurement Id (GA4)
+     * Get Measurement Id (GA4)
      *
      * @return string
      */
@@ -139,15 +140,4 @@ public function getConversionLabel(): string
             ScopeInterface::SCOPE_STORE
         );
     }
-
-    /**
-     * Format Data
-     *
-     * @param float $numberString
-     * @return Float
-     */
-    public function formatToDec($numberString)
-    {
-        return number_format($numberString, 2);
-    }
 }