search_core/Classes/Connection/Elasticsearch/SearchResult.php
Daniel Siepmann ea8b4f4538
TASK: Fix / improve some comments
* Add missing throws annotation.
* Remove useless comments.
* Import namespaces used in comments.
2018-12-29 18:03:14 +01:00

202 lines
4.4 KiB
PHP

<?php
namespace Codappix\SearchCore\Connection\Elasticsearch;
/*
* Copyright (C) 2016 Daniel Siepmann <coding@daniel-siepmann.de>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301, USA.
*/
use Codappix\SearchCore\Connection\FacetInterface;
use Codappix\SearchCore\Connection\ResultItemInterface;
use Codappix\SearchCore\Connection\SearchRequestInterface;
use Codappix\SearchCore\Connection\SearchResultInterface;
use Codappix\SearchCore\Domain\Model\QueryResultInterfaceStub;
use Codappix\SearchCore\Domain\Model\ResultItem;
use TYPO3\CMS\Extbase\Object\ObjectManagerInterface;
class SearchResult implements SearchResultInterface
{
use QueryResultInterfaceStub;
/**
* @var SearchRequestInterface
*/
protected $searchRequest;
/**
* @var \Elastica\ResultSet
*/
protected $result;
/**
* @var array<FacetInterface>
*/
protected $facets;
/**
* @var array<ResultItemInterface>
*/
protected $results;
/**
* For Iterator interface.
*
* @var int
*/
protected $position = 0;
/**
* @var ObjectManagerInterface
*/
protected $objectManager;
public function __construct(
SearchRequestInterface $searchRequest,
\Elastica\ResultSet $result,
ObjectManagerInterface $objectManager
) {
$this->searchRequest = $searchRequest;
$this->result = $result;
$this->objectManager = $objectManager;
}
/**
* @return array<ResultItemInterface>
*/
public function getResults(): array
{
$this->initResults();
return $this->results;
}
/**
* Return all facets, if any.
*
* @return array<FacetInterface>
*/
public function getFacets(): array
{
$this->initFacets();
return $this->facets;
}
public function getCurrentCount(): int
{
return $this->result->count();
}
protected function initResults()
{
if (is_array($this->results)) {
return;
}
$this->results = [];
foreach ($this->result->getResults() as $result) {
$this->results[] = new ResultItem($result->getData(), $result->getParam('_type'));
}
}
protected function initFacets()
{
if (is_array($this->facets)) {
return;
}
$this->facets = [];
if ($this->result->hasAggregations()) {
foreach ($this->result->getAggregations() as $aggregationName => $aggregation) {
$this->facets[$aggregationName] = $this->objectManager->get(
Facet::class,
$aggregationName,
$aggregation
);
}
}
}
/**
* Countable - Interface
*
* @return integer
*/
public function count()
{
return $this->result->getTotalHits();
}
/**
* Iterator - Interface
*
* @return mixed
*/
public function current()
{
return $this->getResults()[$this->position];
}
/**
* Iterator - Interface
*
* @return mixed
*/
public function next()
{
++$this->position;
return $this->current();
}
/**
* Iterator - Interface
*
* @return int|mixed
*/
public function key()
{
return $this->position;
}
/**
* Iterator - Interface
*
* @return bool
*/
public function valid()
{
return isset($this->getResults()[$this->position]);
}
/**
* Iterator - Interface
*/
public function rewind()
{
$this->position = 0;
}
/**
* @return SearchRequestInterface
*/
public function getQuery()
{
return $this->searchRequest;
}
}