spryker / spryker-core

Bundles/ProductReview/src/Spryker/Client/ProductReview/Search/ProductReviewSearchReader.php

<?php

/**
 * Copyright © 2016-present Spryker Systems GmbH. All rights reserved.
 * Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.
 */

namespace Spryker\Client\ProductReview\Search;

use Generated\Shared\Transfer\ProductReviewSearchRequestTransfer;
use Spryker\Client\ProductReview\Dependency\Client\ProductReviewToSearchInterface;
use Spryker\Client\Search\Dependency\Plugin\QueryInterface;

class ProductReviewSearchReader implements ProductReviewSearchReaderInterface
{
    /**
     * @var \Spryker\Client\Search\Dependency\Plugin\QueryInterface
     */
    protected $searchQueryPlugin;

    /**
     * @var \Spryker\Client\ProductReview\Dependency\Client\ProductReviewToSearchInterface
     */
    protected $searchClient;

    /**
     * @var array<\Spryker\Client\Search\Dependency\Plugin\ResultFormatterPluginInterface>
     */
    protected $searchResultFormatterPlugins;

    /**
     * @param \Spryker\Client\Search\Dependency\Plugin\QueryInterface $productReviewsQueryPlugin
     * @param \Spryker\Client\ProductReview\Dependency\Client\ProductReviewToSearchInterface $searchClient
     * @param array<\Spryker\Client\Search\Dependency\Plugin\ResultFormatterPluginInterface> $searchResultFormatterPlugins
     */
    public function __construct(
        QueryInterface $productReviewsQueryPlugin,
        ProductReviewToSearchInterface $searchClient,
        array $searchResultFormatterPlugins
    ) {
        $this->searchQueryPlugin = $productReviewsQueryPlugin;
        $this->searchClient = $searchClient;
        $this->searchResultFormatterPlugins = $searchResultFormatterPlugins;
    }

    /**
     * @param \Generated\Shared\Transfer\ProductReviewSearchRequestTransfer $productReviewSearchRequestTransfer
     *
     * @return array
     */
    public function findProductReviews(ProductReviewSearchRequestTransfer $productReviewSearchRequestTransfer): array
    {
        return $this->searchClient->search(

The expression return $this->searchClient->search($this->searchQueryPlugin, $this->searchResultFormatterPlugins, $productReviewSearchRequestTransfer->getRequestParams()) could return the type Elastica\ResultSet which is incompatible with the type-hinted return array. Consider adding an additional type-check to rule them out.

            $this->searchQueryPlugin,
            $this->searchResultFormatterPlugins,
            $productReviewSearchRequestTransfer->getRequestParams(),
        );
    }

    /**
     * @return \Elastica\ResultSet|mixed|array
     */
    public function searchProductReviews()
    {
        return $this->searchClient->search(
            $this->searchQueryPlugin,
            $this->searchResultFormatterPlugins,
        );
    }
}