WapplerSystems/meilisearch
6
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

first commit

Browse Source
This commit is contained in:
Sven Wappler
2021-04-17 00:26:33 +02:00
commit 866c63cc63
813 changed files with 100696 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

123
Classes/Domain/Search/ResultSet/Facets/RangeBased/NumericRange/NumericRange.php Normal file
View File

@@ -0,0 +1,123 @@
<?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\RangeBased\AbstractRangeFacetItem;
/**
* Value object that represent an option of a numric range facet.
*
* @author Frans Saris <frans@beech.it>
* @author Timo Hund <timo.hund@dkd.de>
*/
class NumericRange extends AbstractRangeFacetItem
{
/**
* @var float
*/
protected $startRequested;
/**
* @var float
*/
protected $endRequested;
/**
* @var float
*/
protected $startInResponse;
/**
* @var float
*/
protected $endInResponse;
/**
* @param NumericRangeFacet $facet
* @param float|null $startRequested
* @param float|null $endRequested
* @param float|null $startInResponse
* @param float|null $endInResponse
* @param string $gap
* @param int $documentCount
* @param array $rangeCounts
* @param bool $selected
*/
public function __construct(NumericRangeFacet $facet, $startRequested = null, $endRequested = null, $startInResponse = null, $endInResponse = null, $gap = '', $documentCount = 0, $rangeCounts, $selected = false)
{
$this->startInResponse = $startInResponse;
$this->endInResponse = $endInResponse;
$this->startRequested = $startRequested;
$this->endRequested = $endRequested;
$this->rangeCounts = $rangeCounts;
$this->gap = $gap;
$label = '';
if ($startRequested !== null && $endRequested !== null) {
$label = $this->getRangeString();
}
parent::__construct($facet, $label, $documentCount, $selected);
}
/**
* @return string
*/
protected function getRangeString()
{
return $this->startRequested . '-' . $this->endRequested;
}
/**
* Retrieves the end date that was requested by the user for this facet.
*
* @return float
*/
public function getEndRequested()
{
return $this->endRequested;
}
/**
* Retrieves the start date that was requested by the used for the facet.
*
* @return float
*/
public function getStartRequested()
{
return $this->startRequested;
}
/**
* Retrieves the end date that was received from solr for this facet.
*
* @return float
*/
public function getEndInResponse()
{
return $this->endInResponse;
}
/**
* Retrieves the start date that was received from solr for this facet.
*
* @return float
*/
public function getStartInResponse()
{
return $this->startInResponse;
}
}

44
Classes/Domain/Search/ResultSet/Facets/RangeBased/NumericRange/NumericRangeCollection.php Normal file
View File

@@ -0,0 +1,44 @@
<?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\AbstractFacetItemCollection;
/**
* Collection for facet options.
*
* @author Frans Saris <frans@beech.it>
* @author Timo Hund <timo.hund@dkd.de>
*/
class NumericRangeCollection extends AbstractFacetItemCollection
{
/**
* @param NumericRange $numericRange
* @return NumericRangeCollection
*/
public function add($numericRange)
{
return parent::add($numericRange);
}
/**
* @param int $position
* @return NumericRange
*/
public function getByPosition($position)
{
return parent::getByPosition($position);
}
}

63
Classes/Domain/Search/ResultSet/Facets/RangeBased/NumericRange/NumericRangeCount.php Normal file
View File

@@ -0,0 +1,63 @@
<?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\AbstractFacetItem;
use DateTime;
/**
* Value object that represent an date range count. The count has a date and the count of documents
*
* @author Frans Saris <frans@beech.it>
* @author Timo Hund <timo.hund@dkd.de>
*/
class NumericRangeCount
{
/**
* @var float
*/
protected $rangeItem;
/**
* @var int
*/
protected $documentCount = 0;
/**
* @param float $rangeItem
* @param integer $documentCount
*/
public function __construct($rangeItem, $documentCount)
{
$this->rangeItem = $rangeItem;
$this->documentCount = $documentCount;
}
/**
* @return float
*/
public function getRangeItem()
{
return $this->rangeItem;
}
/**
* @return int
*/
public function getDocumentCount()
{
return $this->documentCount;
}
}

93
Classes/Domain/Search/ResultSet/Facets/RangeBased/NumericRange/NumericRangeFacet.php Normal file
View File

@@ -0,0 +1,93 @@
<?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]);
}
}

77
Classes/Domain/Search/ResultSet/Facets/RangeBased/NumericRange/NumericRangeFacetParser.php Normal file
View File

