Firesphere / silverstripe-search

src/Traits/ResultTraits/SearchResultSetTrait.php

<?php
/**
 * Trait SearchResultSetTrait|Firesphere\SearchBackend\Traits\SearchResultSetTrait Setters 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 Firesphere\SearchBackend\Interfaces\SearchResultInterface;
use SilverStripe\View\ArrayData;
use Solarium\Component\Result\FacetSet;

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

use stdClass;

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

    /**
     * @var array|stdClass[] Highlighted items
     */
    protected $highlight;

    /**
     * Set the highlighted items
     *
     * @param $highlight
     * @return SearchResultInterface
     */
    public function setHighlight($highlights): SearchResultInterface
    {
        $this->highlight = $highlights;

        return $this;

The expression return $this returns the type Firesphere\SearchBackend\Traits\SearchResultSetTrait which is incompatible with the type-hinted return Firesphere\SearchBackend\Interfaces\SearchResultInterface.

    }

    /**
     * Set the total amount of results
     *
     * @param $count
     * @return self
     */
    public function setTotalItems($count): SearchResultInterface
    {
        $this->totalItems = $count;

        return $this;

The expression return $this returns the type Firesphere\SearchBackend\Traits\SearchResultSetTrait which is incompatible with the type-hinted return Firesphere\SearchBackend\Interfaces\SearchResultInterface.

    }


    /**
     * Set the facets to build
     *
     * @param stdClass|FacetSet $facets
     * @return self
     */
    public function setFacets($facets): self
    {
        $this->facets = $this->buildFacets($facets);

        return $this;
    }


    /**
     * Build the given list of key-value pairs in to a SilverStripe useable array
     *
     * @param stdClass|FacetSet $facets
     * @return ArrayData
     */
    protected function buildFacets($facets): ArrayData
    {
        $facetArray = [];
        if ($facets) {
            $facetTypes = $this->index->getFacetFields();
            // Loop all available facet fields by type
            foreach ($facetTypes as $class => $options) {
                $facetArray = $this->createFacet($facets, $options, $class, $facetArray);

It seems like createFacet() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            }
        }

        // Return an ArrayList of the results
        return ArrayData::create($facetArray);
    }
}