Revert "[BC] Introduce type specific interfaces (#224)"

mattamon · mattamon · commit 8fb4056caee4 · 2024-10-07T13:47:59.000+02:00
This reverts commit 95ef63c.
diff --git a/doc/01_Installation/02_Upgrade.md b/doc/01_Installation/02_Upgrade.md
@@ -6,24 +6,3 @@ Following steps are necessary during updating to newer versions.
 - Execute the following command to reindex all elements to be able to use all new features:
 
   ```bin/console generic-data-index:update:index```
-
-## Upgrade to 2.0.0
-
-### BC-Breaks
-
-#### Interface changes
--  Added `PermissionTypes $permissionType` parameter with default type `PermissionTypes::LIST` to
-- `AssetSearchServiceInterface::search` method
-- `DocumentSearchServiceInterface::search` method
-- `DataObjectSearchServiceInterface::search` method
-- `ElementSearchServiceInterface::search` method
-- Search services `byId` methods now return elements based on the `PermissionTypes::VIEW` permission
-- Added type specific interfaces for searches to avoid mixing up different search types in search services
-  - `AssetSearch` now implements `AssetSearchInterface`
-  - `DocumentSearch` now implements `DocumentSearchInterface`
-  - `ElementSearch` now implements `ElementSearchInterface`
-- Search services now require the specific search type for the search
-  - `AssetSearchServiceInterface::search` now requires a `AssetSearchInterface`
-  - `DocumentSearchServiceInterface::search`  now requires a `DocumentSearchInterface`
-  - `ElementSearchServiceInterface::search`  now requires a `ElementSearchInterface`
-- `SearchProviderInterface` now returns type specific search interfaces
diff --git a/src/Model/Search/Asset/AssetSearch.php b/src/Model/Search/Asset/AssetSearch.php
@@ -18,6 +18,6 @@
 
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\BaseSearch;
 
-final class AssetSearch extends BaseSearch implements AssetSearchInterface
+final class AssetSearch extends BaseSearch
 {
 }
diff --git a/src/Model/Search/Asset/AssetSearchInterface.php b/src/Model/Search/Asset/AssetSearchInterface.php
diff --git a/src/Model/Search/Document/DocumentSearch.php b/src/Model/Search/Document/DocumentSearch.php
@@ -18,6 +18,6 @@
 
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\BaseSearch;
 
-final class DocumentSearch extends BaseSearch implements DocumentSearchInterface
+final class DocumentSearch extends BaseSearch
 {
 }
diff --git a/src/Model/Search/Document/DocumentSearchInterface.php b/src/Model/Search/Document/DocumentSearchInterface.php
diff --git a/src/Model/Search/Element/ElementSearch.php b/src/Model/Search/Element/ElementSearch.php
@@ -18,6 +18,6 @@
 
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\BaseSearch;
 
-final class ElementSearch extends BaseSearch implements ElementSearchInterface
+final class ElementSearch extends BaseSearch
 {
 }
diff --git a/src/Model/Search/Element/ElementSearchInterface.php b/src/Model/Search/Element/ElementSearchInterface.php
diff --git a/src/Service/Search/SearchService/Asset/AssetSearchService.php b/src/Service/Search/SearchService/Asset/AssetSearchService.php
@@ -19,9 +19,9 @@
 use Exception;
 use Pimcore\Bundle\GenericDataIndexBundle\Enum\Permission\UserPermissionTypes;
 use Pimcore\Bundle\GenericDataIndexBundle\Exception\AssetSearchException;
-use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Asset\AssetSearchInterface;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Asset\SearchResult\AssetSearchResult;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Asset\SearchResult\AssetSearchResultItem;
+use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Interfaces\SearchInterface;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Basic\IdFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Permission\Workspace\AssetWorkspace;
 use Pimcore\Bundle\GenericDataIndexBundle\SearchIndexAdapter\Search\Pagination\PaginationInfoServiceInterface;
