c44488f725
Edited doc comments for hook interfaces to improve consistency and add type hints. Bug: T246855 Change-Id: I38fa802463cd6f39bf5946dbbeb1b3ebaea604b2
31 lines
890 B
PHP
31 lines
890 B
PHP
<?php
|
|
|
|
namespace MediaWiki\Content\Hook;
|
|
|
|
use ContentHandler;
|
|
use ParserOutput;
|
|
use SearchEngine;
|
|
use WikiPage;
|
|
|
|
/**
|
|
* @stable for implementation
|
|
* @ingroup Hooks
|
|
*/
|
|
interface SearchDataForIndexHook {
|
|
/**
|
|
* Use this hook to add data to search document. Allows you to add any data to
|
|
* the field map used to index the document.
|
|
*
|
|
* @since 1.35
|
|
*
|
|
* @param array &$fields Array of name => value pairs for fields
|
|
* @param ContentHandler $handler ContentHandler for the content being indexed
|
|
* @param WikiPage $page WikiPage that is being indexed
|
|
* @param ParserOutput $output ParserOutput that is produced from the page
|
|
* @param SearchEngine $engine SearchEngine for which the indexing is intended
|
|
* @return bool|void True or no return value to continue or false to abort
|
|
*/
|
|
public function onSearchDataForIndex( &$fields, $handler, $page, $output,
|
|
$engine
|
|
);
|
|
}
|