Functions
	getByteSize ()

	getCategorySnippet ()

	getCategorySnippetField ()

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

	getInterwikiNamespaceText ()

	getInterwikiPrefix ()

	getRedirectSnippet ()

	getRedirectSnippetField ()

	getRedirectTitle ()

	getSectionSnippet ()

	getSectionSnippetField ()

	getSectionTitle ()

	getTextSnippet ( $terms=[])

	getTextSnippetField ()

	getTimestamp ()

	getTitle ()

	getTitleSnippet ()

	getTitleSnippetField ()

	getWordCount ()

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

	initText ()
	Lazy initialization of article text from DB. More...

	isBrokenTitle ()
	Check if this is result points to an invalid title. More...

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

	isMissingRevision ()
	Check if target page is missing, happens when index is out of date. More...

Variables
File null	$mImage = null

string	$mText

Title null	$mTitle

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

Function Documentation

◆ getByteSize()

getByteSize ( )

Returns: int Size in bytes

Definition at line 218 of file RevisionSearchResultTrait.php.

References initText().

◆ getCategorySnippet()

getCategorySnippet ( )

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

Definition at line 184 of file RevisionSearchResultTrait.php.

◆ getCategorySnippetField()

getCategorySnippetField ( )

Returns: string Name of the field containing the category snippet, '' if not supported

Definition at line 191 of file RevisionSearchResultTrait.php.

◆ getFile()

getFile ( )

Get the file for this page, if one exists.

Returns: File|null

Definition at line 91 of file RevisionSearchResultTrait.php.

References $mImage.

Referenced by WikiFilePage\getActionOverrides(), WikiFilePage\getSourceURL(), WikiFilePage\getWikiDisplayName(), MediaWiki\Rest\Handler\MediaFileHandler\hasRepresentation(), and MediaWiki\Rest\Handler\MediaFileHandler\run().

◆ getInterwikiNamespaceText()

getInterwikiNamespaceText ( )

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

Definition at line 233 of file RevisionSearchResultTrait.php.

◆ getInterwikiPrefix()

getInterwikiPrefix ( )

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

Definition at line 226 of file RevisionSearchResultTrait.php.

◆ getRedirectSnippet()

getRedirectSnippet ( )

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

Definition at line 141 of file RevisionSearchResultTrait.php.

◆ getRedirectSnippetField()

getRedirectSnippetField ( )

Returns: string Name of the field containing the redirect snippet, '' if not supported

Definition at line 148 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 155 of file RevisionSearchResultTrait.php.

◆ getSectionSnippet()

getSectionSnippet ( )

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

Definition at line 162 of file RevisionSearchResultTrait.php.

◆ getSectionSnippetField()

getSectionSnippetField ( )

Returns: string Name of the field containing the section snippet, '' if not supported

Definition at line 169 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 177 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 113 of file RevisionSearchResultTrait.php.

◆ getTextSnippetField()

getTextSnippetField ( )

Returns: string Name of the field containing the text snippet, '' if not supported

Definition at line 120 of file RevisionSearchResultTrait.php.

◆ getTimestamp()

getTimestamp ( )

Returns: string Timestamp

Definition at line 198 of file RevisionSearchResultTrait.php.

Referenced by ApiCheckToken\execute(), File\getFilePageThumbUrl(), ManualLogEntry\getRecentChange(), RevDelRevisionItem\getRevisionLink(), MediaWiki\Revision\RevisionArchiveRecord\getTimestamp(), MediaWiki\Revision\RevisionStoreRecord\getTimestamp(), ManualLogEntry\insert(), ChangesList\insertTimestamp(), and MediaWiki\Revision\RevisionRecord\isReadyForInsertion().

◆ getTitle()

getTitle ( )

Returns: Title|null

Definition at line 83 of file RevisionSearchResultTrait.php.

References $mTitle.

