MAGE-1095: change index builders directory structure

damcou · damcou · commit 357f6897cafb · 2024-11-26T11:54:01.000+01:00
diff --git a/Helper/Data.php b/Helper/Data.php
@@ -5,12 +5,12 @@
 use Algolia\AlgoliaSearch\Exceptions\AlgoliaException;
 use Algolia\AlgoliaSearch\Exceptions\ExceededRetriesException;
 use Algolia\AlgoliaSearch\Logger\DiagnosticsLogger;
-use Algolia\AlgoliaSearch\Service\IndexBuilder\AdditionalSection as AdditionalSectionIndexBuilder;
-use Algolia\AlgoliaSearch\Service\IndexBuilder\Category as CategoryIndexBuilder;
-use Algolia\AlgoliaSearch\Service\IndexBuilder\Page as PageIndexBuilder;
-use Algolia\AlgoliaSearch\Service\IndexBuilder\Product as ProductIndexBuilder;
-use Algolia\AlgoliaSearch\Service\IndexBuilder\Suggestion as SuggestionIndexBuilder;
+use Algolia\AlgoliaSearch\Service\AdditionalSection\IndexBuilder as AdditionalSectionIndexBuilder;
+use Algolia\AlgoliaSearch\Service\Category\IndexBuilder as CategoryIndexBuilder;
 use Algolia\AlgoliaSearch\Service\IndexNameFetcher;
