Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 8fb4056

Browse files
committedOct 7, 2024·
Revert "[BC] Introduce type specific interfaces (#224)"
This reverts commit 95ef63c.
1 parent 95ef63c commit 8fb4056

15 files changed

+23
-118
lines changed
 

‎doc/01_Installation/02_Upgrade.md

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,3 @@ Following steps are necessary during updating to newer versions.
66
- Execute the following command to reindex all elements to be able to use all new features:
77

88
```bin/console generic-data-index:update:index```
9-
10-
## Upgrade to 2.0.0
11-
12-
### BC-Breaks
13-
14-
#### Interface changes
15-
- Added `PermissionTypes $permissionType` parameter with default type `PermissionTypes::LIST` to
16-
- `AssetSearchServiceInterface::search` method
17-
- `DocumentSearchServiceInterface::search` method
18-
- `DataObjectSearchServiceInterface::search` method
19-
- `ElementSearchServiceInterface::search` method
20-
- Search services `byId` methods now return elements based on the `PermissionTypes::VIEW` permission
21-
- Added type specific interfaces for searches to avoid mixing up different search types in search services
22-
- `AssetSearch` now implements `AssetSearchInterface`
23-
- `DocumentSearch` now implements `DocumentSearchInterface`
24-
- `ElementSearch` now implements `ElementSearchInterface`
25-
- Search services now require the specific search type for the search
26-
- `AssetSearchServiceInterface::search` now requires a `AssetSearchInterface`
27-
- `DocumentSearchServiceInterface::search` now requires a `DocumentSearchInterface`
28-
- `ElementSearchServiceInterface::search` now requires a `ElementSearchInterface`
29-
- `SearchProviderInterface` now returns type specific search interfaces

‎src/Model/Search/Asset/AssetSearch.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,6 @@
1818

1919
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\BaseSearch;
2020

21-
final class AssetSearch extends BaseSearch implements AssetSearchInterface
21+
final class AssetSearch extends BaseSearch
2222
{
2323
}

‎src/Model/Search/Asset/AssetSearchInterface.php

Lines changed: 0 additions & 23 deletions
This file was deleted.

‎src/Model/Search/Document/DocumentSearch.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,6 @@
1818

1919
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\BaseSearch;
2020

21-
final class DocumentSearch extends BaseSearch implements DocumentSearchInterface
21+
final class DocumentSearch extends BaseSearch
2222
{
2323
}

‎src/Model/Search/Document/DocumentSearchInterface.php

Lines changed: 0 additions & 23 deletions
This file was deleted.

‎src/Model/Search/Element/ElementSearch.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,6 @@
1818

1919
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\BaseSearch;
2020

21-
final class ElementSearch extends BaseSearch implements ElementSearchInterface
21+
final class ElementSearch extends BaseSearch
2222
{
2323
}

‎src/Model/Search/Element/ElementSearchInterface.php

Lines changed: 0 additions & 23 deletions
This file was deleted.

