MAGE-897 add productIds parameter to widget

Author: damcou

Block/Widget/LookingSimilar.php

@@ -46,6 +46,14 @@ public function generateUniqueToken()
         return $this->mathRandom->getRandomString(5);
     }
 
+    /**
+     * @return string
+     */
+    public function getProductIds()
+    {
+        return json_encode(explode(",", $this->getData('productIds')));
+    }
+
     /**
      * @return int
      */

etc/widget.xml

@@ -28,6 +28,10 @@
                 <description>How many products do you want to display in the Looking Similar Items?.</description>
                 <value>6</value>
             </parameter>
+            <parameter name="productIds" sort_order="20" visible="true" xsi:type="text">
+                <label>Product Ids (separated by commas)</label>
+                <description>Which product(s) should be taken as reference ? (mandatory if you don't plan to use this widget on a product page or on the cart page) </description>
+            </parameter>
         </parameters>
     </widget>
 </widgets>

view/frontend/templates/recommend/widget/looking-similar.phtml

@@ -10,6 +10,7 @@ if ($isEnabled):
                 "Algolia_AlgoliaSearch/recommend" : {
                     "recommendLSContainer" : "<?= $lsContainer ?>",
                     "numOfLookingSimilarItem" : "<?= $block->getData('numOfLookingSimilarItem') ?>",
+                    "productIds" : <?= $block->getProductIds() ?>
                 }
             }
         }

view/frontend/web/recommend.js

@@ -19,6 +19,7 @@ define([
             const apiKey = algoliaConfig.apiKey;
             const recommendClient = recommend(appId, apiKey);
             const indexName = this.defaultIndexName;
+            const objectIds = config.productIds ? config.productIds : config.algoliObjectId;
             if (
                 $('body').hasClass('catalog-product-view') ||
                 $('body').hasClass('checkout-cart-index')
@@ -34,7 +35,7 @@ define([
                         container         : '#frequentlyBoughtTogether',
                         recommendClient,
                         indexName,
-                        objectIDs         : config.algoliObjectId,
+                        objectIDs         : objectIds,
                         maxRecommendations: algoliaConfig.recommend.limitFBTProducts,
                         transformItems    : function (items) {
                             return items.map((item, index) => ({
@@ -67,7 +68,7 @@ define([
                         container         : '#relatedProducts',
                         recommendClient,
                         indexName,
-                        objectIDs         : config.algoliObjectId,
+                        objectIDs         : objectIds,
                         maxRecommendations: algoliaConfig.recommend.limitRelatedProducts,
                         transformItems    : function (items) {
                             return items.map((item, index) => ({
@@ -175,7 +176,7 @@ define([
                     container: '#lookingSimilar',
                     recommendClient,
                     indexName,
-                    objectIDs: config.algoliObjectId,
+                    objectIDs: objectIds,
                     maxRecommendations: algoliaConfig.recommend.limitLookingSimilar,
                     transformItems: function (items) {
                         return items.map((item, index) => ({
@@ -199,15 +200,15 @@ define([
                 });
             } else if (
                 algoliaConfig.recommend.enabledLookingSimilar &&
-                config.algoliObjectId &&
+                objectIds &&
                 typeof config.recommendLSContainer !== 'undefined'
             ){
                 let containerValue = '#' + config.recommendLSContainer;
                 recommendJs.lookingSimilar({
                     container: containerValue,
                     recommendClient,
                     indexName,
-                    objectIDs: config.algoliObjectId,
+                    objectIDs: objectIds,
                     maxRecommendations: config.numOfLookingSimilarItem
                         ? parseInt(config.numOfLookingSimilarItem)
                         : algoliaConfig.recommend.limitLookingSimilar,