Merge pull request #1695 from algolia/feat/MAGE-1154-record-builders

MAGE-1184: Entity Helpers refactoring

Author: damcou

Api/RecordBuilder/RecordBuilderInterface.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Api\RecordBuilder;
+
+use Magento\Framework\DataObject;
+
+interface RecordBuilderInterface
+{
+    public function buildRecord(DataObject $entity): array;
+}

Helper/Entity/AbstractEntityHelper.php

@@ -17,6 +17,14 @@ public function __construct(
      */
     abstract public function getIndexNameSuffix(): string;
 
+    /**
+     * Get the settings related to an entity to index
+     *
+     * @param int|null $storeId
+     * @return array
+     */
+    abstract public function getIndexSettings(?int $storeId = null): array;
+
     /**
      * For a given entity helper, return the Algolia index for the specified store
      * @param int $storeId The store index desired

Helper/Entity/AdditionalSectionHelper.php

@@ -2,7 +2,7 @@
 
 namespace Algolia\AlgoliaSearch\Helper\Entity;
 
-use Algolia\AlgoliaSearch\Service\AlgoliaConnector;
+use Algolia\AlgoliaSearch\Service\AdditionalSection\RecordBuilder as AdditionalSectionRecordBuilder;
 use Algolia\AlgoliaSearch\Service\IndexNameFetcher;
 use Magento\Catalog\Model\ResourceModel\Product\CollectionFactory;
 use Magento\Eav\Model\Config;
@@ -15,16 +15,20 @@ class AdditionalSectionHelper extends AbstractEntityHelper
     public const INDEX_NAME_SUFFIX = '_section';
 
     public function __construct(
-        protected ManagerInterface  $eventManager,
-        protected CollectionFactory $collectionFactory,
-        protected Config            $eavConfig,
-        protected IndexNameFetcher  $indexNameFetcher,
-    )
-    {
+        protected ManagerInterface               $eventManager,
+        protected CollectionFactory              $collectionFactory,
+        protected Config                         $eavConfig,
+        protected AdditionalSectionRecordBuilder $additionalSectionRecordBuilder,
+        protected IndexNameFetcher               $indexNameFetcher,
+    ) {
         parent::__construct($indexNameFetcher);
     }
 
-    public function getIndexSettings($storeId): array
+    /**
+     * @param int|null $storeId
+     * @return array
+     */
+    public function getIndexSettings(?int $storeId = null): array
     {
         $indexSettings = [
             'searchableAttributes' => ['unordered(value)'],
@@ -68,23 +72,13 @@ public function getAttributeValues($storeId, $section): array
         }
 
         $values = array_map(function ($value) use ($section, $storeId) {
-            $record = [
-                AlgoliaConnector::ALGOLIA_API_OBJECT_ID => $value,
-                'value'                                 => $value,
-            ];
-
-            $transport = new DataObject($record);
-            $this->eventManager->dispatch(
-                'algolia_additional_section_item_index_before',
-                ['section' => $section, 'record' => $transport, 'store_id' => $storeId]
-            );
-            $this->eventManager->dispatch(
-                'algolia_additional_section_items_before_index',
-                ['section' => $section, 'record' => $transport, 'store_id' => $storeId]
-            );
-            $record = $transport->getData();
-
-            return $record;
+            $dataObject = new DataObject([
+                'value' => $value,
+                'section' => $section,
+                'store_id' => $storeId
+            ]);
+
+            return $this->additionalSectionRecordBuilder->buildRecord($dataObject);
         }, $values);
 
         return $values;