+use Algolia\AlgoliaSearch\Service\Page\IndexBuilder as PageIndexBuilder;
+use Algolia\AlgoliaSearch\Service\Product\IndexBuilder as ProductIndexBuilder;
+use Algolia\AlgoliaSearch\Service\Suggestion\IndexBuilder as SuggestionIndexBuilder;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Store\Api\Data\StoreInterface;
@@ -39,7 +39,7 @@ public function __construct(
      * @throws \Exception
      *
      * @deprecated
-     * Use Algolia\AlgoliaSearch\Service\IndexBuilder\AdditionalSection::rebuildIndex() instead
+     * Use Algolia\AlgoliaSearch\Service\AdditionalSection\IndexBuilder::rebuildIndex() instead
      */
     public function rebuildStoreAdditionalSectionsIndex(int $storeId): void
     {
@@ -54,7 +54,7 @@ public function rebuildStoreAdditionalSectionsIndex(int $storeId): void
      * @throws NoSuchEntityException
      *
      * @deprecated
-     * Use Algolia\AlgoliaSearch\Service\IndexBuilder\Page::rebuildIndex() instead
+     * Use Algolia\AlgoliaSearch\Service\Page\IndexBuilder::rebuildIndex() instead
      */
     public function rebuildStorePageIndex($storeId, array $pageIds = null): void
     {
@@ -69,7 +69,7 @@ public function rebuildStorePageIndex($storeId, array $pageIds = null): void
      * @throws NoSuchEntityException
      *
      * @deprecated
-     * Use Algolia\AlgoliaSearch\Service\IndexBuilder\Category::rebuildIndexIds() instead
+     * Use Algolia\AlgoliaSearch\Service\Category\IndexBuilder::rebuildIndexIds() instead
      */
     public function rebuildStoreCategoryIndex($storeId, $categoryIds = null): void
     {
@@ -84,7 +84,7 @@ public function rebuildStoreCategoryIndex($storeId, $categoryIds = null): void
      * @throws NoSuchEntityException
      *
      * @deprecated
-     * Use Algolia\AlgoliaSearch\Service\IndexBuilder\Suggestion::rebuildIndex() instead
+     * Use Algolia\AlgoliaSearch\Service\Suggestion:\IndexBuilder:rebuildIndex() instead
      */
     public function rebuildStoreSuggestionIndex(int $storeId): void
     {
@@ -98,7 +98,7 @@ public function rebuildStoreSuggestionIndex(int $storeId): void
      * @throws \Exception
      *
      * @deprecated
-     * Use Algolia\AlgoliaSearch\Service\IndexBuilder\Product::rebuildIndexIds() instead
+     * Use Algolia\AlgoliaSearch\Service\Product\IndexBuilder::rebuildIndexIds() instead
      */
     public function rebuildStoreProductIndex(int $storeId, array $productIds): void
     {
@@ -115,7 +115,7 @@ public function rebuildStoreProductIndex(int $storeId, array $productIds): void
      * @throws \Exception
      *
      * @deprecated
-     * Use Algolia\AlgoliaSearch\Service\IndexBuilder\Product::rebuildIndex() instead
+     * Use Algolia\AlgoliaSearch\Service\Product\IndexBuilder::rebuildIndex() instead
      */
     public function rebuildProductIndex(int $storeId, ?array $productIds, int $page, int $pageSize, bool $useTmpIndex): void
     {
@@ -132,7 +132,7 @@ public function rebuildProductIndex(int $storeId, ?array $productIds, int $page,
      * @throws \Exception
      *
      * @deprecated
-     * Use Algolia\AlgoliaSearch\Service\IndexBuilder\Category::rebuildIndex() instead
+     * Use Algolia\AlgoliaSearch\Service\Category\IndexBuilder::rebuildIndex() instead
      */
     public function rebuildCategoryIndex(int $storeId, int $page, int $pageSize): void
     {
@@ -146,7 +146,7 @@ public function rebuildCategoryIndex(int $storeId, int $page, int $pageSize): vo
      * @throws AlgoliaException
      *
      * @deprecated
-     * Use Algolia\AlgoliaSearch\Service\IndexBuilder\Product::deleteInactiveProducts() instead
+     * Use Algolia\AlgoliaSearch\Service\Product\IndexBuilder::deleteInactiveProducts() instead
      */
     public function deleteInactiveProducts($storeId): void
     {
@@ -163,7 +163,7 @@ public function deleteInactiveProducts($storeId): void
      * @internal This method is currently unstable and should not be used. It may be revisited or fixed in a future version.
      *
      * @deprecated
-     * Use Algolia\AlgoliaSearch\Service\IndexBuilder\Product::getSearchResult() instead
+     * Use Algolia\AlgoliaSearch\Service\Product\IndexBuilder::getSearchResult() instead
      */
     public function getSearchResult(string $query, int $storeId, ?array $searchParams = null, ?string $targetedIndex = null): array
     {
diff --git a/Service/AbstractIndexBuilder.php b/Service/AbstractIndexBuilder.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Algolia\AlgoliaSearch\Service\IndexBuilder;
+namespace Algolia\AlgoliaSearch\Service;
 
 use Algolia\AlgoliaSearch\Exceptions\AlgoliaException;
 use Algolia\AlgoliaSearch\Helper\AlgoliaHelper;
diff --git a/Service/AdditionalSection/IndexBuilder.php b/Service/AdditionalSection/IndexBuilder.php
@@ -1,19 +1,20 @@
 <?php
 
-namespace Algolia\AlgoliaSearch\Service\IndexBuilder;
+namespace Algolia\AlgoliaSearch\Service\AdditionalSection;
 
 use Algolia\AlgoliaSearch\Exceptions\AlgoliaException;
 use Algolia\AlgoliaSearch\Exceptions\ExceededRetriesException;
 use Algolia\AlgoliaSearch\Helper\AlgoliaHelper;
 use Algolia\AlgoliaSearch\Helper\ConfigHelper;
 use Algolia\AlgoliaSearch\Helper\Entity\AdditionalSectionHelper;
 use Algolia\AlgoliaSearch\Logger\DiagnosticsLogger;
+use Algolia\AlgoliaSearch\Service\AbstractIndexBuilder;
 use Algolia\AlgoliaSearch\Service\IndexNameFetcher;
 use Magento\Framework\App\Config\ScopeCodeResolver;
 use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Store\Model\App\Emulation;
 
-class AdditionalSection extends AbstractIndexBuilder
+class IndexBuilder extends AbstractIndexBuilder
 {
     public function __construct(
         protected ConfigHelper            $configHelper,
diff --git a/Service/Category/IndexBuilder.php b/Service/Category/IndexBuilder.php
@@ -1,20 +1,21 @@
 <?php
 
-namespace Algolia\AlgoliaSearch\Service\IndexBuilder;
+namespace Algolia\AlgoliaSearch\Service\Category;
 
 use Algolia\AlgoliaSearch\Exception\CategoryReindexingException;
 use Algolia\AlgoliaSearch\Exceptions\AlgoliaException;
 use Algolia\AlgoliaSearch\Helper\AlgoliaHelper;
 use Algolia\AlgoliaSearch\Helper\ConfigHelper;
 use Algolia\AlgoliaSearch\Helper\Entity\CategoryHelper;
 use Algolia\AlgoliaSearch\Logger\DiagnosticsLogger;
+use Algolia\AlgoliaSearch\Service\AbstractIndexBuilder;
 use Magento\Catalog\Model\ResourceModel\Category\Collection;
 use Magento\Framework\App\Config\ScopeCodeResolver;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Store\Model\App\Emulation;
 
-class Category extends AbstractIndexBuilder
+class IndexBuilder extends AbstractIndexBuilder
 {
     public function __construct(
         protected ConfigHelper      $configHelper,
diff --git a/Service/Page/IndexBuilder.php b/Service/Page/IndexBuilder.php
@@ -1,18 +1,19 @@
 <?php
 
-namespace Algolia\AlgoliaSearch\Service\IndexBuilder;
+namespace Algolia\AlgoliaSearch\Service\Page;
 
 use Algolia\AlgoliaSearch\Exceptions\AlgoliaException;
 use Algolia\AlgoliaSearch\Helper\AlgoliaHelper;
 use Algolia\AlgoliaSearch\Helper\ConfigHelper;
 use Algolia\AlgoliaSearch\Helper\Entity\PageHelper;
 use Algolia\AlgoliaSearch\Logger\DiagnosticsLogger;
+use Algolia\AlgoliaSearch\Service\AbstractIndexBuilder;
 use Algolia\AlgoliaSearch\Service\IndexNameFetcher;
 use Magento\Framework\App\Config\ScopeCodeResolver;
 use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Store\Model\App\Emulation;
 
-class Page extends AbstractIndexBuilder
+class IndexBuilder extends AbstractIndexBuilder
 {
     public function __construct(
         protected ConfigHelper      $configHelper,
diff --git a/Service/Product/IndexBuilder.php b/Service/Product/IndexBuilder.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Algolia\AlgoliaSearch\Service\IndexBuilder;
+namespace Algolia\AlgoliaSearch\Service\Product;
 
 use Algolia\AlgoliaSearch\Exception\ProductReindexingException;
 use Algolia\AlgoliaSearch\Exceptions\AlgoliaException;
@@ -9,6 +9,7 @@
 use Algolia\AlgoliaSearch\Helper\Entity\ProductHelper;
 use Algolia\AlgoliaSearch\Helper\ProductDataArray;
 use Algolia\AlgoliaSearch\Logger\DiagnosticsLogger;
+use Algolia\AlgoliaSearch\Service\AbstractIndexBuilder;
 use Magento\Catalog\Model\ResourceModel\Product\Collection;
 use Magento\Framework\App\Config\ScopeCodeResolver;
 use Magento\Framework\App\ResourceConnection;
@@ -18,7 +19,7 @@
 use Magento\Framework\Indexer\IndexerRegistry;
 use Magento\Store\Model\App\Emulation;
 
-class Product extends AbstractIndexBuilder
+class IndexBuilder extends AbstractIndexBuilder
 {
     protected IndexerInterface $priceIndexer;
 
diff --git a/Service/Suggestion/IndexBuilder.php b/Service/Suggestion/IndexBuilder.php
@@ -1,20 +1,21 @@
 <?php
 
-namespace Algolia\AlgoliaSearch\Service\IndexBuilder;
+namespace Algolia\AlgoliaSearch\Service\Suggestion;
 
 use Algolia\AlgoliaSearch\Exceptions\AlgoliaException;
 use Algolia\AlgoliaSearch\Exceptions\ExceededRetriesException;
 use Algolia\AlgoliaSearch\Helper\AlgoliaHelper;
 use Algolia\AlgoliaSearch\Helper\ConfigHelper;
 use Algolia\AlgoliaSearch\Helper\Entity\SuggestionHelper;
 use Algolia\AlgoliaSearch\Logger\DiagnosticsLogger;
+use Algolia\AlgoliaSearch\Service\AbstractIndexBuilder;
 use Magento\Framework\App\Config\ScopeCodeResolver;
 use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Search\Model\Query;
 use Magento\Search\Model\ResourceModel\Query\Collection as QueryCollection;
 use Magento\Store\Model\App\Emulation;
 
-class Suggestion extends AbstractIndexBuilder
+class IndexBuilder extends AbstractIndexBuilder
 {
     public function __construct(
         protected ConfigHelper      $configHelper,

Original file line number	Diff line number	Diff line change
`@@ -5,12 +5,12 @@`
`5`	`5`	`use Algolia\AlgoliaSearch\Exceptions\AlgoliaException;`
`6`	`6`	`use Algolia\AlgoliaSearch\Exceptions\ExceededRetriesException;`
`7`	`7`	`use Algolia\AlgoliaSearch\Logger\DiagnosticsLogger;`
`8`		`-use Algolia\AlgoliaSearch\Service\IndexBuilder\AdditionalSection as AdditionalSectionIndexBuilder;`
`9`		`-use Algolia\AlgoliaSearch\Service\IndexBuilder\Category as CategoryIndexBuilder;`
`10`		`-use Algolia\AlgoliaSearch\Service\IndexBuilder\Page as PageIndexBuilder;`
`11`		`-use Algolia\AlgoliaSearch\Service\IndexBuilder\Product as ProductIndexBuilder;`
`12`		`-use Algolia\AlgoliaSearch\Service\IndexBuilder\Suggestion as SuggestionIndexBuilder;`
	`8`	`+use Algolia\AlgoliaSearch\Service\AdditionalSection\IndexBuilder as AdditionalSectionIndexBuilder;`
	`9`	`+use Algolia\AlgoliaSearch\Service\Category\IndexBuilder as CategoryIndexBuilder;`
`13`	`10`	`use Algolia\AlgoliaSearch\Service\IndexNameFetcher;`
	`11`	`+use Algolia\AlgoliaSearch\Service\Page\IndexBuilder as PageIndexBuilder;`
	`12`	`+use Algolia\AlgoliaSearch\Service\Product\IndexBuilder as ProductIndexBuilder;`
	`13`	`+use Algolia\AlgoliaSearch\Service\Suggestion\IndexBuilder as SuggestionIndexBuilder;`
`14`	`14`	`use Magento\Framework\Exception\LocalizedException;`
`15`	`15`	`use Magento\Framework\Exception\NoSuchEntityException;`
`16`	`16`	`use Magento\Store\Api\Data\StoreInterface;`
`@@ -39,7 +39,7 @@ public function __construct(`
`39`	`39`	`* @throws \Exception`
`40`	`40`	`*`
`41`	`41`	`* @deprecated`
`42`		`- * Use Algolia\AlgoliaSearch\Service\IndexBuilder\AdditionalSection::rebuildIndex() instead`
	`42`	`+ * Use Algolia\AlgoliaSearch\Service\AdditionalSection\IndexBuilder::rebuildIndex() instead`
`43`	`43`	`*/`
`44`	`44`	`public function rebuildStoreAdditionalSectionsIndex(int $storeId): void`
`45`	`45`	`{`
`@@ -54,7 +54,7 @@ public function rebuildStoreAdditionalSectionsIndex(int $storeId): void`
`54`	`54`	`* @throws NoSuchEntityException`
`55`	`55`	`*`
`56`	`56`	`* @deprecated`
`57`		`- * Use Algolia\AlgoliaSearch\Service\IndexBuilder\Page::rebuildIndex() instead`
	`57`	`+ * Use Algolia\AlgoliaSearch\Service\Page\IndexBuilder::rebuildIndex() instead`
`58`	`58`	`*/`
`59`	`59`	`public function rebuildStorePageIndex($storeId, array $pageIds = null): void`
`60`	`60`	`{`
`@@ -69,7 +69,7 @@ public function rebuildStorePageIndex($storeId, array $pageIds = null): void`
`69`	`69`	`* @throws NoSuchEntityException`
`70`	`70`	`*`
`71`	`71`	`* @deprecated`
`72`		`- * Use Algolia\AlgoliaSearch\Service\IndexBuilder\Category::rebuildIndexIds() instead`
	`72`	`+ * Use Algolia\AlgoliaSearch\Service\Category\IndexBuilder::rebuildIndexIds() instead`
`73`	`73`	`*/`
`74`	`74`	`public function rebuildStoreCategoryIndex($storeId, $categoryIds = null): void`
`75`	`75`	`{`
`@@ -84,7 +84,7 @@ public function rebuildStoreCategoryIndex($storeId, $categoryIds = null): void`
`84`	`84`	`* @throws NoSuchEntityException`
`85`	`85`	`*`
`86`	`86`	`* @deprecated`
`87`		`- * Use Algolia\AlgoliaSearch\Service\IndexBuilder\Suggestion::rebuildIndex() instead`
	`87`	`+ * Use Algolia\AlgoliaSearch\Service\Suggestion:\IndexBuilder:rebuildIndex() instead`
`88`	`88`	`*/`
`89`	`89`	`public function rebuildStoreSuggestionIndex(int $storeId): void`
`90`	`90`	`{`
`@@ -98,7 +98,7 @@ public function rebuildStoreSuggestionIndex(int $storeId): void`
`98`	`98`	`* @throws \Exception`
`99`	`99`	`*`
`100`	`100`	`* @deprecated`
`101`		`- * Use Algolia\AlgoliaSearch\Service\IndexBuilder\Product::rebuildIndexIds() instead`
	`101`	`+ * Use Algolia\AlgoliaSearch\Service\Product\IndexBuilder::rebuildIndexIds() instead`
`102`	`102`	`*/`
`103`	`103`	`public function rebuildStoreProductIndex(int $storeId, array $productIds): void`
`104`	`104`	`{`
`@@ -115,7 +115,7 @@ public function rebuildStoreProductIndex(int $storeId, array $productIds): void`
`115`	`115`	`* @throws \Exception`
`116`	`116`	`*`
`117`	`117`	`* @deprecated`
`118`		`- * Use Algolia\AlgoliaSearch\Service\IndexBuilder\Product::rebuildIndex() instead`
	`118`	`+ * Use Algolia\AlgoliaSearch\Service\Product\IndexBuilder::rebuildIndex() instead`
`119`	`119`	`*/`
`120`	`120`	`public function rebuildProductIndex(int $storeId, ?array $productIds, int $page, int $pageSize, bool $useTmpIndex): void`
`121`	`121`	`{`
`@@ -132,7 +132,7 @@ public function rebuildProductIndex(int $storeId, ?array $productIds, int $page,`
`132`	`132`	`* @throws \Exception`
`133`	`133`	`*`
`134`	`134`	`* @deprecated`
`135`		`- * Use Algolia\AlgoliaSearch\Service\IndexBuilder\Category::rebuildIndex() instead`
	`135`	`+ * Use Algolia\AlgoliaSearch\Service\Category\IndexBuilder::rebuildIndex() instead`
`136`	`136`	`*/`
`137`	`137`	`public function rebuildCategoryIndex(int $storeId, int $page, int $pageSize): void`
`138`	`138`	`{`
`@@ -146,7 +146,7 @@ public function rebuildCategoryIndex(int $storeId, int $page, int $pageSize): vo`
`146`	`146`	`* @throws AlgoliaException`
`147`	`147`	`*`
`148`	`148`	`* @deprecated`
`149`		`- * Use Algolia\AlgoliaSearch\Service\IndexBuilder\Product::deleteInactiveProducts() instead`
	`149`	`+ * Use Algolia\AlgoliaSearch\Service\Product\IndexBuilder::deleteInactiveProducts() instead`
`150`	`150`	`*/`
`151`	`151`	`public function deleteInactiveProducts($storeId): void`
`152`	`152`	`{`
`@@ -163,7 +163,7 @@ public function deleteInactiveProducts($storeId): void`
`163`	`163`	`* @internal This method is currently unstable and should not be used. It may be revisited or fixed in a future version.`
`164`	`164`	`*`
`165`	`165`	`* @deprecated`
`166`		`- * Use Algolia\AlgoliaSearch\Service\IndexBuilder\Product::getSearchResult() instead`
	`166`	`+ * Use Algolia\AlgoliaSearch\Service\Product\IndexBuilder::getSearchResult() instead`
`167`	`167`	`*/`
`168`	`168`	`public function getSearchResult(string $query, int $storeId, ?array $searchParams = null, ?string $targetedIndex = null): array`
`169`	`169`	`{`