@@ -0,0 +1,77 @@
<?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\RangeBased\AbstractRangeFacetParser;
use WapplerSystems\Meilisearch\Domain\Search\ResultSet\SearchResultSet;
/**
* Class NumericRangeFacetParser
*
* @author Frans Saris <frans@beech.it>
* @author Timo Hund <timo.hund@dkd.de>
*/
class NumericRangeFacetParser extends AbstractRangeFacetParser
{
/**
* @var string
*/
protected $facetClass = NumericRangeFacet::class;
/**
* @var string
*/
protected $facetItemClass = NumericRange::class;
/**
* @var string
*/
protected $facetRangeCountClass = NumericRangeCount::class;
/**
* @param SearchResultSet $resultSet
* @param string $facetName
* @param array $facetConfiguration
* @return NumericRangeFacet|null
*/
public function parse(SearchResultSet $resultSet, $facetName, array $facetConfiguration)
{
return $this->getParsedFacet(
$resultSet,
$facetName,
$facetConfiguration,
$this->facetClass,
$this->facetItemClass,
$this->facetRangeCountClass
);
}
/**
* @param mixed $rawValue
* @return mixed (numeric value)
*/
protected function parseRequestValue($rawValue)
{
return is_numeric($rawValue) ? $rawValue : 0;
}
/**
* @param $rawValue
* @return mixed (numeric value)
*/
protected function parseResponseValue($rawValue)
{
return is_numeric($rawValue) ? $rawValue : 0;
}
}

44
Classes/Domain/Search/ResultSet/Facets/RangeBased/NumericRange/NumericRangeFacetQueryBuilder.php Normal file
View File

@@ -0,0 +1,44 @@
<?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\FacetQueryBuilderInterface;
use WapplerSystems\Meilisearch\System\Configuration\TypoScriptConfiguration;
class NumericRangeFacetQueryBuilder implements FacetQueryBuilderInterface {
/**
* @param string $facetName
* @param TypoScriptConfiguration $configuration
* @return array
*/
public function build($facetName, TypoScriptConfiguration $configuration)
{
$facetParameters = [];
$facetConfiguration = $configuration->getSearchFacetingFacetByName($facetName);
$tag = '';
if ($facetConfiguration['keepAllOptionsOnSelection'] == 1) {
$tag = '{!ex=' . $facetConfiguration['field'] . '}';
}
$facetParameters['facet.range'][] = $tag . $facetConfiguration['field'];
$facetParameters['f.' . $facetConfiguration['field'] . '.facet.range.start'] = $facetConfiguration['numericRange.']['start'];
$facetParameters['f.' . $facetConfiguration['field'] . '.facet.range.end'] = $facetConfiguration['numericRange.']['end'];
$facetParameters['f.' . $facetConfiguration['field'] . '.facet.range.gap'] = $facetConfiguration['numericRange.']['gap'];
return $facetParameters;
}
}

46
Classes/Domain/Search/ResultSet/Facets/RangeBased/NumericRange/NumericRangePackage.php Normal file
View File

@@ -0,0 +1,46 @@
<?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\AbstractFacetPackage;
/**
* Class NumericRangePackage
*/
class NumericRangePackage extends AbstractFacetPackage {
/**
* @return string
*/
public function getParserClassName() {
return (string)NumericRangeFacetParser::class;
}
/**
* @return string
*/
public function getQueryBuilderClassName()
{
return (string)NumericRangeFacetQueryBuilder::class;
}
/**
* @return string
*/
public function getUrlDecoderClassName()
{
return (string)NumericRangeUrlDecoder::class;
}
}

69
Classes/Domain/Search/ResultSet/Facets/RangeBased/NumericRange/NumericRangeUrlDecoder.php Normal file
View File

@@ -0,0 +1,69 @@
<?php
namespace WapplerSystems\Meilisearch\Domain\Search\ResultSet\Facets\RangeBased\NumericRange;
/***************************************************************
* Copyright notice
*
* (c) 2010-2011 Markus Goldbach <markus.goldbach@dkd.de>
* (c) 2012-2015 Ingo Renner <ingo@typo3.org>
* (c) 2016 Markus Friedrich <markus.friedrich@dkd.de>
* All rights reserved
*
* This script is part of the TYPO3 project. The TYPO3 project 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 3 of the License, or
* (at your option) any later version.
*
* The GNU General Public License can be found at
* http://www.gnu.org/copyleft/gpl.html.
*
* This script 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.
*
* This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
use WapplerSystems\Meilisearch\Domain\Search\ResultSet\Facets\FacetUrlDecoderInterface;
/**
* Parser to build Solr range queries from tx_meilisearch[filter]
*
* @author Markus Goldbach <markus.goldbach@dkd.de>
* @author Ingo Renner <ingo@typo3.org>
* @author Markus Friedrich <markus.friedrich@dkd.de>
*/
class NumericRangeUrlDecoder implements FacetUrlDecoderInterface
{
/**
* Delimiter for ranges in the URL.
*
* @var string
*/
const DELIMITER = '-';
/**
* Parses the given range from a GET parameter and returns a Solr range
* filter.
*
* @param string $range The range filter from the URL.
* @param array $configuration Facet configuration
* @return string Lucene query language filter to be used for querying Solr
* @throws \InvalidArgumentException
*/
public function decode($range, array $configuration = [])
{
preg_match('/(-?\d*?)' . self::DELIMITER . '(-?\d*)/', $range, $filterParts);
if ($filterParts[1] == '' || $filterParts[2] == '') {
throw new \InvalidArgumentException(
'Invalid numeric range given',
1466062730
);
}
return '[' . (int)$filterParts[1] . ' TO ' . (int)$filterParts[2] . ']';
}
}