meilisearch/Classes/Domain/Search/ResultSet/Result/Parser/AbstractResultParser.php

73 lines
2.6 KiB
PHP
Raw Normal View History

2021-04-17 00:26:33 +02:00
<?php
namespace WapplerSystems\Meilisearch\Domain\Search\ResultSet\Result\Parser;
/***************************************************************
* Copyright notice
*
* (c) 2015-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\SearchResultBuilder;
use WapplerSystems\Meilisearch\Domain\Search\ResultSet\Result\SearchResultCollection;
use WapplerSystems\Meilisearch\Domain\Search\ResultSet\SearchResultSet;
use WapplerSystems\Meilisearch\System\Configuration\TypoScriptConfiguration;
use TYPO3\CMS\Core\Utility\GeneralUtility;
/**
2021-04-17 21:20:54 +02:00
* A ResultParser is responsible to create the result object structure from the \Apache_Meilisearch_Response
2021-04-17 00:26:33 +02:00
* and assign it to the SearchResultSet.
*/
abstract class AbstractResultParser {
/**
* @var SearchResultBuilder
*/
protected $searchResultBuilder;
/**
* @var DocumentEscapeService
*/
protected $documentEscapeService;
/**
* AbstractResultParser constructor.
* @param SearchResultBuilder|null $resultBuilder
* @param DocumentEscapeService|null $documentEscapeService
*/
public function __construct(SearchResultBuilder $resultBuilder = null, DocumentEscapeService $documentEscapeService = null) {
$this->searchResultBuilder = $resultBuilder ?? GeneralUtility::makeInstance(SearchResultBuilder::class);
$this->documentEscapeService = $documentEscapeService ?? GeneralUtility::makeInstance(DocumentEscapeService::class);
}
/**
* @param SearchResultSet $resultSet
* @param bool $useRawDocuments
* @return SearchResultSet
*/
abstract public function parse(SearchResultSet $resultSet, bool $useRawDocuments = true);
/**
* @param SearchResultSet $resultSet
* @return mixed
*/
abstract public function canParse(SearchResultSet $resultSet);
}