Collaboration diagram for SearchResult:

Public Member Functions
	getByteSize ()

	getCategorySnippet ()

	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...

Static Public Member Functions
static	newFromTitle ($title)
	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
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 227 of file SearchResult.php.

References initText().

SearchResult::getCategorySnippet ( )

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

Definition at line 200 of file SearchResult.php.

SearchResult::getFile ( )

Get the file for this page, if one exists.

Returns: File|null

Definition at line 120 of file SearchResult.php.

References $mImage.

SearchResult::getInterwikiNamespaceText ( )

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

Definition at line 242 of file SearchResult.php.

SearchResult::getInterwikiPrefix ( )

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

Definition at line 235 of file SearchResult.php.

SearchResult::getRedirectSnippet ( )

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

Definition at line 171 of file SearchResult.php.

SearchResult::getRedirectTitle ( )

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

Definition at line 178 of file SearchResult.php.

SearchResult::getSectionSnippet ( )

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

Definition at line 185 of file SearchResult.php.

SearchResult::getSectionTitle ( )

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

Definition at line 193 of file SearchResult.php.

SearchResult::getTextSnippet ( $terms )

Parameters

array $terms Terms to highlight

Returns: string Highlighted text snippet, null (and not '') if not supported

Definition at line 142 of file SearchResult.php.

References $wgAdvancedSearchHighlighting, global, initText(), and list.

SearchResult::getTimestamp ( )

Returns: string Timestamp

Definition at line 207 of file SearchResult.php.

SearchResult::getTitle ( )

Returns: Title

Definition at line 112 of file SearchResult.php.

References $mTitle.

SearchResult::getTitleSnippet ( )

Returns: string Highlighted title, '' if not supported

Definition at line 164 of file SearchResult.php.

SearchResult::getWordCount ( )

Returns: int Number of words

Definition at line 219 of file SearchResult.php.

References initText().

SearchResult::initFromTitle ( $title )

protected

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

Parameters

Title $title

Definition at line 77 of file SearchResult.php.

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

SearchResult::initText ( )

protected

Lazy initialization of article text from DB.

Definition at line 127 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 96 of file SearchResult.php.

SearchResult::isFileMatch ( )

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

Returns: bool

Definition at line 250 of file SearchResult.php.

SearchResult::isMissingRevision ( )

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

Returns: bool

Definition at line 105 of file SearchResult.php.

References $mImage.

static SearchResult::newFromTitle ( $title )

static

Return a new SearchResult and initializes it with a title.

Parameters

Title $title

Returns: SearchResult

Definition at line 65 of file SearchResult.php.

References $title.

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

Member Data Documentation

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:

includes/search/SearchResult.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation