Merge pull request #46 from stape-io/release/v1.0.26

Release/v1.0.26

Author: chaikovskyia

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 v1.0.26
 - removed unneeded CSP rules
+- added option to configure collection size for datalayer
 
 v1.0.24
 - added caching of cookie domain when generating _sbp cookie

Model/ConfigProvider.php

@@ -53,6 +53,11 @@ class ConfigProvider
      */
     public const XPATH_USER_DATA_ENABLED = 'stape_gtm/datalayer/userdata';
 
+    /*
+     * XPATH for collection size on category page to be pushed to datalayer
+     */
+    public const XPATH_COLLECTION_SIZE = 'stape_gtm/datalayer/collection_size';
+
     /*
      * XPATH to check if webhooks are enabled
      */
@@ -274,4 +279,15 @@ public function getDomainListUrl()
     {
         return $this->scopeConfig->getValue(self::XPATH_DOMAIN_LIST_URL);
     }
+
+    /**
+     * Retrieve allowed collection size
+     *
+     * @param string|null $scopeCode
+     * @return int
+     */
+    public function getCollectionSize($scopeCode = null): int
+    {
+        return (int) $this->scopeConfig->getValue(self::XPATH_COLLECTION_SIZE, ScopeInterface::SCOPE_STORE, $scopeCode);
+    }
 }

ViewModel/Category.php

@@ -4,11 +4,13 @@
 
 use Magento\Catalog\Model\Layer;
 use Magento\Catalog\Model\Layer\Resolver;
+use Magento\Framework\Event\ManagerInterface;
 use Magento\Framework\Pricing\PriceCurrencyInterface;
 use Magento\Framework\Serialize\Serializer\Json;
 use Magento\Framework\View\Element\Block\ArgumentInterface;
 use Magento\Framework\View\Layout;
 use Magento\Store\Model\StoreManagerInterface;
+use Stape\Gtm\Model\ConfigProvider;
 
 class Category implements ArgumentInterface, DatalayerInterface
 {
@@ -33,6 +35,16 @@ class Category implements ArgumentInterface, DatalayerInterface
     /** @var Layout $layout */
     private $layout;
 
+    /**
+     * @var ConfigProvider $configProvider
+     */
+    private $configProvider;
+
+    /**
+     * @var ManagerInterface $eventManager
+     */
+    private $eventManager;
+
     /**
      * Define class dependencies
      *
@@ -41,19 +53,26 @@ class Category implements ArgumentInterface, DatalayerInterface
      * @param Resolver $layerResolver
      * @param PriceCurrencyInterface $priceCurrency
      * @param Layout $layout
+     * @param ContextInterface $context
+     * @param ConfigProvider $configProvider
+     * @param ManagerInterface $eventManager
      */
     public function __construct(
         Json $json,
         StoreManagerInterface $storeManager,
         Resolver $layerResolver,
         PriceCurrencyInterface $priceCurrency,
-        Layout $layout
+        Layout $layout,
+        ConfigProvider $configProvider,
+        ManagerInterface $eventManager
     ) {
         $this->json = $json;
         $this->storeManager = $storeManager;
         $this->layer = $layerResolver->get();
         $this->priceCurrency = $priceCurrency;
         $this->layout = $layout;
+        $this->configProvider = $configProvider;
+        $this->eventManager = $eventManager;
     }
 
     /**
@@ -70,17 +89,46 @@ private function getCategoryName()
         return '';
     }
 
+    /**
+     * Retrieve collection
+     *
+     * @return \Magento\Catalog\Model\ResourceModel\Product\Collection
+     */
+    private function prepareCollection()
+    {
+        /** @var \Magento\Catalog\Block\Product\ListProduct $productList */
+        $productList = $this->layout->createBlock(\Magento\Catalog\Block\Product\ListProduct::class);
+        $productCollection = $this->layer->getProductCollection();
+
+        // if collection is loaded there is some third-party/custom code loading it and conflicting the Stape module
+        if ($productCollection->isLoaded()) {
+            return $productCollection;
+        }
+
+        // cloning to avoid interfering with original product listing
+        $collection = clone $productCollection;
+
+        $toolbar = $productList->getToolbarBlock();
+        $toolbar->setCollection($collection);
+        $collection->setPageSize($this->configProvider->getCollectionSize());
+        $collection->setCurPage(1);
+
+        $this->eventManager->dispatch(
+            'catalog_block_product_list_collection',
+            ['collection' => $collection]
+        );
+
+        return $collection;
+    }
+
     /**
      * Preparing items
      *
      * @return array
      */
     public function prepareItems()
     {
-        /** @var \Magento\Catalog\Block\Product\ListProduct $productList */
-        $productList = $this->layout->createBlock(\Magento\Catalog\Block\Product\ListProduct::class);
-        $productList->getToolbarBlock()->setCollection($this->layer->getProductCollection());
-        $collection = $productList->getLoadedProductCollection();
+        $collection = $this->prepareCollection();
         $items = [];
         $index = 0;
         /** @var \Magento\Catalog\Model\Product $product */

etc/adminhtml/system.xml

@@ -53,6 +53,10 @@ This feature is available only if you use <a href="https://stape.io/gtm-server-h
                     <label>Add user data to Data Layer events</label>
                     <source_model>Magento\Config\Model\Config\Source\Enabledisable</source_model>
                 </field>
+                <field id="collection_size" showInDefault="1" showInStore="1" showInWebsite="1" sortOrder="20" translate="label">
+                    <label>Product Collection Limit</label>
+                    <validate>validate-integer</validate>
+                </field>
             </group>
             <group id="webhooks" showInDefault="1" showInStore="1" showInWebsite="1" sortOrder="10" translate="label">
                 <label>Webhooks</label>

etc/config.xml

@@ -6,6 +6,9 @@
             <domain_list>
                 <url><![CDATA[https://publicsuffix.org/list/public_suffix_list.dat]]></url>
             </domain_list>
+            <datalayer>
+                <collection_size>30</collection_size>
+            </datalayer>
         </stape_gtm>
     </default>
 </config>