ResultsGenerator::withSorting() - Code Metrics - Inspection of "III-808 Implemented the manipulates for label and..." - cultuurnet/udb3-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#135)

by Kristof

created 2016-03-03 20:20 UTC

ResultsGenerator::withSorting() A

↳ Parent: ResultsGenerator

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	6
rs	9.4285
cc	1
eloc	4
nc	1
nop	1

<?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

    ) {
        $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;
$answer = 42;

$correct = false;

$correct = (bool) $answer;
        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));
    }
}


1			<?php
2
3			namespace CultuurNet\UDB3\Search;
4
5			use CultuurNet\UDB3\Offer\OfferIdentifierInterface;
6			use Psr\Log\LoggerAwareInterface;
7			use Psr\Log\LoggerAwareTrait;
8			use Psr\Log\NullLogger;
9
10			class ResultsGenerator implements LoggerAwareInterface, ResultsGeneratorInterface
11			{
12			use LoggerAwareTrait;
13
14			/**
15			* Default sorting method because it's ideal for getting consistent paging
16			* results.
17			*/
18			const SORT_CREATION_DATE_ASC = 'creationdate asc';
19
20			/**
21			* @var SearchServiceInterface
22			*/
23			private $searchService;
24
25			/**
26			* @var string
27			*/
28			private $sorting;
29
30			/**
31			* @var int
32			*/
33			private $pageSize;
34
35			/**
36			* @param SearchServiceInterface $searchService
37			* @param string $sorting
38			* @param int $pageSize
39			*/
40			public function __construct(
41			SearchServiceInterface $searchService,
42			$sorting = self::SORT_CREATION_DATE_ASC,
43			$pageSize = 10
			0 ignored issues – show Unused Code introduced 2016-02-24 14:21 UTC by Report Bug Copy Issue Report The parameter `$pageSize` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
44			) {
45			$this->searchService = $searchService;
46			$this->sorting = $sorting;
47			$this->pageSize = 10;
48
49			// Set a default logger so we don't need to check if a logger is set
50			// when we actually try to log something. This can easily be overridden
51			// from outside as this method is public.
52			$this->setLogger(new NullLogger());
53			}
54
55			/**
56			* @param string $sorting
57			* @return ResultsGenerator
58			*/
59			public function withSorting($sorting)
60			{
61			$c = clone $this;
62			$c->sorting = $sorting;
63			return $c;
64			}
65
66			/**
67			* @return string
68			*/
69			public function getSorting()
70			{
71			return $this->sorting;
72			}
73
74			/**
75			* @param string $pageSize
76			* @return ResultsGenerator
77			*/
78			public function withPageSize($pageSize)
79			{
80			$c = clone $this;
81			$c->pageSize = $pageSize;
			0 ignored issues – show Documentation Bug introduced 2016-02-24 14:21 UTC by Report Bug Copy Issue Report The property `$pageSize` was declared of type `integer`, but `$pageSize` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
82			return $c;
83			}
84
85			/**
86			* @return int
87			*/
88			public function getPageSize()
89			{
90			return $this->pageSize;
91			}
92
93			/**
94			* @param string $query
95			* @return \Iterator
96			*/
97			public function search($query)
98			{
99			$currentPage = 0;
100			$ids = [];
101
102			do {
103			$results = $this->searchService->search(
104			$query,
105			$this->pageSize,
106			$this->pageSize * $currentPage,
107			$this->sorting
108			);
109
110			$total = $results->getTotalItems()->toNative();
111
112			foreach ($results->getItems() as $item) {
113			$id = $item->getId();
114
115			if (!isset($ids[$id])) {
116			// Store result id with current page in case we run into
117			// the same id again later.
118			$ids[$id] = $currentPage;
119			yield $id => $item;
120			} else {
121			$this->logger->error(
122			'query_duplicate_event',
123			array(
124			'query' => $query,
125			'error' => "Found duplicate offer {$id} on page {$currentPage}, " .
126			"occurred first time on page {$ids[$id]}."
127			)
128			);
129			}
130			}
131
132			$currentPage++;
133			} while ($currentPage < ceil($total / $this->pageSize));
134			}
135			}
136

cultuurnet / udb3-php

Pull Request — master (#135)

ResultsGenerator::withSorting() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like