MediaWiki master
MediaWiki\Search\SqlSearchResult Class Reference

Inherits MediaWiki\Search\RevisionSearchResult.

Collaboration diagram for MediaWiki\Search\SqlSearchResult:

Public Member Functions

 __construct (Title $title, array $terms)
 
 getTermMatches ()
 
 getTextSnippet ( $terms=[])
 
- Public Member Functions inherited from MediaWiki\Search\RevisionSearchResult
 __construct ( $title)
 
 getByteSize ()
 
 getCategorySnippet ()
 
 getFile ()
 Get the file for this page, if one exists.
 
 getInterwikiNamespaceText ()
 
 getInterwikiPrefix ()
 
 getRedirectSnippet ()
 
 getRedirectTitle ()
 
 getSectionSnippet ()
 
 getSectionTitle ()
 
 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 ()
 

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.
 
- Protected Member Functions inherited from MediaWiki\Search\RevisionSearchResult
 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 inherited from MediaWiki\Search\RevisionSearchResult
MediaWiki FileRepo File File null $mImage = null
 
MediaWiki Revision RevisionRecord null $mRevisionRecord = null
 
string null $mText
 
Title null $mTitle
 

Detailed Description

Definition at line 16 of file SqlSearchResult.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Search\SqlSearchResult::__construct ( Title $title,
array $terms )
Parameters
Title$title
string[]$termslist of parsed terms

Definition at line 24 of file SqlSearchResult.php.

Member Function Documentation

◆ getTermMatches()

MediaWiki\Search\SqlSearchResult::getTermMatches ( )
Returns
string[]

Definition at line 32 of file SqlSearchResult.php.

◆ getTextSnippet()

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

Reimplemented from MediaWiki\Search\RevisionSearchResult.

Definition at line 40 of file SqlSearchResult.php.

References MediaWiki\MainConfigNames\AdvancedSearchHighlighting, and MediaWiki\MediaWikiServices\getInstance().


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