CultuurNet\UDB3\Search\ResultsGenerator

Complexity

Total Complexity

9

Size/Duplication

Total Lines	126
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes	2
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	14	1
A	withSorting()	0	6	1
A	getSorting()	0	4	1
A	withPageSize()	0	6	1
A	getPageSize()	0	4	1
B	search()	0	38	4

<?php

namespace CultuurNet\UDB3\Search;

use CultuurNet\UDB3\Offer\OfferIdentifierInterface;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use Psr\Log\NullLogger;

class ResultsGenerator implements LoggerAwareInterface, ResultsGeneratorInterface
{
    use LoggerAwareTrait;

    /**
     * Default sorting method because it's ideal for getting consistent paging
     * results.
     */
    const SORT_CREATION_DATE_ASC = 'creationdate asc';

    /**
     * @var SearchServiceInterface
     */
    private $searchService;

    /**
     * @var string
     */
    private $sorting;

    /**
     * @var int
     */
    private $pageSize;

    /**
     * @param SearchServiceInterface $searchService
     * @param string $sorting
     * @param int $pageSize
     */
    public function __construct(
        SearchServiceInterface $searchService,
        $sorting = self::SORT_CREATION_DATE_ASC,
        $pageSize = 10

The parameter $pageSize is not used and could be removed.

    ) {
        $this->searchService = $searchService;
        $this->sorting = $sorting;
        $this->pageSize = 10;

        // Set a default logger so we don't need to check if a logger is set
        // when we actually try to log something. This can easily be overridden
        // from outside as this method is public.
        $this->setLogger(new NullLogger());
    }

    /**
     * @param string $sorting
     * @return ResultsGenerator
     */
    public function withSorting($sorting)
    {
        $c = clone $this;
        $c->sorting = $sorting;
        return $c;
    }

    /**
     * @return string
     */
    public function getSorting()
    {
        return $this->sorting;
    }

    /**
     * @param string $pageSize
     * @return ResultsGenerator
     */
    public function withPageSize($pageSize)
    {
        $c = clone $this;
        $c->pageSize = $pageSize;

The property $pageSize was declared of type integer, but $pageSize is of type string. Maybe add a type cast?

        return $c;
    }

    /**
     * @return int
     */
    public function getPageSize()
    {
        return $this->pageSize;
    }

    /**
     * @param string $query
     * @return \Iterator
     */
    public function search($query)
    {
        $currentPage = 0;
        $ids = [];

        do {
            $results = $this->searchService->search(
                $query,
                $this->pageSize,
                $this->pageSize * $currentPage,
                $this->sorting
            );

            $total = $results->getTotalItems()->toNative();

            foreach ($results->getItems() as $item) {
                $id = $item->getId();

                if (!isset($ids[$id])) {
                    // Store result id with current page in case we run into
                    // the same id again later.
                    $ids[$id] = $currentPage;
                    yield $id => $item;
                } else {
                    $this->logger->error(
                        'query_duplicate_event',
                        array(
                            'query' => $query,
                            'error' => "Found duplicate offer {$id} on page {$currentPage}, " .
                                "occurred first time on page {$ids[$id]}."
                        )
                    );
                }
            }

            $currentPage++;
        } while ($currentPage < ceil($total / $this->pageSize));
    }
}