MediaWiki master
Functions | Variables
RevisionSearchResultTrait.php File Reference

Go to the source code of this file.

Functions

 getByteSize ()
 
 getCategorySnippet ()
 
 getCategorySnippetField ()
 
 getFile ()
 Get the file for this page, if one exists.
 
 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.
 
 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 null $mImage = null
 
string null $mText
 
Title null $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 219 of file RevisionSearchResultTrait.php.

References initText().

◆ getCategorySnippet()

getCategorySnippet ( )
Returns
string Highlighted relevant category name or '' if none or not supported

Definition at line 185 of file RevisionSearchResultTrait.php.

◆ getCategorySnippetField()

getCategorySnippetField ( )
Returns
string Name of the field containing the category snippet, '' if not supported

Definition at line 192 of file RevisionSearchResultTrait.php.

◆ getFile()

getFile ( )

Get the file for this page, if one exists.

Returns
File|null

Definition at line 92 of file RevisionSearchResultTrait.php.

References $mImage.

Referenced by MediaWiki\Page\WikiFilePage\getActionOverrides(), UploadStash\getFileProps(), UploadStash\getMetadata(), MediaWiki\Page\WikiFilePage\getSourceURL(), MediaWiki\Page\WikiFilePage\getWikiDisplayName(), MediaWiki\Rest\Handler\MediaFileHandler\hasRepresentation(), UploadStash\removeFileNoAuth(), MediaWiki\Rest\Handler\MediaFileHandler\run(), and UploadStash\stashFile().

◆ getInterwikiNamespaceText()

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

Definition at line 234 of file RevisionSearchResultTrait.php.

◆ getInterwikiPrefix()

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

Definition at line 227 of file RevisionSearchResultTrait.php.

◆ getRedirectSnippet()

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

Definition at line 142 of file RevisionSearchResultTrait.php.

◆ getRedirectSnippetField()

getRedirectSnippetField ( )
Returns
string Name of the field containing the redirect snippet, '' if not supported

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

◆ getSectionSnippet()

getSectionSnippet ( )
Returns
string Highlighted relevant section name, null if none or not supported

Definition at line 163 of file RevisionSearchResultTrait.php.

◆ getSectionSnippetField()

getSectionSnippetField ( )
Returns
string Name of the field containing the section snippet, '' if not supported

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

◆ getTextSnippet()

getTextSnippet ( $terms = [])
Parameters
string[]$termsTerms to highlight (this parameter is deprecated and ignored)
Returns
string Highlighted text snippet, null (and not '') if not supported

Definition at line 114 of file RevisionSearchResultTrait.php.

◆ getTextSnippetField()

getTextSnippetField ( )
Returns
string Name of the field containing the text snippet, '' if not supported

Definition at line 121 of file RevisionSearchResultTrait.php.

◆ getTimestamp()

getTimestamp ( )
Returns
string Timestamp

Definition at line 199 of file RevisionSearchResultTrait.php.

References MediaWiki\FileRepo\File\File\getTimestamp().

Referenced by MediaWiki\FileRepo\File\File\getFilePageThumbUrl(), MediaWiki\Logging\ManualLogEntry\getRecentChange(), RevDelRevisionItem\getRevisionLink(), MediaWiki\Logging\ManualLogEntry\insert(), MediaWiki\RecentChanges\ChangesList\insertTimestamp(), MediaWiki\Revision\RevisionRecord\isReadyForInsertion(), and MediaWiki\Session\Token\match().

◆ getTitle()

getTitle ( )
Returns
Title|null

Definition at line 84 of file RevisionSearchResultTrait.php.

References $mTitle.

