summaryrefslogtreecommitdiff
path: root/www/wiki/includes/widget/search/SearchResultWidget.php
blob: 3fbdbef2a920711c81daa8506129e7b04d0c7f00 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<?php

namespace MediaWiki\Widget\Search;

use SearchResult;

/**
 * Renders a single search result to HTML
 */
interface SearchResultWidget {
	/**
	 * @param SearchResult $result The result to render
	 * @param string $terms Terms to be highlighted (@see SearchResult::getTextSnippet)
	 * @param int $position The zero indexed result position, including offset
	 * @return string HTML
	 */
	public function render( SearchResult $result, $terms, $position );
}