MediaWiki
master
SearchResult.php
Go to the documentation of this file.
1
<?php
8
namespace
MediaWiki\Search
;
9
10
use File;
11
use
MediaWiki\Title\Title
;
12
18
abstract
class
SearchResult
{
19
use
SearchResultTrait
;
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
166
class_alias( SearchResult::class,
'SearchResult'
);
MediaWiki\Search\RevisionSearchResult
SearchResult class based on the revision information.
Definition
RevisionSearchResult.php:16
MediaWiki\Search\SearchResult
An abstract base class representing a search engine result.
Definition
SearchResult.php:18
MediaWiki\Search\SearchResult\getRedirectSnippetField
getRedirectSnippetField()
Definition
SearchResult.php:94
MediaWiki\Search\SearchResult\getTitleSnippetField
getTitleSnippetField()
Definition
SearchResult.php:82
MediaWiki\Search\SearchResult\newFromTitle
static newFromTitle( $title, ?ISearchResultSet $parentSet=null)
Return a new SearchResult and initializes it with a title.
Definition
SearchResult.php:28
MediaWiki\Search\SearchResult\getWordCount
getWordCount()
MediaWiki\Search\SearchResult\getTitle
getTitle()
MediaWiki\Search\SearchResult\getInterwikiPrefix
getInterwikiPrefix()
MediaWiki\Search\SearchResult\getTimestamp
getTimestamp()
MediaWiki\Search\SearchResult\isMissingRevision
isMissingRevision()
Check if target page is missing, happens when index is out of date.
MediaWiki\Search\SearchResult\getRedirectTitle
getRedirectTitle()
MediaWiki\Search\SearchResult\isFileMatch
isFileMatch()
Did this match file contents (eg: PDF/DJVU)?
MediaWiki\Search\SearchResult\getCategorySnippet
getCategorySnippet()
MediaWiki\Search\SearchResult\getTextSnippet
getTextSnippet( $terms=[])
MediaWiki\Search\SearchResult\getTextSnippetField
getTextSnippetField()
Definition
SearchResult.php:70
MediaWiki\Search\SearchResult\getSectionTitle
getSectionTitle()
MediaWiki\Search\SearchResult\getSectionSnippetField
getSectionSnippetField()
Definition
SearchResult.php:111
MediaWiki\Search\SearchResult\isBrokenTitle
isBrokenTitle()
Check if this is result points to an invalid title.
MediaWiki\Search\SearchResult\getSectionSnippet
getSectionSnippet()
MediaWiki\Search\SearchResult\getTitleSnippet
getTitleSnippet()
MediaWiki\Search\SearchResult\getInterwikiNamespaceText
getInterwikiNamespaceText()
MediaWiki\Search\SearchResult\getRedirectSnippet
getRedirectSnippet()
MediaWiki\Search\SearchResult\getByteSize
getByteSize()
MediaWiki\Search\SearchResult\getCategorySnippetField
getCategorySnippetField()
Definition
SearchResult.php:129
MediaWiki\Search\SearchResult\getFile
getFile()
Get the file for this page, if one exists.
MediaWiki\Title\Title
Represents a title within MediaWiki.
Definition
Title.php:69
MediaWiki\Search\ISearchResultSet
A set of SearchEngine results.
Definition
ISearchResultSet.php:17
MediaWiki\Search
Definition of a mapping for the search index field.
Definition
BaseSearchResultSet.php:3
MediaWiki\Search\SearchResultTrait
trait SearchResultTrait
Trait for SearchResult subclasses to share non-obvious behaviors or methods that rarely specialized.
Definition
SearchResultTrait.php:12
includes
Search
SearchResult.php
Generated on Wed Jan 14 2026 00:26:26 for MediaWiki by
1.10.0