Option to include product categories to data layer

Author: ihorvansach

Model/AbstractDataLayer.php

@@ -14,6 +14,9 @@
 use Magento\Catalog\Model\Product;
 use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Store\Model\StoreManagerInterface;
+use Magento\Framework\App\RequestInterface;
+use Magento\Framework\Registry;
+use Magento\Framework\App\ObjectManager;
 
 class AbstractDataLayer
 {
@@ -32,6 +35,16 @@ class AbstractDataLayer
      */
     protected $categoryRepository;
 
+    /**
+     * @var RequestInterface
+     */
+    protected $request;
+
+    /**
+     * @var Registry
+     */
+    protected $registry;
+
     /**
      * AbstractDataLayer constructor.
      *
@@ -42,11 +55,19 @@ class AbstractDataLayer
     public function __construct(
         Config $config,
         StoreManagerInterface $storeManager,
-        CategoryRepositoryInterface $categoryRepository
+        CategoryRepositoryInterface $categoryRepository,
+        RequestInterface $request = null,
+        Registry $registry = null
     ) {
         $this->config = $config;
         $this->storeManager = $storeManager;
         $this->categoryRepository = $categoryRepository;
+        $this->request = $request ?: ObjectManager::getInstance()->get(
+            RequestInterface::class
+        );
+        $this->registry = $registry ?: ObjectManager::getInstance()->get(
+            Registry::class
+        );
     }
 
     /**
@@ -58,13 +79,12 @@ public function __construct(
      */
     protected function getCategoryNames(Product $product): array
     {
-        /* Temporary disable displaying category names,
-         * as it is optional and slows down the website speed
-         */
-        return [];
-
         $result = [];
 
+        if (!$this->config->getCategoriesAttribute()) {
+            return $result;
+        }
+
         if ($productCategory = $this->getCategoryByProduct($product)) {
             $categoryIds = $productCategory->getPathIds();
             $number = 1;
@@ -91,8 +111,13 @@ protected function getCategoryNames(Product $product): array
      */
     private function getCategoryByProduct(Product $product): ?CategoryInterface
     {
-        $productCategory = null;
+        if ('catalog_category_product' == $this->request->getFullActionName()) {
+            if ($category = $this->registry->registry('current_category')) {
+                return $category;
+            }
+        }
 
+        $productCategory = null;
         $categoryIds = $product->getCategoryIds();
 
         if ($categoryIds) {

Model/Config.php

@@ -32,6 +32,7 @@ class Config
      */
     public const XML_PATH_ATTRIBUTES_PRODUCT = 'mfgoogletagmanager/attributes/product';
     public const XML_PATH_ATTRIBUTES_BRAND = 'mfgoogletagmanager/attributes/brand';
+    public const XML_PATH_ATTRIBUTES_CATEGORIES = 'mfgoogletagmanager/attributes/categories';
 
     /**
      * @var ScopeConfigInterface
@@ -138,6 +139,17 @@ public function getBrandAttribute(string $storeId = null): string
         return (string)$this->getConfig(self::XML_PATH_ATTRIBUTES_BRAND, $storeId);
     }
 
+    /**
+     * Retrieve Magento product categories
+     *
+     * @param string|null $storeId
+     * @return string
+     */
+    public function getCategoriesAttribute(string $storeId = null): string
+    {
+        return (string)$this->getConfig(self::XML_PATH_ATTRIBUTES_CATEGORIES, $storeId);
+    }
+
     /**
      * Retrieve store config value
      *

etc/adminhtml/system.xml

@@ -97,6 +97,11 @@ height="0" width="0" style="display:none;visibility:hid
                     <label>Brand Identifier</label>
                     <source_model>Magefan\GoogleTagManager\Model\Config\Source\BrandAttribute</source_model>
                 </field>
+                <field id="categories" translate="label comment" type="select" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
+                    <label>Include Categories</label>
+                    <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
+                    <comment><![CDATA[<strong class="colorRed">Warning!</strong> Enabling this option may cause the performance impact.]]></comment>
+                </field>
             </group>
             <group id="container" translate="label" type="text" sortOrder="70" showInDefault="1" showInWebsite="1" showInStore="1">
                 <label>Export Container</label>

etc/config.xml

@@ -23,6 +23,7 @@
             <attributes>
                 <product>sku</product>
                 <brand/>
+                <categories/>
             </attributes>
         </mfgoogletagmanager>
     </default>