‎src/Service/Search/SearchService/Asset/AssetSearchService.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@
1919
use Exception;
2020
use Pimcore\Bundle\GenericDataIndexBundle\Enum\Permission\UserPermissionTypes;
2121
use Pimcore\Bundle\GenericDataIndexBundle\Exception\AssetSearchException;
22-
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Asset\AssetSearchInterface;
2322
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Asset\SearchResult\AssetSearchResult;
2423
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Asset\SearchResult\AssetSearchResultItem;
24+
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Interfaces\SearchInterface;
2525
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Basic\IdFilter;
2626
use Pimcore\Bundle\GenericDataIndexBundle\Permission\Workspace\AssetWorkspace;
2727
use Pimcore\Bundle\GenericDataIndexBundle\SearchIndexAdapter\Search\Pagination\PaginationInfoServiceInterface;
@@ -47,7 +47,7 @@ public function __construct(
4747
/**
4848
* @throws AssetSearchException
4949
*/
50-
public function search(AssetSearchInterface $assetSearch): AssetSearchResult
50+
public function search(SearchInterface $assetSearch): AssetSearchResult
5151
{
5252
$assetSearch = $this->searchHelper->addSearchRestrictions(
5353
search: $assetSearch,

‎src/Service/Search/SearchService/Asset/AssetSearchServiceInterface.php

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,17 @@
1717
namespace Pimcore\Bundle\GenericDataIndexBundle\Service\Search\SearchService\Asset;
1818

1919
use Pimcore\Bundle\GenericDataIndexBundle\Exception\AssetSearchException;
20-
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Asset\AssetSearchInterface;
2120
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Asset\SearchResult\AssetSearchResult;
2221
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Asset\SearchResult\AssetSearchResultItem;
23-
22+
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Interfaces\SearchInterface;
2423
use Pimcore\Model\User;
2524

2625
interface AssetSearchServiceInterface
2726
{
2827
/**
2928
* @throws AssetSearchException
3029
*/
31-
public function search(AssetSearchInterface $assetSearch): AssetSearchResult;
30+
public function search(SearchInterface $assetSearch): AssetSearchResult;
3231

3332
/**
3433
* @throws AssetSearchException

‎src/Service/Search/SearchService/Document/DocumentSearchService.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@
1919
use Exception;
2020
use Pimcore\Bundle\GenericDataIndexBundle\Enum\Permission\UserPermissionTypes;
2121
use Pimcore\Bundle\GenericDataIndexBundle\Exception\DocumentSearchException;
22-
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Document\DocumentSearchInterface;
2322
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Document\SearchResult\DocumentSearchResult;
2423
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Document\SearchResult\DocumentSearchResultItem;
24+
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Interfaces\SearchInterface;
2525
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Modifier\Filter\Basic\IdFilter;
2626
use Pimcore\Bundle\GenericDataIndexBundle\Permission\Workspace\DocumentWorkspace;
2727
use Pimcore\Bundle\GenericDataIndexBundle\SearchIndexAdapter\Search\Pagination\PaginationInfoServiceInterface;
@@ -47,7 +47,7 @@ public function __construct(
4747
/**
4848
* @throws DocumentSearchException
4949
*/
50-
public function search(DocumentSearchInterface $documentSearch): DocumentSearchResult
50+
public function search(SearchInterface $documentSearch): DocumentSearchResult
5151
{
5252
$documentSearch = $this->searchHelper->addSearchRestrictions(
5353
search: $documentSearch,

‎src/Service/Search/SearchService/Document/DocumentSearchServiceInterface.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,17 @@
1717
namespace Pimcore\Bundle\GenericDataIndexBundle\Service\Search\SearchService\Document;
1818

1919
use Pimcore\Bundle\GenericDataIndexBundle\Exception\DocumentSearchException;
20-
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Document\DocumentSearchInterface;
2120
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Document\SearchResult\DocumentSearchResult;
2221
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Document\SearchResult\DocumentSearchResultItem;
22+
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Interfaces\SearchInterface;
2323
use Pimcore\Model\User;
2424

2525
interface DocumentSearchServiceInterface
2626
{
2727
/**
2828
* @throws DocumentSearchException
2929
*/
30-
public function search(DocumentSearchInterface $documentSearch): DocumentSearchResult;
30+
public function search(SearchInterface $documentSearch): DocumentSearchResult;
3131

3232
/**
3333
* @throws DocumentSearchException

‎src/Service/Search/SearchService/Element/ElementSearchService.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@
1919
use Exception;
2020
use Pimcore\Bundle\GenericDataIndexBundle\Enum\SearchIndex\ElementType;
2121
use Pimcore\Bundle\GenericDataIndexBundle\Exception\ElementSearchException;
22-
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Element\ElementSearchInterface;
2322
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Element\SearchResult\ElementSearchResult;
2423
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Interfaces\ElementSearchResultItemInterface;
24+
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Interfaces\SearchInterface;
2525
use Pimcore\Bundle\GenericDataIndexBundle\SearchIndexAdapter\Search\Pagination\PaginationInfoServiceInterface;
2626
use Pimcore\Bundle\GenericDataIndexBundle\Service\Search\SearchService\Asset\AssetSearchServiceInterface;
2727
use Pimcore\Bundle\GenericDataIndexBundle\Service\Search\SearchService\DataObject\DataObjectSearchServiceInterface;
@@ -44,7 +44,7 @@ public function __construct(
4444
) {
4545
}
4646

47-
public function search(ElementSearchInterface $elementSearch): ElementSearchResult
47+
public function search(SearchInterface $elementSearch): ElementSearchResult
4848
{
4949
$elementSearch = $this->searchHelper->addSearchRestrictions($elementSearch);
5050

‎src/Service/Search/SearchService/Element/ElementSearchServiceInterface.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,17 @@
1818

1919
use Pimcore\Bundle\GenericDataIndexBundle\Enum\SearchIndex\ElementType;
2020
use Pimcore\Bundle\GenericDataIndexBundle\Exception\ElementSearchException;
21-
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Element\ElementSearchInterface;
2221
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Element\SearchResult\ElementSearchResult;
2322
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Interfaces\ElementSearchResultItemInterface;
23+
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Interfaces\SearchInterface;
2424
use Pimcore\Model\User;
2525

2626
interface ElementSearchServiceInterface
2727
{
2828
/**
2929
* @throws ElementSearchException
3030
*/
31-
public function search(ElementSearchInterface $elementSearch): ElementSearchResult;
31+
public function search(SearchInterface $elementSearch): ElementSearchResult;
3232

3333
/**
3434
* @throws ElementSearchException

‎src/Service/Search/SearchService/SearchProvider.php

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,20 +17,18 @@
1717
namespace Pimcore\Bundle\GenericDataIndexBundle\Service\Search\SearchService;
1818

1919
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Asset\AssetSearch;
20-
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Asset\AssetSearchInterface;
2120
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\DataObject\DataObjectSearch;
2221
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\DataObject\DataObjectSearchInterface;
2322
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Document\DocumentSearch;
24-
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Document\DocumentSearchInterface;
2523
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Element\ElementSearch;
26-
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Element\ElementSearchInterface;
24+
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Interfaces\SearchInterface;
2725

2826
/**
2927
* @internal
3028
*/
3129
final class SearchProvider implements SearchProviderInterface
3230
{
33-
public function createAssetSearch(): AssetSearchInterface
31+
public function createAssetSearch(): SearchInterface
3432
{
3533
return new AssetSearch();
3634
}
@@ -40,12 +38,12 @@ public function createDataObjectSearch(): DataObjectSearchInterface
4038
return new DataObjectSearch();
4139
}
4240

43-
public function createDocumentSearch(): DocumentSearchInterface
41+
public function createDocumentSearch(): SearchInterface
4442
{
4543
return new DocumentSearch();
4644
}
4745

48-
public function createElementSearch(): ElementSearchInterface
46+
public function createElementSearch(): SearchInterface
4947
{
5048
return new ElementSearch();
5149
}

‎src/Service/Search/SearchService/SearchProviderInterface.php

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,16 @@
1616

1717
namespace Pimcore\Bundle\GenericDataIndexBundle\Service\Search\SearchService;
1818

19-
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Asset\AssetSearchInterface;
2019
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\DataObject\DataObjectSearchInterface;
21-
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Document\DocumentSearchInterface;
22-
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Element\ElementSearchInterface;
20+
use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Interfaces\SearchInterface;
2321

2422
interface SearchProviderInterface
2523
{
26-
public function createAssetSearch(): AssetSearchInterface;
24+
public function createAssetSearch(): SearchInterface;
2725

2826
public function createDataObjectSearch(): DataObjectSearchInterface;
2927

30-
public function createDocumentSearch(): DocumentSearchInterface;
28+
public function createDocumentSearch(): SearchInterface;
3129

32-
public function createElementSearch(): ElementSearchInterface;
30+
public function createElementSearch(): SearchInterface;
3331
}

0 commit comments

Comments
 (0)
Please sign in to comment.