Firesphere\SearchBackend\Traits\SearchResultGetTrait

Complexity

Total Complexity

4

Size/Duplication

Total Lines	60
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getFacets()	0	3	1
A	getHighlight()	0	3	1
A	getSpellcheck()	0	3	1
A	getTotalItems()	0	3	1

<?php
/**
 * Trait SearchResultGetTrait|Firesphere\SearchBackend\Traits\SearchResultGetTrait Getters for
 * {@link \Firesphere\SearchBackend\Interfaces\SearchResultInterface}
 *
 * @package Firesphere\Search\Backend
 * @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
 * @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
 */

namespace Firesphere\SearchBackend\Traits;

use SilverStripe\ORM\ArrayList;
use SilverStripe\View\ArrayData;
use Solarium\Component\Highlighting\Highlighting;

The type Solarium\Component\Highlighting\Highlighting was not found. Maybe you did not declare it correctly or list all dependencies?

/**
 * Trait SearchResultGetTrait
 *
 * Getters for search results to keep the {@link SearchResult} class clean.
 *
 * @package Firesphere\Search\Backend
 */
trait SearchResultGetTrait
{
    /**
     * @var int Total items in the result
     */
    protected $totalItems = 0;

    /**
     * @var ArrayData Facet results
     */
    protected $facets;

    /**
     * @var Highlighting Highlighting
     */
    protected $highlight;

    /**
     * @var ArrayList Spellcheck results
     */
    protected $spellcheck;

    /**
     * Retrieve the facets from the results
     *
     * @return ArrayData
     */
    public function getFacets(): ArrayData
    {
        return $this->facets ?? ArrayData::create();
    }

    /**
     * Get the highlighting
     *
     * @return array|Highlighting
     */
    public function getHighlight()
    {
        return $this->highlight ?? [];
    }

    /**
     * Get the spellchecked results
     *
     * @return ArrayList
     */
    public function getSpellcheck(): ArrayList
    {
        return $this->spellcheck ?? ArrayList::create();
    }

    /**
     * Total items in the result
     *
     * @return int
     */
    public function getTotalItems(): int
    {
        return $this->totalItems;
    }
}