MediaWiki\Search\RevisionSearchResult Class Reference

SearchResult class based on the revision information. More...

Inherits MediaWiki\Search\SearchResult.

Inherited by MediaWiki\Search\FauxSearchResult, and MediaWiki\Search\SqlSearchResult.

Collaboration diagram for MediaWiki\Search\RevisionSearchResult:

Public Member Functions
	__construct ( $title)
	getByteSize ()
	getCategorySnippet ()
	getFile ()
	Get the file for this page, if one exists.
	getInterwikiNamespaceText ()
	getInterwikiPrefix ()
	getRedirectSnippet ()
	getRedirectTitle ()
	getSectionSnippet ()
	getSectionTitle ()
	getTextSnippet ( $terms=[])
	getTimestamp ()
	getTitle ()
	getTitleSnippet ()
	getWordCount ()
	isBrokenTitle ()
	Check if this is result points to an invalid title.
	isFileMatch ()
	Did this match file contents (eg: PDF/DJVU)?
	isMissingRevision ()
	Check if target page is missing, happens when index is out of date.
Public Member Functions inherited from MediaWiki\Search\SearchResult
	getCategorySnippetField ()
	getRedirectSnippetField ()
	getSectionSnippetField ()
	getTextSnippetField ()
	getTitleSnippetField ()

Protected Member Functions
	initFromTitle ( $title)
	Initialize from a Title and if possible initializes a corresponding RevisionRecord and File.
	initText ()
	Lazy initialization of article text from DB.

Protected Attributes
MediaWiki FileRepo File File null	$mImage = null
MediaWiki Revision RevisionRecord null	$mRevisionRecord = null
string null	$mText
Title null	$mTitle

Additional Inherited Members
Static Public Member Functions inherited from MediaWiki\Search\SearchResult
static	newFromTitle ( $title, ?ISearchResultSet $parentSet=null)
	Return a new SearchResult and initializes it with a title.

Detailed Description

SearchResult class based on the revision information.

This class is suited for search engines that do not store a specialized version of the searched content.

Definition at line 16 of file RevisionSearchResult.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Search\RevisionSearchResult::__construct

(

$title

)

Parameters

Title | null

$title

Definition at line 41 of file RevisionSearchResult.php.

References MediaWiki\Search\RevisionSearchResult\initFromTitle().

Member Function Documentation

getByteSize()

MediaWiki\Search\RevisionSearchResult::getByteSize

(

)

Returns

int Size in bytes

Reimplemented from MediaWiki\Search\SearchResult.

Definition at line 191 of file RevisionSearchResult.php.

References MediaWiki\Search\RevisionSearchResult\initText().

getCategorySnippet()

MediaWiki\Search\RevisionSearchResult::getCategorySnippet

(

)

Returns

string Highlighted relevant category name or '' if none or not supported

Reimplemented from MediaWiki\Search\SearchResult.

Definition at line 164 of file RevisionSearchResult.php.

getFile()

MediaWiki\Search\RevisionSearchResult::getFile

(

)

Get the file for this page, if one exists.

Returns

\MediaWiki\FileRepo\File\File|null

Reimplemented from MediaWiki\Search\SearchResult.

Definition at line 99 of file RevisionSearchResult.php.

References MediaWiki\Search\RevisionSearchResult\$mImage.

getInterwikiNamespaceText()

MediaWiki\Search\RevisionSearchResult::getInterwikiNamespaceText

(

)

Returns

