meilisearch/Classes/SubstitutePageIndexer.php

49 lines
1.8 KiB
PHP
Raw Normal View History

2021-04-17 00:26:33 +02:00
<?php
namespace WapplerSystems\Meilisearch;
/***************************************************************
* Copyright notice
*
* (c) 2009-2015 Ingo Renner <ingo@typo3.org>
* 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.
* A copy is found in the textfile GPL.txt and important notices to the license
* from the author is found in LICENSE.txt distributed with these scripts.
*
*
* 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\System\Solr\Document\Document;
/**
* Substitute page indexer interface, describes the method an indexer must
* implement to provide a substitute page document
*
* @author Ingo Renner <ingo@typo3.org>
*/
interface SubstitutePageIndexer
{
/**
* returns a substitute document for the currently being indexed page
*
* @param Document $originalPageDocument The original page document.
* @return Document returns an \WapplerSystems\Meilisearch\System\Solr\Document\Document object that replace the default page document
*/
public function getPageDocument(Document $originalPageDocument);
}