]> scripts.mit.edu Git - autoinstalls/mediawiki.git/blob - includes/widget/search/SearchResultWidget.php
MediaWiki 1.30.2
[autoinstalls/mediawiki.git] / includes / widget / search / SearchResultWidget.php
1 <?php
2
3 namespace MediaWiki\Widget\Search;
4
5 use SearchResult;
6
7 /**
8  * Renders a single search result to HTML
9  */
10 interface SearchResultWidget {
11         /**
12          * @param SearchResult $result The result to render
13          * @param string $terms Terms to be highlighted (@see SearchResult::getTextSnippet)
14          * @param int $position The zero indexed result position, including offset
15          * @return string HTML
16          */
17         public function render( SearchResult $result, $terms, $position );
18 }