Bardex\Elastic\SearchResult

Complexity

Total Complexity

13

Size/Duplication

Total Lines	114
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getFirst()	0	8	2
A	getResults()	0	4	1
A	count()	0	4	1
A	getTotalFound()	0	4	1
A	getTotalCount()	0	4	1
A	isEmpty()	0	4	1
A	offsetExists()	0	4	1
A	offsetGet()	0	4	1
A	offsetSet()	0	6	1
A	offsetUnset()	0	6	1
A	getIterator()	0	4	1

<?php namespace Bardex\Elastic;

/**
 * SearchResult
 * @package Bardex\Elastic
 * @author Andrey Volynov <dubpubz@gmail.com>
 * @author Alexey Sumin <bardex@ya.ru>
 */
class SearchResult implements \ArrayAccess, \Countable, \IteratorAggregate
{
    /**
     * @var  int
     */
    protected $totalFound;

    /**
     * @var array|array[]|object[] $results
     */
    protected $results = [];


    public function __construct($results, $totalFound)
    {
        $results = (array)$results;
        $this->results = $results;
        $this->totalFound = $totalFound;
    }

    /**
     * Returns first entry from result set, or null,
     * if result set is empty.
     *
     * @return null|array|object|array[]|object[]
     */
    public function getFirst()
    {
        if ($this->isEmpty()) {
            return null;
        }
        $keys = array_keys($this->results);
        return $this->results[$keys[0]];
    }

    /**
     * Returns the complete result set.
     *
     * @return array
     */
    public function getResults()
    {
        return $this->results;
    }

    /**
     * Method returns count of returned query results.
     *
     * @return int
     */
    public function count()
    {
        return count($this->results);
    }

    /**
     * Method returns count of total query results in index.
     *
     * @return int
     */
    public function getTotalFound()
    {
        return $this->totalFound;
    }

    /**
     * @deprecated
     * @return int
     */
    public function getTotalCount()
    {
        return $this->getTotalFound();
    }


    /**
     * Method determines, if result data set is empty.
     *
     * @return bool
     */
    public function isEmpty()
    {
        return $this->count() == 0;
    }

    public function offsetExists($offset)
    {
        return array_key_exists($offset, $this->results);
    }

    public function offsetGet($offset)
    {
        return $this->results[$offset];
    }

    public function offsetSet($offset, $value)
    {
        $this->results[$offset] = $value;

        return $this;
    }

    public function offsetUnset($offset)
    {
        unset($this->results[$offset]);

        return $this;
    }

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