MAGE-941 Refactor entity helpers to use trait

Author: cammonro

Helper/Entity/AdditionalSectionHelper.php

@@ -11,6 +11,9 @@
 
 class AdditionalSectionHelper extends AbstractEntityHelper
 {
+    use EntityHelperTrait;
+    public const INDEX_NAME_SUFFIX = '_section';
+
     public function __construct(
         protected ManagerInterface  $eventManager,
         protected CollectionFactory $collectionFactory,
@@ -21,14 +24,6 @@ public function __construct(
         parent::__construct($indexNameFetcher);
     }
 
-    /**
-     * @inheritDoc
-     */
-    public function getIndexNameSuffix(): string
-    {
-        return '_section';
-    }
-
     public function getIndexSettings($storeId): array
     {
         $indexSettings = [

Helper/Entity/CategoryHelper.php

@@ -24,6 +24,8 @@
 
 class CategoryHelper extends AbstractEntityHelper
 {
+    use EntityHelperTrait;
+    public const INDEX_NAME_SUFFIX = '_categories';
     protected $isCategoryVisibleInMenuCache;
     protected $coreCategories;
     protected $idColumn;
@@ -48,14 +50,6 @@ public function __construct(
         parent::__construct($indexNameFetcher);
     }
 
-    /**
-     * @inheritDoc
-     */
-    public function getIndexNameSuffix(): string
-    {
-        return '_categories';
-    }
-
     /**
      * @param $storeId
      * @return array|mixed|null

Helper/Entity/EntityHelperTrait.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Helper\Entity;
+
+trait EntityHelperTrait
+{
+    public function getIndexNameSuffix(): string
+    {
+        return self::INDEX_NAME_SUFFIX;
+    }
+}

Helper/Entity/PageHelper.php

@@ -15,6 +15,9 @@
 
 class PageHelper extends AbstractEntityHelper
 {
+    use EntityHelperTrait;
+    public const INDEX_NAME_SUFFIX = '_pages';
+
     public function __construct(
         protected ManagerInterface      $eventManager,
         protected PageCollectionFactory $pageCollectionFactory,
@@ -28,14 +31,6 @@ public function __construct(
         parent::__construct($indexNameFetcher);
     }
 
-    /**
-     * @inheritDoc
-     */
-    public function getIndexNameSuffix(): string
-    {
-        return '_pages';
-    }
-
     public function getIndexSettings($storeId)
     {
         $indexSettings = [

Helper/Entity/ProductHelper.php

@@ -41,6 +41,7 @@
 
 class ProductHelper extends AbstractEntityHelper
 {
+    use EntityHelperTrait;
     public const INDEX_NAME_SUFFIX = '_products';
     /**
      * @var AbstractType[]
@@ -113,14 +114,6 @@ public function __construct(
         parent::__construct($indexNameFetcher);
     }
 
-    /**
-     * @inheritDoc
-     */
-    public function getIndexNameSuffix(): string
-    {
-        return self::INDEX_NAME_SUFFIX;
-    }
-
     /**
      * @param bool $addEmptyRow
      * @return array

Helper/Entity/SuggestionHelper.php

@@ -15,6 +15,9 @@
 
 class SuggestionHelper extends AbstractEntityHelper
 {
+    use EntityHelperTrait;
+    public const INDEX_NAME_SUFFIX = '_suggestions';
+
     /**
      * @var string
      */
@@ -32,14 +35,6 @@ public function __construct(
         parent::__construct($indexNameFetcher);
     }
 
-    /**
-     * @inheritDoc
-     */
-    public function getIndexNameSuffix(): string
-    {
-        return '_suggestions';
-    }
-
     /**
      * @param $storeId
      * @return array|mixed|null