Referenced by UploadForm\__construct(), PreferencesFormOOUI\addFields(), MediaWiki\Page\Article\addHelpLink(), MediaWiki\Output\OutputPage\addParserOutputMetadata(), MediaWiki\Skin\Skin\addToSidebarPlain(), MediaWiki\Output\OutputPage\addWikiTextAsContent(), MediaWiki\Output\OutputPage\addWikiTextAsInterface(), MediaWiki\Actions\McrUndoAction\alterForm(), MediaWiki\Parser\Parser\braceSubstitution(), MediaWiki\Skin\SkinTemplate\buildCreateAccountData(), MediaWiki\Skin\SkinTemplate\buildLogoutLinkData(), MediaWiki\Skin\Skin\buildNavUrls(), MediaWiki\Actions\Action\checkCanExecute(), MediaWiki\Page\WikiPage\doDeleteArticleReal(), MediaWiki\Storage\DerivedPageDataUpdater\doUpdates(), MediaWiki\Actions\ActionEntryPoint\execute(), MediaWiki\Page\Article\fetchRevisionRecord(), MediaWiki\Parser\Parser\fetchTemplateAndTitle(), MediaWiki\Pager\HistoryPager\formatRow(), MediaWiki\HTMLForm\HTMLForm\getAction(), MediaWiki\Page\WikiPage\getAutoDeleteReason(), MediaWiki\Skin\Skin\getCategories(), MediaWiki\Skin\Skin\getCategoryLinks(), MediaWiki\Page\WikiPage\getCreator(), DifferenceEngine\getDefaultLanguage(), MediaWiki\Skin\Skin\getDefaultModules(), MediaWiki\FileRepo\File\LocalFile\getDescriptionText(), MediaWiki\Output\OutputPage\getDisplayTitle(), MediaWiki\Specials\SpecialUpload\getExistsWarning(), MediaWiki\EditPage\EditPage\getExpectedParentRevision(), MediaWiki\Parser\Parser\getExternalLinkAttribs(), MediaWiki\Pager\ImageListPager\getForm(), MediaWiki\Pager\UploadStashPager\getForm(), MediaWiki\Output\OutputPage\getHeadLinksArray(), MediaWiki\Output\OutputPage\getJSVars(), MediaWiki\Skin\Skin\getLanguages(), UploadBase\getLocalFile(), MediaWiki\Page\Article\getOldIDFromRequest(), MediaWiki\Actions\Action\getPageTitle(), MediaWiki\Actions\InfoAction\getPageTitle(), MediaWiki\Page\WikiPage\getParserOutput(), MediaWiki\EditPage\EditPage\getPreviewText(), MediaWiki\Skin\SkinComponentRegistryContext\getRelevantTitle(), MediaWiki\Skin\Skin\getRelevantTitle(), MediaWiki\Parser\Parser\getRevisionRecordObject(), MediaWiki\Page\Article\getRobotPolicy(), MediaWiki\Page\WikiPage\getSourceURL(), MediaWiki\Parser\Parser\getTargetLanguage(), MediaWiki\Skin\Skin\getTemplateData(), MediaWiki\Skin\Skin\getUndeleteLink(), MediaWiki\Output\OutputPage\getUnprefixedDisplayTitle(), MediaWiki\Page\WikiPage\getWikiId(), MediaWiki\Output\OutputPage\headElement(), WikiRevision\importLogItem(), MediaWiki\Page\Article\isFileCacheable(), MediaWiki\Page\WikiPage\isRedirect(), MediaWiki\Page\WikiPage\loadLastEdit(), DifferenceEngine\loadRevisionData(), MediaWiki\Page\WikiPage\lockAndGetLatest(), MediaWiki\Pager\IndexPager\makeLink(), MediaWiki\Page\WikiPage\makeParserOptions(), MediaWiki\Actions\WatchAction\makeSuccessMessage(), MediaWiki\Actions\McrUndoAction\onSubmit(), MediaWiki\Actions\McrUndoAction\onSuccess(), MediaWiki\Output\OutputPage\parseAsContent(), MediaWiki\Output\OutputPage\parseAsInterface(), MediaWiki\Actions\ActionEntryPoint\performAction(), UploadBase\performUpload(), MediaWiki\Specials\SpecialBlock\postHtml(), MediaWiki\Storage\DerivedPageDataUpdater\prepareContent(), MediaWiki\FileRepo\File\LocalFile\prerenderThumbnails(), MediaWiki\FileRepo\File\File\purgeDescription(), MediaWiki\FileRepo\File\File\purgeEverything(), MediaWiki\RecentChanges\RecentChange\reallyMarkPatrolled(), MediaWiki\Parser\Parser\renderImageGallery(), DifferenceEngine\renderNewRevision(), MediaWiki\Actions\ActionEntryPoint\schedulePostSendJobs(), MediaWiki\Output\OutputPage\setFeedAppendQuery(), MediaWiki\Page\Article\setOldSubtitle(), MediaWiki\Page\Article\showDeletedRevisionHeader(), DifferenceEngine\showDiffPage(), MediaWiki\Actions\DeleteAction\showEditReasonsLinks(), MediaWiki\Specials\SpecialRevisionDelete\showForm(), MediaWiki\Specials\SpecialUndelete\showHistory(), MediaWiki\Page\Article\showMissingArticle(), MediaWiki\Page\Article\showNamespaceHeader(), MediaWiki\Page\Article\showPatrolFooter(), MediaWiki\Page\Article\showRedirectedFromHeader(), MediaWiki\Page\Article\showViewFooter(), MediaWiki\EditPage\EditPage\toEditContent(), MediaWiki\Page\Article\tryFileCache(), MediaWiki\Page\WikiPage\updateCategoryCounts(), MediaWiki\FileRepo\File\ArchivedFile\userCan(), MediaWiki\Output\OutputPage\userCanPreview(), UploadBase\validateName(), UploadBase\verifyPartialFile(), UploadBase\verifyTitlePermissions(), MediaWiki\Page\Article\view(), MediaWiki\FileRepo\File\File\wasDeleted(), MediaWiki\Output\OutputPage\wrapWikiMsg(), and MediaWiki\Output\OutputPage\wrapWikiTextAsInterface().

