FFWEB-2332 : add PPP configuration

Author: a.laurowski

CHANGELOG.md

@@ -1,4 +1,9 @@
 # Changelog
+# [Unreleased]
+### Add
+ - Search Result Page, Category Page
+  - add Products per Page configurartion which allows user to define custom configuration without any change in code
+
 ## [v2.5.0] - 2022.03.04
  - Import 
   - fix error while push import feed using CLI after generate it for API version 7.x

composer.json

@@ -23,7 +23,7 @@
     "magento/magento-coding-standard": "^6.0",
     "pdepend/pdepend": "^2.8",
     "phpmd/phpmd": "^2.9",
-    "phpunit/phpunit": ">=6.5 <10.0"
+    "phpunit/phpunit": ">=9.5 <10.0"
   },
   "autoload": {
     "files": [

docs/assets/custom-elements-options.png

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Omikron\Factfinder\Block\Adminhtml\System\Config\Field;
+
+use Magento\Backend\Block\Template\Context;
+use Magento\Config\Block\System\Config\Form\Field\FieldArray\AbstractFieldArray;
+use Magento\Config\Model\Config\Source\Yesno;
+use Magento\Framework\Data\OptionSourceInterface;
+use Magento\Framework\DataObject;
+
+/**
+ * @SuppressWarnings(PHPMD.CamelCaseMethodName)
+ */
+class ProductsPerPage extends AbstractFieldArray
+{
+
+    protected function _prepareToRender()
+    {
+        $this->_addAfter = false;
+        $this->addColumn('value', [
+            'label'    => __('Num of records'),
+            'class'    => 'required-entry',
+        ]);
+    }
+}

src/Block/Adminhtml/System/Config/Field/ProductsPerPage.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Omikron\Factfinder\Test\Unit\ViewModel;
+
+use Magento\Framework\App\Config\ScopeConfigInterface;
+use Magento\Framework\Serialize\Serializer\Json;
+use Omikron\Factfinder\ViewModel\ProductsPerPage;
+use PHPUnit\Framework\TestCase;
+
+class ProductPerPageTest extends TestCase
+{
+    /** @var ProductsPerPage */
+    private $productsPerPage;
+
+    private $scopeConfigMock;
+
+    public function test_will_unserialize_stored_values()
+    {
+        $this->scopeConfigMock->method('getValue')->with('factfinder/components_options/products_per_page')
+            ->willReturn('{"_1648807417584_584":{"value":"8"},"_1648807420544_544":{"value":"12"},"_1648807422801_801":{"value":"16"}}');
+
+        $this->assertIsString($this->productsPerPage->getProductsPerPageConfiguration());
+    }
+
+    public function test_output_have_correct_structure()
+    {
+        $this->scopeConfigMock->method('getValue')->with('factfinder/components_options/products_per_page')
+            ->willReturn('{"_1648807417584_584":{"value":"8"},"_1648807420544_544":{"value":"12"},"_1648807422801_801":{"value":"16"}}');
+
+        $actual = $this->productsPerPage->getProductsPerPageConfiguration();
+
+        $this->assertStringContainsString('{"value":"8","selected":false,"default":false}', $actual);
+    }
+
+    public function test_return_empty_array_literal_if_no_stored_values()
+    {
+        $this->scopeConfigMock->method('getValue')->with('factfinder/components_options/products_per_page')
+            ->willReturn(null);
+
+        $this->assertEquals('[]', $this->productsPerPage->getProductsPerPageConfiguration());
+    }
+
+    protected function setUp(): void
+    {
+        $this->scopeConfigMock = $this->createMock(ScopeConfigInterface::class);
+        $this->productsPerPage = new ProductsPerPage(
+            $this->scopeConfigMock,
+            new Json(),
+        );
+    }
+}

src/Test/Unit/ViewModel/ProductPerPageTest.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Omikron\Factfinder\ViewModel;
+
+use Magento\Framework\App\Config\ScopeConfigInterface;
+use Magento\Framework\Serialize\Serializer\Json;
+use Magento\Framework\Serialize\SerializerInterface;
+use Magento\Framework\View\Element\Block\ArgumentInterface;
+
+class ProductsPerPage implements ArgumentInterface
+{
+    private const PRODUCT_PER_PAGE_CONFIG_PATH = 'factfinder/components_options/products_per_page';
+
+    /** @var ScopeConfigInterface */
+    private $scopeConfig;
+
+    /** @var SerializerInterface */
+    private $serializer;
+
+    public function __construct(ScopeConfigInterface $scopeConfig, Json $json)
+    {
+        $this->scopeConfig = $scopeConfig;
+        $this->serializer  = $json;
+    }
+
+    public function getProductsPerPageConfiguration(): string
+    {
+        $storedValue  = $this->scopeConfig->getValue(self::PRODUCT_PER_PAGE_CONFIG_PATH);
+        $unserialized = array_map(function (array $row) {
+            return $row + [
+                    'selected' => false,
+                    'default'  => false
+                ];
+        }, array_values($this->serializer->unserialize($storedValue ?: '[]')));
+
+        return count($unserialized) ? $this->serializer->serialize($unserialized) : '[]';
+    }
+}

src/ViewModel/ProductsPerPage.php

@@ -53,5 +53,16 @@
             <label>Max Result for Recommendation</label>
             <tooltip>This will apply to a template offered by the module. If you have overriden it, you must manually provide stored value to the frontend</tooltip>
         </field>
+
+        <field id="products_per_page" translate="label comment" sortOrder="10" showInDefault="1" showInWebsite="1">
+            <label>Product per Page Configuration</label>
+            <frontend_model>Omikron\Factfinder\Block\Adminhtml\System\Config\Field\ProductsPerPage</frontend_model>
+            <backend_model>Magento\Config\Model\Config\Backend\Serialized\ArraySerialized</backend_model>
+            <comment>
+                This configuration allows you to add new product per page entries to the existing default entry which you define in FACT-Finder UI.
+                Please remember that the default entry received from FACT-Finder response will be always put as first.
+                Because of that, all entries here should have bigger values than default entry. There is no possibility to sort all entries before rendering
+            </comment>
+        </field>
     </group>
 </include>

src/etc/adminhtml/system/components.xml

@@ -19,6 +19,12 @@
             <block class="Magento\Framework\View\Element\Template" name="factfinder.communication" ifconfig="factfinder/general/is_enabled" template="Omikron_Factfinder::ff/communication.phtml" before="-">
                 <arguments>
                     <argument name="view_model" xsi:type="object">Omikron\Factfinder\ViewModel\Communication</argument>
+                    <argument name="ppp" xsi:type="helper" helper="Omikron\Factfinder\ViewModel\Cart::getItemIds" />
+                </arguments>
+            </block>
+            <block class="Magento\Framework\View\Element\Template" name="factfinder.communication.ppp" ifconfig="factfinder/general/is_enabled" template="Omikron_Factfinder::ff/products-per-page-configuration.phtml" after="factfinder.communication">
+                <arguments>
+                    <argument name="view_model" xsi:type="object">Omikron\Factfinder\ViewModel\ProductsPerPage</argument>
                 </arguments>
             </block>
             <block class="Magento\Framework\View\Element\Template" name="factfinder.search.redirect" ifconfig="factfinder/general/is_enabled" template="Omikron_Factfinder::ff/search-redirect.phtml" after="factfinder.communication" />

src/view/frontend/layout/default.xml

@@ -0,0 +1,15 @@
+<?php
+/** @var Magento\Framework\View\Element\Template $block */
+/** @var Omikron\Factfinder\ViewModel\ProductsPerPage $viewModel */
+$viewModel  = $block->getViewModel();
+?>
+
+<script>
+    document.addEventListener('ffReady', function () {
+        const conf = <?= /* @noEscape */ $viewModel->getProductsPerPageConfiguration() ?>;
+        if (conf.length > 0) {
+            const first = [factfinder.communication.pppConf.entries[0]];
+            factfinder.communication.pppConf.entries  = first.concat(conf);
+        }
+    });
+</script>