KGzocha\Searcher\Result\ResultCollection

Complexity

Total Complexity

9

Size/Duplication

Total Lines	64
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	2
A	getResults()	0	4	1
A	count()	0	4	1
A	jsonSerialize()	0	4	1
A	getIterator()	0	4	1
A	canUseResults()	0	5	3

<?php

namespace KGzocha\Searcher\Result;

/**
 * Can be used to hold results from searching when developer is not 100% sure
 * if searching process will return array of objects or a number, or null, or whatever.
 * This class regardless the constructor will always be iteratable, so in worse case scenario
 * there will be no results inside, but your controllers will still work.
 * It's not recommended to use it on development environment due to eventual problems with debugging.
 *
 * @author Krzysztof Gzocha <krzysztof@propertyfinder.ae>
 */
class ResultCollection implements ResultCollectionInterface
{
    /**
     * @var \Traversable|array
     */
    private $results;

    /**
     * @param \Traversable|array $results
     */
    public function __construct($results = [])
    {
        if ($this->canUseResults($results)) {
            $this->results = $results;

            return;
        }

        $this->results = [];
    }

    /**
     * {@inheritdoc}
     */
    public function getResults()
    {
        return $this->results;
    }

    /**
     * {@inheritdoc}
     */
    public function count()
    {
        return count($this->results);
    }

    /**
     * {@inheritdoc}
     */
    public function jsonSerialize()
    {
        return $this->results;
    }

    /**
     * {@inheritdoc}
     */
    public function getIterator()
    {
        return new \ArrayIterator($this->results);
    }

    /**
     * @param \Traversable|array $results
     *
     * @return bool
     */
    private function canUseResults($results = [])
    {
        return is_array($results)
            || (is_object($results) && $results instanceof \Traversable);
    }
}