IBX-5111: Introduced custom find and result extracting capabilities

src/bundle/Core/ApiLoader/RepositoryFactory.php

@@ -76,6 +76,7 @@ public function buildRepository(
         PersistenceHandler $persistenceHandler,
         SearchHandler $searchHandler,
         BackgroundIndexer $backgroundIndexer,
+        Mapper\SearchHitMapperRegistryInterface $searchHitMapperRegistry,
         RelationProcessor $relationProcessor,
         FieldTypeRegistry $fieldTypeRegistry,
         PasswordHashService $passwordHashService,
@@ -99,6 +100,7 @@ public function buildRepository(
             $persistenceHandler,
             $searchHandler,
             $backgroundIndexer,
+            $searchHitMapperRegistry,
             $relationProcessor,
             $fieldTypeRegistry,
             $passwordHashService,

src/contracts/Repository/Decorator/SearchServiceDecorator.php

@@ -14,23 +14,32 @@
 use Ibexa\Contracts\Core\Repository\Values\Content\Query;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion;
 use Ibexa\Contracts\Core\Repository\Values\Content\Search\SearchResult;
+use Ibexa\Contracts\Core\Repository\Values\Search\SearchContextInterface;
 
 abstract class SearchServiceDecorator implements SearchService
 {
-    /** @var \Ibexa\Contracts\Core\Repository\SearchService */
-    protected $innerService;
+    protected SearchService $innerService;
 
     public function __construct(SearchService $innerService)
     {
         $this->innerService = $innerService;
     }
 
+    public function find(Query $query, SearchContextInterface $context = null): SearchResult
+    {
+        return $this->innerService->find($query, $context);
+    }
+
     public function findContent(
         Query $query,
         array $languageFilter = [],
         bool $filterOnUserPermissions = true
     ): SearchResult {
-        return $this->innerService->findContent($query, $languageFilter, $filterOnUserPermissions);
+        return $this->innerService->findContent(
+            $query,
+            $languageFilter,
+            $filterOnUserPermissions
+        );
     }
 
     public function findContentInfo(

src/contracts/Repository/SearchService.php

@@ -13,6 +13,7 @@
 use Ibexa\Contracts\Core\Repository\Values\Content\Query;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion;
 use Ibexa\Contracts\Core\Repository\Values\Content\Search\SearchResult;
+use Ibexa\Contracts\Core\Repository\Values\Search\SearchContextInterface;
 
 /**
  * Search service.
@@ -114,6 +115,8 @@ interface SearchService
      */
     public const CAPABILITY_AGGREGATIONS = 128;
 
+    public function find(Query $query, SearchContextInterface $context = null): SearchResult;
+
     /**
      * Finds content objects for the given query.
      *

src/contracts/Repository/Values/Search/SearchContext.php

@@ -0,0 +1,62 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Contracts\Core\Repository\Values\Search;
+
+final class SearchContext implements SearchContextInterface
+{
+    /** @var array{}|array{languages: array<string>, useAlwaysAvailable: bool} */
+    private array $languageFilter;
+
+    private bool $filterOnUserPermissions;
+
+    /** @var array<string> */
+    private array $documentTypeIdentifiers;
+
+    /**
+     * @param array{}|array{languages: array<string>, useAlwaysAvailable: bool} $languageFilter
+     * @param array<string> $documentTypeIdentifiers
+     */
+    public function __construct(
+        array $languageFilter = [],
+        bool $filterOnUserPermissions = true,
+        array $documentTypeIdentifiers = []
+    ) {
+        $this->languageFilter = $languageFilter;
+        $this->filterOnUserPermissions = $filterOnUserPermissions;
+        $this->documentTypeIdentifiers = $documentTypeIdentifiers;
+    }
+
+    public function setLanguageFilter(array $languageFilter): void
+    {
+        $this->languageFilter = $languageFilter;
+    }
+
+    public function getLanguageFilter(): array
+    {
+        return $this->languageFilter;
+    }
+
+    public function setFilterOnUserPermissions(bool $filterOnUserPermissions): void
+    {
+        $this->filterOnUserPermissions = $filterOnUserPermissions;
+    }
+
+    public function doesFilterOnUserPermissions(): bool
+    {
+        return $this->filterOnUserPermissions;
+    }
+
+    /**
+     * @return array<string>
+     */
+    public function getDocumentTypeIdentifiers(): array
+    {
+        return $this->documentTypeIdentifiers;
+    }
+}

src/contracts/Repository/Values/Search/SearchContextInterface.php

@@ -0,0 +1,31 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Contracts\Core\Repository\Values\Search;
+
+interface SearchContextInterface
+{
+    /**
+     * @param array{}|array{languages: array<string>, useAlwaysAvailable: bool} $languageFilter
+     */
+    public function setLanguageFilter(array $languageFilter): void;
+
+    /**
+     * @return array{}|array{languages: array<string>, useAlwaysAvailable: bool}
+     */
+    public function getLanguageFilter(): array;
+
+    public function setFilterOnUserPermissions(bool $filterOnUserPermissions): void;
+
+    public function doesFilterOnUserPermissions(): bool;
+
+    /**
+     * @return array<string>
+     */
+    public function getDocumentTypeIdentifiers(): array;
+}

src/contracts/Search/Handler.php

@@ -11,13 +11,21 @@
 use Ibexa\Contracts\Core\Repository\Values\Content\LocationQuery;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion;
+use Ibexa\Contracts\Core\Repository\Values\Search\SearchContextInterface;
 
 /**
  * The Search handler retrieves sets of of Content objects, based on a
  * set of criteria.
  */
 interface Handler
 {
+    /**
+     * Finds objects for the given query.
+     *
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\InvalidArgumentException if Query criterion is not applicable to its target
+     */
+    public function find(Query $query, SearchContextInterface $context = null);
+
     /**
      * Finds content objects for the given query.
      *

src/lib/Base/Container/ApiLoader/RepositoryFactory.php

@@ -21,6 +21,7 @@
 use Ibexa\Core\FieldType\FieldTypeRegistry;
 use Ibexa\Core\Repository\Helper\RelationProcessor;
 use Ibexa\Core\Repository\Mapper;
+use Ibexa\Core\Repository\Mapper\SearchHitMapperRegistryInterface;
 use Ibexa\Core\Repository\Permission\LimitationService;
 use Ibexa\Core\Repository\ProxyFactory\ProxyDomainMapperFactoryInterface;
 use Ibexa\Core\Repository\User\PasswordValidatorInterface;
@@ -67,6 +68,7 @@ public function buildRepository(
         PersistenceHandler $persistenceHandler,
         SearchHandler $searchHandler,
         BackgroundIndexer $backgroundIndexer,
+        SearchHitMapperRegistryInterface $searchHitMapperRegistry,
         RelationProcessor $relationProcessor,
         FieldTypeRegistry $fieldTypeRegistry,
         PasswordHashService $passwordHashService,
@@ -89,6 +91,7 @@ public function buildRepository(
             $persistenceHandler,
             $searchHandler,
             $backgroundIndexer,
+            $searchHitMapperRegistry,
             $relationProcessor,
             $fieldTypeRegistry,
             $passwordHashService,

src/lib/Repository/Mapper/ContentDomainMapper.php

@@ -24,9 +24,11 @@
 use Ibexa\Contracts\Core\Repository\Values\Content\ContentInfo;
 use Ibexa\Contracts\Core\Repository\Values\Content\Field;
 use Ibexa\Contracts\Core\Repository\Values\Content\Location as APILocation;
+use Ibexa\Contracts\Core\Repository\Values\Content\Search\SearchHit;
 use Ibexa\Contracts\Core\Repository\Values\Content\Search\SearchResult;
 use Ibexa\Contracts\Core\Repository\Values\Content\VersionInfo as APIVersionInfo;
 use Ibexa\Contracts\Core\Repository\Values\ContentType\ContentType;
+use Ibexa\Contracts\Core\Repository\Values\Search\SearchContextInterface;
 use Ibexa\Core\Base\Exceptions\InvalidArgumentException;
 use Ibexa\Core\Base\Exceptions\InvalidArgumentType;
 use Ibexa\Core\Base\Exceptions\InvalidArgumentValue;
@@ -46,7 +48,7 @@
  *
  * @internal Meant for internal use by Repository.
  */
-class ContentDomainMapper extends ProxyAwareDomainMapper implements LoggerAwareInterface
+class ContentDomainMapper extends ProxyAwareDomainMapper implements LoggerAwareInterface, SearchHitMapperInterface
 {
     use LoggerAwareTrait;
 
@@ -610,8 +612,8 @@ public function buildContentDomainObjectsOnSearchResult(SearchResult $result, ar
             $info = $hit->valueObject;
             $contentIds[] = $info->id;
             $contentTypeIds[] = $info->contentTypeId;
-            // Unless we are told to load all languages, we add main language to translations so they are loaded too
-            // Might in some case load more languages then intended, but prioritised handling will pick right one
+            // Unless we are told to load all languages, we add main language to translations, so they are loaded too
+            // Might in some case load more languages than intended, but prioritised handling will pick right one
             if (!empty($languageFilter['languages']) && $useAlwaysAvailable && $info->alwaysAvailable) {
                 $translations[] = $info->mainLanguageCode;
             }
@@ -893,6 +895,52 @@ private function isRootLocation(SPILocation $spiLocation): bool
     {
         return $spiLocation->id === $spiLocation->parentId;
     }
+
+    public function buildObjectOnSearchHit(SearchHit $hit, SearchContextInterface $context = null)
+    {
+        return $this->buildContentDomainObjectsOnSearchHit($hit, $context);
+    }
+
+    public function supports(SearchHit $hit, SearchContextInterface $context = null): bool
+    {
+        return $hit->valueObject instanceof SPIContent\ContentInfo;
+    }
+
+    private function buildContentDomainObjectsOnSearchHit(SearchHit $hit, SearchContextInterface $context = null): ?Content
+    {
+        /** @var \Ibexa\Contracts\Core\Persistence\Content\ContentInfo $info */
+        $info = $hit->valueObject;
+        $languageFilter = [];
+
+        if ($context !== null) {
+            $languageFilter = $context->getLanguageFilter();
+        }
+
+        $translations = $languageFilter['languages'] ?? [];
+        $useAlwaysAvailable = $languageFilter['useAlwaysAvailable'] ?? true;
+
+        if (!empty($languageFilter['languages']) && $useAlwaysAvailable && $info->alwaysAvailable) {
+            $translations[] = $info->mainLanguageCode;
+        }
+
+        try {
+            $content = $this->contentHandler->load($info->id, null, $translations);
+            $contentType = $this->contentTypeHandler->load($info->contentTypeId);
+            $languages = $languageFilter['languages'] ?? [];
+
+            return $this->buildContentDomainObject(
+                $content,
+                $this->contentTypeDomainMapper->buildContentTypeDomainObject(
+                    $contentType,
+                    $languages
+                ),
+                $languages,
+                $useAlwaysAvailable ? $info->mainLanguageCode : null
+            );
+        } catch (NotFoundException $e) {
+            return null;
+        }
+    }
 }
 
 class_alias(ContentDomainMapper::class, 'eZ\Publish\Core\Repository\Mapper\ContentDomainMapper');

src/lib/Repository/Mapper/SearchHitMapperInterface.php

@@ -0,0 +1,20 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+namespace Ibexa\Core\Repository\Mapper;
+
+use Ibexa\Contracts\Core\Repository\Values\Content\Search\SearchHit;
+use Ibexa\Contracts\Core\Repository\Values\Search\SearchContextInterface;
+
+interface SearchHitMapperInterface
+{
+    /**
+     * @return mixed
+     */
+    public function buildObjectOnSearchHit(SearchHit $hit, SearchContextInterface $context = null);
+
+    public function supports(SearchHit $hit, SearchContextInterface $context = null): bool;
+}

src/lib/Repository/Mapper/SearchHitMapperRegistry.php

@@ -0,0 +1,56 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+namespace Ibexa\Core\Repository\Mapper;
+
+use Ibexa\Contracts\Core\Repository\Values\Content\Search\SearchHit;
+use Ibexa\Core\Base\Exceptions\InvalidArgumentException;
+
+final class SearchHitMapperRegistry implements SearchHitMapperRegistryInterface
+{
+    /** @var iterable<\Ibexa\Core\Repository\Mapper\SearchHitMapperInterface> */
+    private iterable $mappers;
+
+    /**
+     * @param iterable<\Ibexa\Core\Repository\Mapper\SearchHitMapperInterface> $mappers
+     */
+    public function __construct(iterable $mappers)
+    {
+        $this->mappers = $mappers;
+    }
+
+    public function hasMapper(SearchHit $hit): bool
+    {
+        return $this->findMappers($hit) !== null;
+    }
+
+    public function getMapper(SearchHit $hit): SearchHitMapperInterface
+    {
+        if (!$this->hasMapper($hit)) {
+            throw new InvalidArgumentException(
+                '$hit',
+                sprintf(
+                    'undefined %s for search hit %s',
+                    SearchHitMapperInterface::class,
+                    get_debug_type($hit->valueObject)
+                )
+            );
+        }
+
+        return $this->findMappers($hit);
+    }
+
+    private function findMappers(SearchHit $hit): ?SearchHitMapperInterface
+    {
+        foreach ($this->mappers as $mapper) {
+            if ($mapper->supports($hit)) {
+                return $mapper;
+            }
+        }
+
+        return null;
+    }
+}

src/lib/Repository/Mapper/SearchHitMapperRegistryInterface.php

@@ -0,0 +1,16 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+namespace Ibexa\Core\Repository\Mapper;
+
+use Ibexa\Contracts\Core\Repository\Values\Content\Search\SearchHit;
+
+interface SearchHitMapperRegistryInterface
+{
+    public function hasMapper(SearchHit $hit): bool;
+
+    public function getMapper(SearchHit $hit): SearchHitMapperInterface;
+}