MediaWiki  1.28.1
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
SearchResult Class Reference
Search
Collaboration diagram for SearchResult:
Collaboration graph
[legend]

Public Member Functions

 getByteSize ()
 
 getCategorySnippet ()
 
 getExtensionData ()
 Get the extension data as: augmentor name => data. More...
 
 getFile ()
 Get the file for this page, if one exists. More...
 
 getInterwikiNamespaceText ()
 
 getInterwikiPrefix ()
 
 getRedirectSnippet ()
 
 getRedirectTitle ()
 
 getSectionSnippet ()
 
 getSectionTitle ()
 
 getTextSnippet ($terms)
 
 getTimestamp ()
 
 getTitle ()
 
 getTitleSnippet ()
 
 getWordCount ()
 
 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...
 
 setExtensionData (array $extensionData)
 Set extension data for this result. More...
 

Static Public Member Functions

static newFromTitle ($title, SearchResultSet $parentSet=null)
 Return a new SearchResult and initializes it with a title. More...
 

Protected Member Functions

 initFromTitle ($title)
 Initialize from a Title and if possible initializes a corresponding Revision and File. More...
 
 initText ()
 Lazy initialization of article text from DB. More...
 

Protected Attributes

array[] $extensionData
 A set of extension data. More...
 
File $mImage = null
 
Revision $mRevision = null
 
string $mText
 
Title $mTitle
 
SearchEngine $searchEngine
 

Detailed Description

Todo:
FIXME: This class is horribly factored. It would probably be better to have a useful base class to which you pass some standard information, then let the fancy self-highlighters extend that.

Definition at line 32 of file SearchResult.php.

Member Function Documentation

SearchResult::getByteSize ( )
Returns
int Size in bytes

Definition at line 237 of file SearchResult.php.

References initText().

Referenced by SpecialSearch\showHit().

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

Definition at line 210 of file SearchResult.php.

Referenced by SpecialSearch\showHit().

SearchResult::getExtensionData ( )

Get the extension data as: augmentor name => data.

Returns
array[]

Definition at line 269 of file SearchResult.php.

References $extensionData.

SearchResult::getFile ( )

Get the file for this page, if one exists.

Returns
File|null

Definition at line 130 of file SearchResult.php.

References $mImage.

Referenced by SpecialSearch\showHit().

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

Definition at line 252 of file SearchResult.php.

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

Definition at line 245 of file SearchResult.php.

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

Definition at line 181 of file SearchResult.php.

Referenced by SpecialSearch\showHit().

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

Definition at line 188 of file SearchResult.php.

Referenced by SpecialSearch\showHit().

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

Definition at line 195 of file SearchResult.php.

Referenced by SpecialSearch\showHit().

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

Definition at line 203 of file SearchResult.php.

Referenced by SpecialSearch\showHit().

SearchResult::getTextSnippet (   $terms)
Parameters
array$termsTerms to highlight
Returns
string Highlighted text snippet, null (and not '') if not supported

Definition at line 152 of file SearchResult.php.

References global, initText(), and list.

Referenced by SpecialSearch\showHit().

SearchResult::getTimestamp ( )
Returns
string Timestamp

Definition at line 217 of file SearchResult.php.

Referenced by SpecialSearch\showHit().

SearchResult::getTitle ( )
Returns
Title

Definition at line 122 of file SearchResult.php.

References $mTitle.

Referenced by SearchEngineTest\addAugmentors(), SearchResultSet\augmentResult(), SearchResultSet\extractTitles(), and SpecialSearch\showHit().

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

Definition at line 174 of file SearchResult.php.

Referenced by SpecialSearch\showHit().

SearchResult::getWordCount ( )
Returns
int Number of words

Definition at line 229 of file SearchResult.php.

References initText().

Referenced by SpecialSearch\showHit().

SearchResult::initFromTitle (   $title)
protected

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

Parameters
Title$title

Definition at line 87 of file SearchResult.php.

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

SearchResult::initText ( )
protected

Lazy initialization of article text from DB.

Definition at line 137 of file SearchResult.php.

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

SearchResult::isBrokenTitle ( )

Check if this is result points to an invalid title.

Returns
bool

Definition at line 106 of file SearchResult.php.

Referenced by SpecialSearch\showHit().

SearchResult::isFileMatch ( )

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

Returns
bool

Definition at line 260 of file SearchResult.php.

Referenced by SpecialSearch\showHit().

SearchResult::isMissingRevision ( )

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

Returns
bool

Definition at line 115 of file SearchResult.php.

References $mImage.

Referenced by SpecialSearch\showHit().

static SearchResult::newFromTitle (   $title,
SearchResultSet  $parentSet = null 
)
static

Return a new SearchResult and initializes it with a title.

Parameters
Title$title
SearchResultSet$parentSet
Returns
SearchResult

Definition at line 72 of file SearchResult.php.

References $title.

Referenced by SearchNearMatchResultSet\next(), SqlSearchResultSet\next(), and SpecialSearchTest\provideRewriteQueryWithSuggestion().

SearchResult::setExtensionData ( array  $extensionData)

Set extension data for this result.

The data is: augmentor name => data

Parameters
array[]$extensionData

Definition at line 279 of file SearchResult.php.

References $extensionData.

Referenced by SearchResultSet\augmentResult().

Member Data Documentation

array [] SearchResult::$extensionData
protected

A set of extension data.

Definition at line 63 of file SearchResult.php.

Referenced by getExtensionData(), and setExtensionData().

File SearchResult::$mImage = null
protected

Definition at line 42 of file SearchResult.php.

Referenced by getFile(), and isMissingRevision().

Revision SearchResult::$mRevision = null
protected

Definition at line 37 of file SearchResult.php.

string SearchResult::$mText
protected

Definition at line 52 of file SearchResult.php.

Title SearchResult::$mTitle
protected

Definition at line 47 of file SearchResult.php.

Referenced by getTitle().

SearchEngine SearchResult::$searchEngine
protected

Definition at line 57 of file SearchResult.php.

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