summaryrefslogtreecommitdiff
path: root/www/wiki/includes/widget/search/SearchResultWidget.php
diff options
context:
space:
mode:
Diffstat (limited to 'www/wiki/includes/widget/search/SearchResultWidget.php')
-rw-r--r--www/wiki/includes/widget/search/SearchResultWidget.php18
1 files changed, 18 insertions, 0 deletions
diff --git a/www/wiki/includes/widget/search/SearchResultWidget.php b/www/wiki/includes/widget/search/SearchResultWidget.php
new file mode 100644
index 00000000..3fbdbef2
--- /dev/null
+++ b/www/wiki/includes/widget/search/SearchResultWidget.php
@@ -0,0 +1,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 );
+}