meilisearch/Classes/IndexQueue/PageIndexerDocumentsModifier.php
2021-04-17 21:20:54 +02:00

49 lines
1.8 KiB
PHP

<?php
namespace WapplerSystems\Meilisearch\IndexQueue;
/***************************************************************
* Copyright notice
*
* (c) 2010-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!
***************************************************************/
/**
* IndexQueuePageIndexerDocumentsModifier interface, allows to modify documents
* before adding them to the Meilisearch index in the index queue page indexer.
*
* @author Ingo Renner <ingo@typo3.org>
*/
interface PageIndexerDocumentsModifier
{
/**
* Modifies the given documents
*
* @param Item $item The currently being indexed item.
* @param int $language The language uid of the documents
* @param array $documents An array of documents to be indexed
* @return array An array of modified documents
*/
public function modifyDocuments(Item $item, $language, array $documents);
}