meilisearch/Classes/Domain/Search/ResultSet/Facets/RangeBased/NumericRange/NumericRangeFacet.php

94 lines
2.5 KiB
PHP
Raw Normal View History

2021-04-17 00:26:33 +02:00
<?php
namespace WapplerSystems\Meilisearch\Domain\Search\ResultSet\Facets\RangeBased\NumericRange;
/*
* This file is part of the TYPO3 CMS project.
*
* It is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, either version 2
* of the License, or any later version.
*
* For the full copyright and license information, please read the
* LICENSE.txt file that was distributed with this source code.
*
* The TYPO3 project - inspiring people to share!
*/
use WapplerSystems\Meilisearch\Domain\Search\ResultSet\Facets\AbstractFacet;
use WapplerSystems\Meilisearch\Domain\Search\ResultSet\Facets\AbstractFacetItemCollection;
use WapplerSystems\Meilisearch\Domain\Search\ResultSet\SearchResultSet;
/**
* Value object that represent a date range facet.
*
* @author Frans Saris <frans@beech.it>
* @author Timo Hund <timo.hund@dkd.de>
*/
class NumericRangeFacet extends AbstractFacet
{
const TYPE_NUMERIC_RANGE = 'numericRange';
/**
* String
* @var string
*/
protected static $type = self::TYPE_NUMERIC_RANGE;
/**
* @var NumericRange
*/
protected $numericRange;
/**
* OptionsFacet constructor
*
* @param SearchResultSet $resultSet
* @param string $name
* @param string $field
* @param string $label
* @param array $configuration Facet configuration passed from typoscript
*/
public function __construct(SearchResultSet $resultSet, $name, $field, $label = '', array $configuration = [])
{
parent::__construct($resultSet, $name, $field, $label, $configuration);
}
/**
* @param NumericRange $range
*/
public function setRange(NumericRange $range)
{
$this->numericRange = $range;
}
/**
* @return NumericRange
*/
public function getRange()
{
return $this->numericRange;
}
/**
* Get facet partial name used for rendering the facet
*
* @return string
*/
public function getPartialName()
{
return !empty($this->configuration['partialName']) ? $this->configuration['partialName'] : 'RangeNumeric.html';
}
/**
* Since the DateRange contains only one or two items when return a collection with the range only to
* allow to render the date range as other facet items.
*
* @return AbstractFacetItemCollection
*/
public function getAllFacetItems()
{
return new NumericRangeCollection([$this->numericRange]);
}
}