Suilven\FreeTextSearch\Container\SearchResults

Complexity

Total Complexity

22

Size/Duplication

Total Lines	167
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

21 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getTotaNumberOfResults()	0	3	1
A	setRecords()	0	3	1
A	setPageSize()	0	3	1
A	getTime()	0	3	1
A	setTime()	0	3	1
A	getTotalPages()	0	5	1
A	setPage()	0	3	1
A	getPageSize()	0	3	1
A	setTotalNumberOfResults()	0	3	1
A	setQuery()	0	3	1
A	getSimilarTo()	0	3	1
A	setSuggestions()	0	3	1
A	setIndex()	0	3	1
A	getSuggestions()	0	3	1
A	getQuery()	0	3	1
A	getRecords()	0	5	2
A	setSimilarTo()	0	3	1
A	getPage()	0	3	1
A	addFacet()	0	3	1
A	getFacets()	0	3	1

<?php declare(strict_types = 1);

/**
 * Created by PhpStorm.
 * User: gordon
 * Date: 24/3/2561
 * Time: 20:36 น.
 */

namespace Suilven\FreeTextSearch\Container;

use SilverStripe\ORM\ArrayList;

/**
 * Class SearchResults
 *
 * Store the search results in a manner that is renderable in a SilverStripe template
 *
 * @package Suilven\FreeTextSearch\Container
 */
class SearchResults
{

    /** @var array<\Suilven\FreeTextSearch\Container\Facet> */
    private $facets;

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

    /** @var int the total number of results */
    private $totalNumberOfResults = 0;

    /** @var int */
    private $page = 0;

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

    /** @var string */
    private $query = '';

    /** @var \SilverStripe\ORM\ArrayList|null */
    private $records;

    /** @var array<string> */
    private $suggestions;

    /** @var float the time in seconds */
    private $time;

    /** @var \SilverStripe\ORM\DataObject|null */
    private $searchSimilarTo = null;

    public function __construct()
    {
        $this->time = 0;
        $this->suggestions =[];
    }


    public function addFacet(Facet $facet): void
    {
        $this->facets[] = $facet;
    }


    public function setIndex(string $newIndex): void
    {
        $this->index = $newIndex;
    }


    public function getTotaNumberOfResults(): int
    {
        return $this->totalNumberOfResults;
    }


    public function setTotalNumberOfResults(int $newTotalNumberOfResults): void
    {
        $this->totalNumberOfResults = $newTotalNumberOfResults;
    }


    public function getTotalPages(): int
    {
        $nPages = \ceil($this->totalNumberOfResults / $this->pageSize);

        return \intval($nPages);
    }


    public function getPage(): int
    {
        return $this->page;
    }


    public function setPage(int $newPage): void
    {
        $this->page = $newPage;
    }


    public function getPageSize(): int
    {
        return $this->pageSize;
    }


    public function setPageSize(int $newPageSize): void
    {
        $this->pageSize = $newPageSize;
    }


    public function getQuery(): string
    {
        return $this->query;
    }


    /** @return array<\Suilven\FreeTextSearch\Container\Facet> */
    public function getFacets(): array
    {
        return $this->facets;
    }


    public function setQuery(string $newQuery): void
    {
        $this->query = $newQuery;
    }


    public function setRecords(ArrayList $newRecords): void
    {
        $this->records = $newRecords;
    }


    public function getRecords(): \SilverStripe\ORM\ArrayList
    {
        return \is_null($this->records)
            ? new ArrayList([])
            : $this->records;
    }


    /** Accessor to the suggestions
     *
     * @return array<string>
     */
    public function getSuggestions(): array
    {
        return $this->suggestions;
    }


    /** @param array<string> $newSuggestions */
    public function setSuggestions(array $newSuggestions): void
    {
        $this->suggestions = $newSuggestions;
    }


    public function getTime(): float
    {
        return $this->time;
    }


    public function setTime(float $newTime): void
    {
        $this->time = $newTime;
    }


    public function getSimilarTo(): ?\SilverStripe\ORM\DataObject
    {
        return $this->searchSimilarTo;
    }


    public function setSimilarTo(?\SilverStripe\ORM\DataObject $dataObject): void
    {
        $this->searchSimilarTo = $dataObject;
    }
}