Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
n/a
0 / 0
n/a
0 / 0
CRAP
n/a
0 / 0
1<?php
2
3namespace MediaWiki\Search\Hook;
4
5use SearchEngine;
6use SearchIndexField;
7
8/**
9 * This is a hook handler interface, see docs/Hooks.md.
10 * Use the hook name "SearchIndexFields" to register handlers implementing this interface.
11 *
12 * @stable to implement
13 * @ingroup Hooks
14 */
15interface SearchIndexFieldsHook {
16    /**
17     * Use this hook to add fields to search index mapping.
18     *
19     * @since 1.35
20     *
21     * @param SearchIndexField[] &$fields Array of fields, all implement SearchIndexField
22     * @param SearchEngine $engine SearchEngine instance for which mapping is being built
23     * @return bool|void True or no return value to continue or false to abort
24     */
25    public function onSearchIndexFields( &$fields, $engine );
26}