CultuurNet\UDB3\Search\PullParsingSearchService

Complexity

Total Complexity

9

Size/Duplication

Total Lines	135
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	10

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	13	2
A	search()	0	8	1
A	doNotIncludePrivateItems()	0	6	1
B	executeSearch()	0	30	3
A	getPullParser()	0	12	2

<?php

namespace CultuurNet\UDB3\Search;

use CultuurNet\Search\Parameter;
use CultuurNet\UDB3\Iri\IriGeneratorInterface;
use CultuurNet\UDB3\SearchAPI2;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;

/**
 * SearchServiceInterface implementation that uses Search API 2 and parses
 * results with a XML pull parser, decreasing the memory usage and improving
 * speed.
 */
class PullParsingSearchService implements SearchServiceInterface
{
    /**
     * @var SearchAPI2\ResultSetPullParser
     */
    protected $pullParser;

    /**
     * @var SearchAPI2\SearchServiceInterface
     */
    protected $searchAPI2;

    /**
     * @var IriGeneratorInterface
     */
    protected $eventIriGenerator;

    /**
     * @var IriGeneratorInterface
     */
    protected $placeIriGenerator;

    /**
     * @var LoggerInterface
     */
    protected $resultParserLogger;

    /**
     * @var bool
     */
    protected $includePrivateItems;

    /**
     * @param SearchAPI2\SearchServiceInterface $search
     * @param IriGeneratorInterface $eventIriGenerator
     * @param IriGeneratorInterface $placeIriGenerator
     * @param LoggerInterface|null $resultParserLogger
     */
    public function __construct(
        SearchAPI2\SearchServiceInterface $search,
        IriGeneratorInterface $eventIriGenerator,
        IriGeneratorInterface $placeIriGenerator,
        LoggerInterface $resultParserLogger = null
    ) {
        $this->searchAPI2 = $search;
        $this->eventIriGenerator = $eventIriGenerator;
        $this->placeIriGenerator = $placeIriGenerator;
        $this->resultParserLogger = $resultParserLogger ? $resultParserLogger : new NullLogger();

        $this->includePrivateItems = true;
    }

    /**
     * {@inheritdoc}
     */
    public function search($query, $limit = 30, $start = 0, $sort = null)
    {
        $response = $this->executeSearch($query, $limit, $start, $sort);

        $parser = $this->getPullParser();

        return $parser->getResultSet($response->getBody(true));
    }

    /**
     * @return PullParsingSearchService
     */
    public function doNotIncludePrivateItems()
    {
        $copy = clone $this;
        $copy->includePrivateItems = false;
        return $copy;
    }

    /**
     * Finds items matching an arbitrary query.
     *
     *  @param string $query
     *   An arbitrary query.
     * @param int $limit
     *   How many items to retrieve.
     * @param int $start
     *   Offset to start from.
     * @param string $sort
     *   Sorting to use.
     *
     * @return \Guzzle\Http\Message\Response
     */
    private function executeSearch($query, $limit, $start, $sort = null)
    {
        $qParam = new Parameter\Query($query);
        $groupParam = new Parameter\Group();
        $startParam = new Parameter\Start($start);
        $limitParam = new Parameter\Rows($limit);
        $typeParam = new Parameter\FilterQuery('type:event OR (type:actor AND category_id:8.15.0.0.0)');

        $params = array(
            $qParam,
            $groupParam,
            $limitParam,
            $startParam,
            $typeParam,
        );

        if ($this->includePrivateItems) {
            $privateParam = new Parameter\FilterQuery('private:*');

            $params[] = $privateParam;
        }

        if ($sort) {

The expression $sort of type string|null is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

            $params[] = new Parameter\Parameter('sort', $sort);
        }

        $response = $this->searchAPI2->search($params);

$params is of type array<integer,object<CultuurNet\Search\Parameter\Query>|object<CultuurNet\Search\Parameter\Group>|object<CultuurNet\Search\Parameter\Rows>|object<CultuurNet\Search\Parameter\Start>|object<CultuurNet\Search\Parameter\FilterQuery>|object<CultuurNet\Search\Parameter\Parameter>>, but the function expects a array<integer,object<CultuurNet\Search\Parameter\Parameter>>.

        return $response;
    }

    /**
     * @return SearchAPI2\ResultSetPullParser
     */
    protected function getPullParser()
    {
        if (!$this->pullParser) {
            $this->pullParser = new SearchAPI2\ResultSetPullParser(
                new \XMLReader(),
                $this->eventIriGenerator,
                $this->placeIriGenerator
            );
            $this->pullParser->setLogger($this->resultParserLogger);
        }
        return $this->pullParser;
    }
}