meilisearch/Classes/Domain/Search/Query/ParameterBuilder/TrigramPhraseFields.php

95 lines
3.4 KiB
PHP
Raw Normal View History

2021-04-17 00:26:33 +02:00
<?php
namespace WapplerSystems\Meilisearch\Domain\Search\Query\ParameterBuilder;
/***************************************************************
* Copyright notice
*
2021-04-17 21:20:54 +02:00
* (c) 2010-2017 dkd Internet Service GmbH <meilisearch-support@dkd.de>
2021-04-17 00:26:33 +02:00
* 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\Query\AbstractQueryBuilder;
use WapplerSystems\Meilisearch\System\Configuration\TypoScriptConfiguration;
/**
* The TrigramPhraseFields class
*/
class TrigramPhraseFields extends AbstractFieldList implements ParameterBuilder
{
/**
2021-04-17 21:20:54 +02:00
* Parameter key which should be used for Meilisearch URL query
2021-04-17 00:26:33 +02:00
*
* @var string
*/
protected $parameterKey = 'pf3';
/**
* Parses the string representation of the fieldList (e.g. content^100, title^10) to the object representation.
*
* @param string $fieldListString
* @param string $delimiter
* @return TrigramPhraseFields
*/
public static function fromString(string $fieldListString, string $delimiter = ',') : TrigramPhraseFields
{
return self::initializeFromString($fieldListString, $delimiter);
}
/**
2021-04-17 21:20:54 +02:00
* @param TypoScriptConfiguration $meilisearchConfiguration
2021-04-17 00:26:33 +02:00
* @return TrigramPhraseFields
*/
2021-04-17 21:20:54 +02:00
public static function fromTypoScriptConfiguration(TypoScriptConfiguration $meilisearchConfiguration)
2021-04-17 00:26:33 +02:00
{
2021-04-17 21:20:54 +02:00
$isEnabled = $meilisearchConfiguration->getTrigramPhraseSearchIsEnabled();
2021-04-17 00:26:33 +02:00
if (!$isEnabled) {
return new TrigramPhraseFields(false);
}
2021-04-17 21:20:54 +02:00
return self::fromString((string)$meilisearchConfiguration->getSearchQueryTrigramPhraseFields());
2021-04-17 00:26:33 +02:00
}
/**
* Parses the string representation of the fieldList (e.g. content^100, title^10) to the object representation.
*
* @param string $fieldListString
* @param string $delimiter
* @return TrigramPhraseFields
*/
protected static function initializeFromString(string $fieldListString, string $delimiter = ',') : TrigramPhraseFields
{
$fieldList = self::buildFieldList($fieldListString, $delimiter);
return new TrigramPhraseFields(true, $fieldList);
}
/**
* @param AbstractQueryBuilder $parentBuilder
* @return AbstractQueryBuilder
*/
public function build(AbstractQueryBuilder $parentBuilder): AbstractQueryBuilder
{
$trigramPhraseFieldsString = $this->toString();
if ($trigramPhraseFieldsString === '' || !$this->getIsEnabled()) {
return $parentBuilder;
}
$parentBuilder->getQuery()->getEDisMax()->setPhraseTrigramFields($trigramPhraseFieldsString);
return $parentBuilder;
}
}