EZP-32110: Exposed more search result data from Pagefanta adapters

[adamwojs]

Question	Answer
JIRA issue	EZP-32110
Type	feature
Target eZ Platform version	v3.3
BC breaks	no
Doc needed	yes

Introduced \eZ\Publish\Core\Pagination\Pagerfanta\SearchResultAdapter

/**
 * Contract for \eZ\Publish\API\Repository\SearchService based adapters.
 */
interface SearchResultAdapter extends AdapterInterface
{
    /**
     * Get results of aggregations associated with search query.
     *
     * Generates addition query if called before AdapterInterface::getSlice or AdapterInterface::getNbResults.
     */
    public function getAggregations(): AggregationResultCollection;

    /**
     * Get the duration of the search processing for current results slice (in s).
     *
     * Returns null if called before AdapterInterface::getSlice.
     */
    public function getTime(): ?float;

    /**
     * Indicates if the search has timed out for current results slice.
     *
     * Returns null if called before AdapterInterface::getSlice.
     */
    public function getTimedOut(): ?bool;

    /**
     * Return the maximum score or `null` if query wasn't executed.
     *
     * Returns null if called before AdapterInterface::getSlice.
     */
    public function getMaxScore(): ?float;

in order to be able to access additional search result data

• Aggregations results
• Max. score
• Computation time
• Timeout flag

from Pagefanta. 

In practice this change allows to use additional search results data when rendering query using built-in query controller, ez_render_content_query/ez_render_location_query etc.

Example

Query controller

config/packages/ezplatform.yaml

ezplatform:
    site:
        content_view:
            full:
                folder:
                    controller: 'ez_query::pagingQueryAction'
                    template: full/folder.html.twig
                    match:
                        Identifier\ContentType: folder
                    params:
                        query:
                            query_type: Children
                            parameters:
                                location: '@=location'
                            assign_results_to: items

templates/full/folder.html.twig

{# Access SearchResult::$aggregations #}
{{ dump(items.aggregations) }}
{# Access  SearchResult::{$time,timedOut,maxScore}. Requires first to fetch result set #}
{{ dump(items.maxScore) }}
{{ dump(items.timedOut) }}
{{ dump(items.time) }}

Custom controller

<?php 

namespace App\Controller;

use eZ\Publish\API\Repository\SearchService;
use eZ\Publish\API\Repository\Values\Content\Query;
use eZ\Publish\Core\Pagination\Pagerfanta\ContentSearchAdapter;
use eZ\Publish\Core\Pagination\Pagerfanta\Pagerfanta;
use Symfony\Component\HttpFoundation\Response;

final class CustomController
{
    /** @var \eZ\Publish\API\Repository\SearchService */
    private $searchService;

    public function __construct(SearchService $searchService)
    {
        $this->searchService = $searchService;
    }

    public function searchAction(): Response
    {
        $query = new Query();
        // ... build query as usually

        // $items is instance of \eZ\Publish\Core\Pagination\Pagerfanta\Pagerfanta
        // instead of Pagerfanta\Pagerfanta
        $items = new Pagerfanta(new ContentSearchAdapter($query, $this->searchService));

        foreach ($items as $item) {
            // Iterate over results
        }

        // Access SearchResult::{$aggregations,maxScore,time,timedOUt}
        $items->getAggregations();
        $items->getMaxScore();
        $items->getTime();
        $items->getTimedOut();

        // ...
    }
}

Notes

• It's also possible to access additional search result data from regular Pagerfanta\Pagerfanta object by using $pagerfanta->getAdapter()->get{Aggregations,MaxScore,Time,TimedOut}
• Facets results are not exposed as they were deprecated in v3.2

Checklist:

• Provided PR description.
• Tested the solution manually.
• Provided automated test coverage.
• Checked that target branch is set correctly (master for features, the oldest supported for bugs).
• Ran PHP CS Fixer for new PHP code (use $ composer fix-cs).
• Asked for a review (ping @ezsystems/php-dev-team).

[sonarqubecloud]

SonarCloud Quality Gate failed.

0 Bugs
0 Vulnerabilities
0 Security Hotspots
4 Code Smells

No Coverage information
17.3% Duplication

[mikadamczyk]

Tests can be improved for duplication

[alongosz]

SonarCloud analysis is relevant. I don't see a point of having it if we gonna ignore it (as communicated/requested internally). But +1 anyway, with one remark.

[alongosz]

Looks like custom code consumes methods from this interface. In this case it should be API. Given the context - entire pagerfanta impl. - which shouldn't even be part of Kernel, I'll accept for now, especially due to time constraints. But if you have time, fix it please.