string Interwiki namespace of the title (since we likely can't resolve it locally)

Reimplemented from MediaWiki\Search\SearchResult.

Definition at line 206 of file RevisionSearchResult.php.

getInterwikiPrefix()

MediaWiki\Search\RevisionSearchResult::getInterwikiPrefix

(

)

Returns

string Interwiki prefix of the title (return iw even if title is broken)

Reimplemented from MediaWiki\Search\SearchResult.

Definition at line 199 of file RevisionSearchResult.php.

getRedirectSnippet()

MediaWiki\Search\RevisionSearchResult::getRedirectSnippet

(

)

Returns

string Highlighted redirect name (redirect to this page), '' if none or not supported

Reimplemented from MediaWiki\Search\SearchResult.

Definition at line 135 of file RevisionSearchResult.php.

getRedirectTitle()

MediaWiki\Search\RevisionSearchResult::getRedirectTitle

(

)

Returns

Title|null Title object for the redirect to this page, null if none or not supported

Reimplemented from MediaWiki\Search\SearchResult.

Definition at line 142 of file RevisionSearchResult.php.

getSectionSnippet()

MediaWiki\Search\RevisionSearchResult::getSectionSnippet

(

)

Returns

string Highlighted relevant section name, null if none or not supported

Reimplemented from MediaWiki\Search\SearchResult.

Definition at line 149 of file RevisionSearchResult.php.

getSectionTitle()

MediaWiki\Search\RevisionSearchResult::getSectionTitle

(

)

Returns

Title|null Title object (pagename+fragment) for the section, null if none or not supported

Reimplemented from MediaWiki\Search\SearchResult.

Definition at line 157 of file RevisionSearchResult.php.

getTextSnippet()

MediaWiki\Search\RevisionSearchResult::getTextSnippet

(

$terms = []

)

Parameters

string[]

$terms

Terms to highlight (this parameter is deprecated and ignored)

Returns

string Highlighted text snippet, null (and not '') if not supported

Reimplemented from MediaWiki\Search\SearchResult.

Reimplemented in MediaWiki\Search\SqlSearchResult.

Definition at line 121 of file RevisionSearchResult.php.

getTimestamp()

MediaWiki\Search\RevisionSearchResult::getTimestamp

(

)

Returns

string Timestamp

Reimplemented from MediaWiki\Search\SearchResult.

Definition at line 171 of file RevisionSearchResult.php.

getTitle()

MediaWiki\Search\RevisionSearchResult::getTitle

(

)

Returns

Title|null

Reimplemented from MediaWiki\Search\SearchResult.

Definition at line 91 of file RevisionSearchResult.php.

References MediaWiki\Search\RevisionSearchResult\$mTitle.

getTitleSnippet()

MediaWiki\Search\RevisionSearchResult::getTitleSnippet

(

)

Returns

string Highlighted title, '' if not supported

Reimplemented from MediaWiki\Search\SearchResult.

Definition at line 128 of file RevisionSearchResult.php.

getWordCount()

MediaWiki\Search\RevisionSearchResult::getWordCount

(

)

Returns

int Number of words

Reimplemented from MediaWiki\Search\SearchResult.

Definition at line 183 of file RevisionSearchResult.php.

References MediaWiki\Search\RevisionSearchResult\initText().

initFromTitle()

MediaWiki\Search\RevisionSearchResult::initFromTitle ( $title )

protected

Initialize from a Title and if possible initializes a corresponding RevisionRecord and File.

Parameters

Title | null

$title

Reimplemented in MediaWiki\Search\FauxSearchResult.

Definition at line 52 of file RevisionSearchResult.php.

References MediaWiki\MediaWikiServices\getInstance(), and NS_FILE.

Referenced by MediaWiki\Search\RevisionSearchResult\__construct().

initText()

MediaWiki\Search\RevisionSearchResult::initText ( )

protected

Lazy initialization of article text from DB.

Definition at line 106 of file RevisionSearchResult.php.

Referenced by MediaWiki\Search\RevisionSearchResult\getByteSize(), and MediaWiki\Search\RevisionSearchResult\getWordCount().

isBrokenTitle()

MediaWiki\Search\RevisionSearchResult::isBrokenTitle

(

)

Check if this is result points to an invalid title.

Returns

bool

Reimplemented from MediaWiki\Search\SearchResult.

Definition at line 75 of file RevisionSearchResult.php.

isFileMatch()

MediaWiki\Search\RevisionSearchResult::isFileMatch

(

)

Did this match file contents (eg: PDF/DJVU)?

Returns

bool

Reimplemented from MediaWiki\Search\SearchResult.

Definition at line 214 of file RevisionSearchResult.php.

isMissingRevision()

MediaWiki\Search\RevisionSearchResult::isMissingRevision

(

)

Check if target page is missing, happens when index is out of date.

Returns

bool

Reimplemented from MediaWiki\Search\SearchResult.

Definition at line 84 of file RevisionSearchResult.php.

References MediaWiki\Search\RevisionSearchResult\$mImage.

Member Data Documentation

$mImage

MediaWiki FileRepo File File null MediaWiki\Search\RevisionSearchResult::$mImage = null

protected

Definition at line 26 of file RevisionSearchResult.php.

Referenced by MediaWiki\Search\RevisionSearchResult\getFile(), and MediaWiki\Search\RevisionSearchResult\isMissingRevision().

$mRevisionRecord

MediaWiki Revision RevisionRecord null MediaWiki\Search\RevisionSearchResult::$mRevisionRecord = null

protected

Definition at line 21 of file RevisionSearchResult.php.

$mText

string null MediaWiki\Search\RevisionSearchResult::$mText

protected

Definition at line 36 of file RevisionSearchResult.php.

$mTitle

Title null MediaWiki\Search\RevisionSearchResult::$mTitle

protected

Definition at line 31 of file RevisionSearchResult.php.

Referenced by MediaWiki\Search\RevisionSearchResult\getTitle().

---

The documentation for this class was generated from the following file:

• includes/Search/RevisionSearchResult.php