@@ -47,7 +47,7 @@ public function __construct(
     /**
      * @throws AssetSearchException
      */
-    public function search(AssetSearchInterface $assetSearch): AssetSearchResult
+    public function search(SearchInterface $assetSearch): AssetSearchResult
     {
         $assetSearch = $this->searchHelper->addSearchRestrictions(
             search: $assetSearch,
diff --git a/src/Service/Search/SearchService/Asset/AssetSearchServiceInterface.php b/src/Service/Search/SearchService/Asset/AssetSearchServiceInterface.php
@@ -17,18 +17,17 @@
 namespace Pimcore\Bundle\GenericDataIndexBundle\Service\Search\SearchService\Asset;
 
 use Pimcore\Bundle\GenericDataIndexBundle\Exception\AssetSearchException;
-use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Asset\AssetSearchInterface;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Asset\SearchResult\AssetSearchResult;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Asset\SearchResult\AssetSearchResultItem;
-
+use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Interfaces\SearchInterface;
 use Pimcore\Model\User;
 
 interface AssetSearchServiceInterface
 {
     /**
      * @throws AssetSearchException
      */
-    public function search(AssetSearchInterface $assetSearch): AssetSearchResult;
+    public function search(SearchInterface $assetSearch): AssetSearchResult;
 
     /**
      * @throws AssetSearchException
diff --git a/src/Service/Search/SearchService/Document/DocumentSearchService.php b/src/Service/Search/SearchService/Document/DocumentSearchService.php
@@ -19,9 +19,9 @@
 use Exception;
 use Pimcore\Bundle\GenericDataIndexBundle\Enum\Permission\UserPermissionTypes;
 use Pimcore\Bundle\GenericDataIndexBundle\Exception\DocumentSearchException;
-use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Document\DocumentSearchInterface;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Document\SearchResult\DocumentSearchResult;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Document\SearchResult\DocumentSearchResultItem;
+use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Interfaces\SearchInterface;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Basic\IdFilter;
 use Pimcore\Bundle\GenericDataIndexBundle\Permission\Workspace\DocumentWorkspace;
 use Pimcore\Bundle\GenericDataIndexBundle\SearchIndexAdapter\Search\Pagination\PaginationInfoServiceInterface;
@@ -47,7 +47,7 @@ public function __construct(
     /**
      * @throws DocumentSearchException
      */
-    public function search(DocumentSearchInterface $documentSearch): DocumentSearchResult
+    public function search(SearchInterface $documentSearch): DocumentSearchResult
     {
         $documentSearch = $this->searchHelper->addSearchRestrictions(
             search: $documentSearch,
diff --git a/src/Service/Search/SearchService/Document/DocumentSearchServiceInterface.php b/src/Service/Search/SearchService/Document/DocumentSearchServiceInterface.php
@@ -17,17 +17,17 @@
 namespace Pimcore\Bundle\GenericDataIndexBundle\Service\Search\SearchService\Document;
 
 use Pimcore\Bundle\GenericDataIndexBundle\Exception\DocumentSearchException;
-use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Document\DocumentSearchInterface;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Document\SearchResult\DocumentSearchResult;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Document\SearchResult\DocumentSearchResultItem;
+use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Interfaces\SearchInterface;
 use Pimcore\Model\User;
 
 interface DocumentSearchServiceInterface
 {
     /**
      * @throws DocumentSearchException
      */
-    public function search(DocumentSearchInterface $documentSearch): DocumentSearchResult;
+    public function search(SearchInterface $documentSearch): DocumentSearchResult;
 
     /**
      * @throws DocumentSearchException
diff --git a/src/Service/Search/SearchService/Element/ElementSearchService.php b/src/Service/Search/SearchService/Element/ElementSearchService.php
@@ -19,9 +19,9 @@
 use Exception;
 use Pimcore\Bundle\GenericDataIndexBundle\Enum\SearchIndex\ElementType;
 use Pimcore\Bundle\GenericDataIndexBundle\Exception\ElementSearchException;
-use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Element\ElementSearchInterface;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Element\SearchResult\ElementSearchResult;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Interfaces\ElementSearchResultItemInterface;
+use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Interfaces\SearchInterface;
 use Pimcore\Bundle\GenericDataIndexBundle\SearchIndexAdapter\Search\Pagination\PaginationInfoServiceInterface;
 use Pimcore\Bundle\GenericDataIndexBundle\Service\Search\SearchService\Asset\AssetSearchServiceInterface;
 use Pimcore\Bundle\GenericDataIndexBundle\Service\Search\SearchService\DataObject\DataObjectSearchServiceInterface;
@@ -44,7 +44,7 @@ public function __construct(
     ) {
     }
 
-    public function search(ElementSearchInterface $elementSearch): ElementSearchResult
+    public function search(SearchInterface $elementSearch): ElementSearchResult
     {
         $elementSearch = $this->searchHelper->addSearchRestrictions($elementSearch);
 
diff --git a/src/Service/Search/SearchService/Element/ElementSearchServiceInterface.php b/src/Service/Search/SearchService/Element/ElementSearchServiceInterface.php
@@ -18,17 +18,17 @@
 
 use Pimcore\Bundle\GenericDataIndexBundle\Enum\SearchIndex\ElementType;
 use Pimcore\Bundle\GenericDataIndexBundle\Exception\ElementSearchException;
-use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Element\ElementSearchInterface;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Element\SearchResult\ElementSearchResult;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Interfaces\ElementSearchResultItemInterface;
+use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Interfaces\SearchInterface;
 use Pimcore\Model\User;
 
 interface ElementSearchServiceInterface
 {
     /**
      * @throws ElementSearchException
      */
-    public function search(ElementSearchInterface $elementSearch): ElementSearchResult;
+    public function search(SearchInterface $elementSearch): ElementSearchResult;
 
     /**
      * @throws ElementSearchException
diff --git a/src/Service/Search/SearchService/SearchProvider.php b/src/Service/Search/SearchService/SearchProvider.php
@@ -17,20 +17,18 @@
 namespace Pimcore\Bundle\GenericDataIndexBundle\Service\Search\SearchService;
 
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Asset\AssetSearch;
-use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Asset\AssetSearchInterface;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\DataObject\DataObjectSearch;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\DataObject\DataObjectSearchInterface;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Document\DocumentSearch;
-use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Document\DocumentSearchInterface;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Element\ElementSearch;
-use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Element\ElementSearchInterface;
+use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Interfaces\SearchInterface;
 
 /**
  * @internal
  */
 final class SearchProvider implements SearchProviderInterface
 {
-    public function createAssetSearch(): AssetSearchInterface
+    public function createAssetSearch(): SearchInterface
     {
         return new AssetSearch();
     }
@@ -40,12 +38,12 @@ public function createDataObjectSearch(): DataObjectSearchInterface
         return new DataObjectSearch();
     }
 
-    public function createDocumentSearch(): DocumentSearchInterface
+    public function createDocumentSearch(): SearchInterface
     {
         return new DocumentSearch();
     }
 
-    public function createElementSearch(): ElementSearchInterface
+    public function createElementSearch(): SearchInterface
     {
         return new ElementSearch();
     }
diff --git a/src/Service/Search/SearchService/SearchProviderInterface.php b/src/Service/Search/SearchService/SearchProviderInterface.php
@@ -16,18 +16,16 @@
 
 namespace Pimcore\Bundle\GenericDataIndexBundle\Service\Search\SearchService;
 
-use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Asset\AssetSearchInterface;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\DataObject\DataObjectSearchInterface;
-use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Document\DocumentSearchInterface;
-use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Element\ElementSearchInterface;
+use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Interfaces\SearchInterface;
 
 interface SearchProviderInterface
 {
-    public function createAssetSearch(): AssetSearchInterface;
+    public function createAssetSearch(): SearchInterface;
 
     public function createDataObjectSearch(): DataObjectSearchInterface;
 
-    public function createDocumentSearch(): DocumentSearchInterface;
+    public function createDocumentSearch(): SearchInterface;
 
-    public function createElementSearch(): ElementSearchInterface;
+    public function createElementSearch(): SearchInterface;
 }

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,6 @@`
`18`	`18`
`19`	`19`	`use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\BaseSearch;`
`20`	`20`
`21`		`-final class AssetSearch extends BaseSearch implements AssetSearchInterface`
	`21`	`+final class AssetSearch extends BaseSearch`
`22`	`22`	`{`
`23`	`23`	`}`