Functions
	getByteSize ()

	getCategorySnippet ()

	getFile ()
	Get the file for this page, if one exists.

	getInterwikiNamespaceText ()

	getInterwikiPrefix ()

	getRedirectSnippet ()

	getRedirectTitle ()

	getSectionSnippet ()

	getSectionTitle ()

	getTextSnippet ( $terms=[])

	getTimestamp ()

	getTitle ()

	getTitleSnippet ()

	getWordCount ()

	initFromTitle ( $title)
	Initialize from a Title and if possible initializes a corresponding Revision and File.

	initText ()
	Lazy initialization of article text from DB.

	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.

Variables
File	$mImage = null

string	$mText

Title	$mTitle

trait	RevisionSearchResultTrait
	Transitional trait used to share the methods between SearchResult and RevisionSearchResult.

Function Documentation

◆ getByteSize()

getByteSize ( )

Returns: int Size in bytes

Definition at line 174 of file RevisionSearchResultTrait.php.

References initText().

◆ getCategorySnippet()

getCategorySnippet ( )

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

Definition at line 147 of file RevisionSearchResultTrait.php.

◆ getFile()

getFile ( )

Get the file for this page, if one exists.

Returns: File|null

Definition at line 82 of file RevisionSearchResultTrait.php.

References $mImage.

Referenced by HttpError\doLog(), UploadStash\getFileProps(), UploadStash\getMetadata(), UploadStash\removeFileNoAuth(), and UploadStash\stashFile().

◆ getInterwikiNamespaceText()

getInterwikiNamespaceText ( )

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

Definition at line 189 of file RevisionSearchResultTrait.php.

◆ getInterwikiPrefix()

getInterwikiPrefix ( )

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

Definition at line 182 of file RevisionSearchResultTrait.php.

◆ getRedirectSnippet()

getRedirectSnippet ( )

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

Definition at line 118 of file RevisionSearchResultTrait.php.

◆ getRedirectTitle()

getRedirectTitle ( )

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

Definition at line 125 of file RevisionSearchResultTrait.php.

◆ getSectionSnippet()

getSectionSnippet ( )

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

Definition at line 132 of file RevisionSearchResultTrait.php.

◆ getSectionTitle()

getSectionTitle ( )

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

Definition at line 140 of file RevisionSearchResultTrait.php.

◆ getTextSnippet()

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

Definition at line 104 of file RevisionSearchResultTrait.php.

◆ getTimestamp()

getTimestamp ( )

Returns: string Timestamp

Definition at line 154 of file RevisionSearchResultTrait.php.

References File\getTimestamp().

Referenced by ManualLogEntry\getRecentChange(), ManualLogEntry\insert(), ChangesList\insertTimestamp(), and MediaWiki\Session\Token\match().

◆ getTitle()

getTitle ( )

Returns: Title

Definition at line 74 of file RevisionSearchResultTrait.php.

References $mTitle.

Referenced by OutputPage\addAcceptLanguage(), OutputPage\addParserOutputMetadata(), Skin\addToSidebarPlain(), OutputPage\addWikiTextAsContent(), OutputPage\addWikiTextAsInterface(), WikiPage\archiveRevisions(), RequestContext\canUseWikiPage(), Action\checkCanExecute(), WikiPage\doDeleteArticleBatched(), RecentChange\doMarkPatrolled(), WikiPage\doPurge(), SpecialTags\doTagRow(), Parser\fetchTemplateAndTitle(), HTMLForm\getAction(), WikiPage\getAutoDeleteReason(), PreferencesFormOOUI\getButtons(), Skin\getCategories(), Skin\getCategoryLinks(), Skin\getCopyright(), WikiPage\getDeletionUpdates(), OutputPage\getDisplayTitle(), SpecialUpload\getExistsWarning(), ImageListPager\getForm(), OutputPage\getHeadLinksArray(), HTMLForm\getHiddenFields(), OutputPage\getJSVars(), WikiPage\getMutableCacheKeys(), Action\getPageTitle(), Skin\getRelevantTitle(), WikiPage\getSourceURL(), MediaWiki\Revision\RevisionStore\getTitle(), Skin\getUndeleteLink(), OutputPage\getUnprefixedDisplayTitle(), Parser\getUserSig(), RequestContext\getWikiPage(), OutputPage\headElement(), OutputPage\isRevisionCurrent(), Skin\lastModified(), WikiPage\loadLastEdit(), WikiPage\lockAndGetLatest(), MediaWiki\main(), WikiPage\makeParserOptions(), MediaWiki\Revision\RevisionStore\newMutableRevisionFromArray(), MediaWiki\Revision\RevisionStore\newRevisionFromRowAndSlots(), OutputPage\parse(), OutputPage\parseAsContent(), OutputPage\parseAsInterface(), OutputPage\parseInline(), SpecialBlock\postText(), Skin\printSource(), RecentChange\reallyMarkPatrolled(), Category\refreshCounts(), RecentChange\save(), OutputPage\setFeedAppendQuery(), SpecialRevisionDelete\showForm(), MediaWiki\triggerJobs(), WikiPage\updateCategoryCounts(), WikiPage\updateRedirectOn(), MWExceptionRenderer\useOutputPage(), OutputPage\userCanEditOrCreate(), OutputPage\userCanPreview(), and OutputPage\wrapWikiTextAsInterface().