◆ getTitleSnippet()

getTitleSnippet ( )
Returns
string Highlighted title, '' if not supported

Definition at line 128 of file RevisionSearchResultTrait.php.

◆ getTitleSnippetField()

getTitleSnippetField ( )
Returns
string Name of the field containing the title snippet, '' if not supported

Definition at line 135 of file RevisionSearchResultTrait.php.

◆ getWordCount()

getWordCount ( )
Returns
int Number of words

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

References NS_FILE.

Referenced by RevisionSearchResult\__construct().

◆ initText()

initText ( )
protected

Lazy initialization of article text from DB.

Definition at line 99 of file RevisionSearchResultTrait.php.

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

◆ isBrokenTitle()

isBrokenTitle ( )

Check if this is result points to an invalid title.

Returns
bool

Definition at line 68 of file RevisionSearchResultTrait.php.

◆ isFileMatch()

isFileMatch ( )

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

Returns
bool

Definition at line 242 of file RevisionSearchResultTrait.php.

◆ isMissingRevision()

isMissingRevision ( )

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

Returns
bool

Definition at line 77 of file RevisionSearchResultTrait.php.

References $mImage.

Variable Documentation

◆ $mImage

File null $mImage = null
protected

Definition at line 27 of file RevisionSearchResultTrait.php.

Referenced by getFile(), and isMissingRevision().

◆ $mText

string null $mText
protected

Definition at line 37 of file RevisionSearchResultTrait.php.

◆ $mTitle

Title null $mTitle
protected

Definition at line 32 of file RevisionSearchResultTrait.php.

Referenced by MediaWiki\Page\WikiFilePage\getForeignCategories(), getTitle(), and UploadBase\getTitle().

◆ RevisionSearchResultTrait

trait RevisionSearchResultTrait
Initial value:
{
protected RevisionRecord|null $mRevisionRecord = null
MediaWiki\Revision\RevisionRecord
Page revision base class.
Definition RevisionRecord.php:49

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 18 of file RevisionSearchResultTrait.php.