meilisearch/Classes/Domain/Variants/VariantsProcessor.php
2021-04-24 04:44:44 +02:00

126 lines
4.6 KiB
PHP

<?php
namespace WapplerSystems\Meilisearch\Domain\Variants;
/***************************************************************
* Copyright notice
*
* (c) 2017- Timo Hund <timo.hund@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\Result\SearchResult;
use WapplerSystems\Meilisearch\Domain\Search\ResultSet\Result\SearchResultBuilder;
use WapplerSystems\Meilisearch\Domain\Search\ResultSet\SearchResultSet;
use WapplerSystems\Meilisearch\Domain\Search\ResultSet\SearchResultSetProcessor;
use WapplerSystems\Meilisearch\System\Configuration\TypoScriptConfiguration;
use WapplerSystems\Meilisearch\System\Meilisearch\ResponseAdapter;
use TYPO3\CMS\Core\Utility\GeneralUtility;
/**
* Builds the SearchResult objects from the meilisearch response and assigns the created child SearchResult objects (the variants)
* to the parent search result object.
*/
class VariantsProcessor implements SearchResultSetProcessor
{
/**
* @var TypoScriptConfiguration
*/
protected $typoScriptConfiguration;
/**
* @var SearchResultBuilder
*/
protected $resultBuilder;
/**
* VariantsProcessor constructor.
* @param TypoScriptConfiguration $configuration
* @param SearchResultBuilder|null $resultBuilder
*/
public function __construct(TypoScriptConfiguration $configuration, SearchResultBuilder $resultBuilder = null)
{
$this->typoScriptConfiguration = $configuration;
$this->resultBuilder = $resultBuilder ?? GeneralUtility::makeInstance(SearchResultBuilder::class);
}
/**
* This method is used to add documents to the expanded documents of the SearchResult
* when collapsing is configured.
*
* @param SearchResultSet $resultSet
* @return SearchResultSet
*/
public function process(SearchResultSet $resultSet)
{
$response = $resultSet->getResponse();
// @extensionScannerIgnoreLine
if (!is_array($response->response->docs)) {
return $resultSet;
}
if (!$this->typoScriptConfiguration->getSearchVariants()) {
return $resultSet;
}
$variantsField = $this->typoScriptConfiguration->getSearchVariantsField();
foreach ($resultSet->getSearchResults() as $resultDocument) {
/** @var $resultDocument SearchResult */
$variantId = $resultDocument[$variantsField] ?? null;
// when there is no value in the collapsing field, we can return
if ($variantId === null) {
continue;
}
$resultDocument->setVariantFieldValue($variantId);
if (!isset($response->{'expanded'}) || !isset($response->{'expanded'}->{$variantId})) {
continue;
}
$this->buildVariantDocumentAndAssignToParentResult($response, $variantId, $resultDocument);
$resultDocument->setVariantsNumFound($response->{'expanded'}->{$variantId}->{'numFound'});
}
return $resultSet;
}
/**
* Build the SearchResult of the variant and assigns it to the parent result document.
*
* @param ResponseAdapter $response
* @param string $variantAccessKey
* @param SearchResult $resultDocument
*/
protected function buildVariantDocumentAndAssignToParentResult(ResponseAdapter $response, $variantAccessKey, SearchResult $resultDocument)
{
foreach ($response->{'expanded'}->{$variantAccessKey}->{'docs'} as $variantDocumentArray) {
$fields = get_object_vars($variantDocumentArray);
$variantDocument = new SearchResult($fields);
$variantSearchResult = $this->resultBuilder->fromMeilisearchDocument($variantDocument);
$variantSearchResult->setIsVariant(true);
$variantSearchResult->setVariantParent($resultDocument);
$resultDocument->addVariant($variantSearchResult);
}
}
}