◆ getTitleSnippet()

getTitleSnippet ( )

Returns: string Highlighted title, '' if not supported

Definition at line 111 of file RevisionSearchResultTrait.php.

◆ getWordCount()

getWordCount ( )

Returns: int Number of words

Definition at line 166 of file RevisionSearchResultTrait.php.

References initText().

◆ initFromTitle()

initFromTitle ( $title )

protected

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

Parameters

Title $title

Definition at line 39 of file RevisionSearchResultTrait.php.

References $title, Revision\newFromTitle(), and NS_FILE.

Referenced by RevisionSearchResult\__construct().

◆ initText()

initText ( )

protected

Lazy initialization of article text from DB.

Definition at line 89 of file RevisionSearchResultTrait.php.

References $content.

Referenced by getByteSize(), SqlSearchResult\getTextSnippet(), and getWordCount().

◆ isBrokenTitle()

isBrokenTitle ( )

Check if this is result points to an invalid title.

Returns: bool

Definition at line 58 of file RevisionSearchResultTrait.php.

◆ isFileMatch()

isFileMatch ( )

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

Returns: bool

Definition at line 197 of file RevisionSearchResultTrait.php.

◆ isMissingRevision()

isMissingRevision ( )

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

Returns: bool

Definition at line 67 of file RevisionSearchResultTrait.php.

References $mImage.

Variable Documentation

◆ $mImage

File $mImage = null

protected

Definition at line 21 of file RevisionSearchResultTrait.php.

Referenced by getFile(), and isMissingRevision().

◆ $mText

string $mText

protected

Definition at line 31 of file RevisionSearchResultTrait.php.

Referenced by ParserOutput\getRawText().

◆ $mTitle

Title $mTitle

protected

Definition at line 26 of file RevisionSearchResultTrait.php.

Referenced by WikiPage\__clone(), WikiPage\doDeleteArticleBatched(), LinksDeletionUpdate\doIncrementalUpdate(), Category\getTitle(), RecentChange\getTitle(), LinksUpdate\getTitle(), HTMLForm\getTitle(), WikiPage\getTitle(), and getTitle().

◆ RevisionSearchResultTrait

trait RevisionSearchResultTrait

Initial value:

{
    
    protected Revision $mRevision = null

Transitional trait used to share the methods between SearchResult and RevisionSearchResult.

All the content of this trait can be moved to RevisionSearchResult once SearchResult is finally refactored into an abstract class. NOTE: This trait MUST NOT be used by something else than SearchResult and RevisionSearchResult. It will be removed without deprecation period once SearchResult

Definition at line 12 of file RevisionSearchResultTrait.php.

Functions

Variables

Function Documentation

◆ getByteSize()

◆ getCategorySnippet()

◆ getFile()

◆ getInterwikiNamespaceText()

◆ getInterwikiPrefix()

◆ getRedirectSnippet()

◆ getRedirectTitle()

◆ getSectionSnippet()

◆ getSectionTitle()

◆ getTextSnippet()

◆ getTimestamp()

◆ getTitle()

◆ getTitleSnippet()

◆ getWordCount()

◆ initFromTitle()

◆ initText()

◆ isBrokenTitle()

◆ isFileMatch()

◆ isMissingRevision()

Variable Documentation

◆ $mImage

◆ $mText

◆ $mTitle

◆ RevisionSearchResultTrait