Referenced by Article\addHelpLink(), OutputPage\addParserOutputMetadata(), Skin\addToSidebarPlain(), OutputPage\addWikiTextAsContent(), OutputPage\addWikiTextAsInterface(), Parser\braceSubstitution(), SkinTemplate\buildCreateAccountData(), SkinTemplate\buildLogoutLinkData(), Skin\buildNavUrls(), Action\checkCanExecute(), WikiPage\doDeleteArticleBatched(), WikiPage\doDeleteArticleReal(), RecentChange\doMarkPatrolled(), MediaWiki\Storage\DerivedPageDataUpdater\doUpdates(), Article\fetchRevisionRecord(), Parser\fetchTemplateAndTitle(), HTMLForm\getAction(), WikiPage\getAutoDeleteReason(), Skin\getCategoryLinks(), WikiPage\getCreator(), LocalFile\getDescriptionText(), OutputPage\getDisplayTitle(), SpecialUpload\getExistsWarning(), MediaWiki\EditPage\EditPage\getExpectedParentRevision(), Parser\getExternalLinkAttribs(), ImageListPager\getForm(), OutputPage\getHeadLinksArray(), OutputPage\getJSVars(), Skin\getLanguages(), SkinTemplate\getNameSpaceKey(), Article\getOldIDFromRequest(), Action\getPageTitle(), InfoAction\getPageTitle(), WikiPage\getParserOutput(), MediaWiki\EditPage\EditPage\getPreviewText(), MediaWiki\Skin\SkinComponentRegistryContext\getRelevantTitle(), Skin\getRelevantTitle(), Article\getRobotPolicy(), WikiPage\getSourceURL(), Parser\getTargetLanguage(), Skin\getTemplateData(), DifferenceEngine\getTitle(), Skin\getUndeleteLink(), OutputPage\getUnprefixedDisplayTitle(), WikiPage\getWikiId(), OutputPage\headElement(), WikiRevision\importLogItem(), MediaWiki\EditPage\EditPage\internalAttemptSave(), Article\isFileCacheable(), WikiPage\loadLastEdit(), WikiPage\lockAndGetLatest(), IndexPager\makeLink(), WikiPage\makeParserOptions(), WatchAction\onSuccess(), OutputPage\parseAsContent(), OutputPage\parseAsInterface(), MediaWiki\Storage\DerivedPageDataUpdater\prepareContent(), LocalFile\prerenderThumbnails(), File\purgeDescription(), File\purgeEverything(), RecentChange\reallyMarkPatrolled(), Parser\renderImageGallery(), OutputPage\setFeedAppendQuery(), Article\setOldSubtitle(), Article\showDeletedRevisionHeader(), DeleteAction\showEditReasonsLinks(), SpecialRevisionDelete\showForm(), Article\showMissingArticle(), Article\showNamespaceHeader(), Article\showPatrolFooter(), Article\showRedirectedFromHeader(), Article\showViewFooter(), MediaWiki\EditPage\EditPage\toEditContent(), Article\tryFileCache(), WikiPage\updateCategoryCounts(), WikiPage\updateRedirectOn(), ArchivedFile\userCan(), OutputPage\userCanPreview(), Article\view(), File\wasDeleted(), and OutputPage\wrapWikiTextAsInterface().

◆ getTitleSnippet()

getTitleSnippet ( )

Returns: string Highlighted title, '' if not supported

Definition at line 127 of file RevisionSearchResultTrait.php.

◆ getTitleSnippetField()

getTitleSnippetField ( )

Returns: string Name of the field containing the title snippet, '' if not supported

Definition at line 134 of file RevisionSearchResultTrait.php.

◆ getWordCount()

getWordCount ( )

Returns: int Number of words

Definition at line 210 of file RevisionSearchResultTrait.php.

References initText().

◆ initFromTitle()

initFromTitle ( $title )

protected

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

Parameters

Title | null $title

Definition at line 44 of file RevisionSearchResultTrait.php.

References $title, and NS_FILE.

Referenced by RevisionSearchResult\__construct().

◆ initText()

initText ( )

protected

Lazy initialization of article text from DB.

Definition at line 98 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 67 of file RevisionSearchResultTrait.php.

◆ isFileMatch()

isFileMatch ( )

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

Returns: bool

Definition at line 241 of file RevisionSearchResultTrait.php.

◆ isMissingRevision()

isMissingRevision ( )

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

Returns: bool

Definition at line 76 of file RevisionSearchResultTrait.php.

References $mImage.

Variable Documentation

◆ $mImage

File null $mImage = null

protected

Definition at line 26 of file RevisionSearchResultTrait.php.

Referenced by getFile(), and isMissingRevision().

◆ $mText

string $mText

protected

Definition at line 36 of file RevisionSearchResultTrait.php.

Referenced by ParserOutput\getRawText().

◆ $mTitle

Title null $mTitle

protected

Definition at line 31 of file RevisionSearchResultTrait.php.

Referenced by WikiFilePage\getForeignCategories(), and getTitle().

◆ RevisionSearchResultTrait

trait RevisionSearchResultTrait

Initial value:

{
    
    protected RevisionRecord|null $mRevisionRecord = 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 17 of file RevisionSearchResultTrait.php.

Functions

Variables

Function Documentation

◆ getByteSize()

◆ getCategorySnippet()

◆ getCategorySnippetField()

◆ getFile()

◆ getInterwikiNamespaceText()

◆ getInterwikiPrefix()

◆ getRedirectSnippet()

◆ getRedirectSnippetField()

◆ getRedirectTitle()

◆ getSectionSnippet()

◆ getSectionSnippetField()

◆ getSectionTitle()

◆ getTextSnippet()

◆ getTextSnippetField()

◆ getTimestamp()

◆ getTitle()

◆ getTitleSnippet()

◆ getTitleSnippetField()

◆ getWordCount()

◆ initFromTitle()

◆ initText()

◆ isBrokenTitle()

◆ isFileMatch()

◆ isMissingRevision()

Variable Documentation

◆ $mImage

◆ $mText

◆ $mTitle

◆ RevisionSearchResultTrait