MediaWiki master
SearchResult.php
Go to the documentation of this file.
1<?php
8namespace MediaWiki\Search;
9
10use File;
12
18abstract class SearchResult {
20
28 public static function newFromTitle( $title, ?ISearchResultSet $parentSet = null ): SearchResult {
29 $result = new RevisionSearchResult( $title );
30 if ( $parentSet ) {
31 $parentSet->augmentResult( $result );
32 }
33 return $result;
34 }
35
41 abstract public function isBrokenTitle();
42
48 abstract public function isMissingRevision();
49
53 abstract public function getTitle();
54
59 abstract public function getFile();
60
65 abstract public function getTextSnippet( $terms = [] );
66
70 public function getTextSnippetField() {
71 return '';
72 }
73
77 abstract public function getTitleSnippet();
78
82 public function getTitleSnippetField() {
83 return '';
84 }
85
89 abstract public function getRedirectSnippet();
90
94 public function getRedirectSnippetField() {
95 return '';
96 }
97
101 abstract public function getRedirectTitle();
102
106 abstract public function getSectionSnippet();
107
111 public function getSectionSnippetField() {
112 return '';
113 }
114
119 abstract public function getSectionTitle();
120
124 abstract public function getCategorySnippet();
125
129 public function getCategorySnippetField() {
130 return '';
131 }
132
136 abstract public function getTimestamp();
137
141 abstract public function getWordCount();
142
146 abstract public function getByteSize();
147
151 abstract public function getInterwikiPrefix();
152
156 abstract public function getInterwikiNamespaceText();
157
162 abstract public function isFileMatch();
163}
164
166class_alias( SearchResult::class, 'SearchResult' );
SearchResult class based on the revision information.
An abstract base class representing a search engine result.
static newFromTitle( $title, ?ISearchResultSet $parentSet=null)
Return a new SearchResult and initializes it with a title.
isMissingRevision()
Check if target page is missing, happens when index is out of date.
isFileMatch()
Did this match file contents (eg: PDF/DJVU)?
isBrokenTitle()
Check if this is result points to an invalid title.
getFile()
Get the file for this page, if one exists.
Represents a title within MediaWiki.
Definition Title.php:69
A set of SearchEngine results.
Definition of a mapping for the search index field.
trait SearchResultTrait
Trait for SearchResult subclasses to share non-obvious behaviors or methods that rarely specialized.