MediaWiki\Search\SearchWidgets\FullSearchResultWidget Class Reference

Renders a 'full' multi-line search result with metadata. More...

Inheritance diagram for MediaWiki\Search\SearchWidgets\FullSearchResultWidget:

Collaboration diagram for MediaWiki\Search\SearchWidgets\FullSearchResultWidget:

Public Member Functions
	__construct (SpecialSearch $specialPage, LinkRenderer $linkRenderer, HookContainer $hookContainer)
	render (SearchResult $result, $position)

Protected Member Functions
	buildMeta ( $desc, $date)
	generateAltTitleHtml ( $msgKey, ?Title $title, $text)
	Generates an alternate title link, such as (redirect from Foo).
	generateCategoryHtml (SearchResult $result)
	generateFileHtml (SearchResult $result)
	generateMainLinkHtml (SearchResult $result, $position)
	Generates HTML for the primary call to action.
	generateRedirectHtml (SearchResult $result)
	generateSectionHtml (SearchResult $result)
	generateSizeHtml (SearchResult $result)

Protected Attributes
LinkRenderer	$linkRenderer
SpecialSearch	$specialPage

Private Attributes
HookRunner	$hookRunner

Detailed Description

Renders a 'full' multi-line search result with metadata.

The Title some highlighted text about the search result 5KB (651 words) - 12:40, 6 Aug 2016

Definition at line 22 of file FullSearchResultWidget.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Search\SearchWidgets\FullSearchResultWidget::__construct	(	SpecialSearch	$specialPage,
		LinkRenderer	$linkRenderer,
		HookContainer	$hookContainer
	)

Definition at line 30 of file FullSearchResultWidget.php.

References MediaWiki\Search\SearchWidgets\FullSearchResultWidget\$linkRenderer, and MediaWiki\Search\SearchWidgets\FullSearchResultWidget\$specialPage.

Member Function Documentation

buildMeta()

MediaWiki\Search\SearchWidgets\FullSearchResultWidget::buildMeta (   $desc,   $date  )

protected

Parameters

string	$desc	HTML description of result, ex: size in bytes, or empty string
string	$date	HTML representation of last edit date, or empty string

Returns

string HTML A div combining $desc and $date with a separator in a

. If either is missing only one will be represented. If both are missing an empty string will be returned.

Definition at line 286 of file FullSearchResultWidget.php.

Referenced by MediaWiki\Search\SearchWidgets\FullSearchResultWidget\render().

generateAltTitleHtml()

MediaWiki\Search\SearchWidgets\FullSearchResultWidget::generateAltTitleHtml (   $msgKey, ?Title  $title,   $text  )

protected

Generates an alternate title link, such as (redirect from Foo).

Parameters

string	$msgKey	i18n message used to wrap title
Title | null	$title	The title to link to, or null to generate the message without a link. In that case $text must be non-null.
string | null	$text	The text snippet to display, or null to use the title

Returns

string HTML

Definition at line 173 of file FullSearchResultWidget.php.

References $title.

Referenced by MediaWiki\Search\SearchWidgets\FullSearchResultWidget\generateCategoryHtml(), MediaWiki\Search\SearchWidgets\FullSearchResultWidget\generateRedirectHtml(), and MediaWiki\Search\SearchWidgets\FullSearchResultWidget\generateSectionHtml().

generateCategoryHtml()

MediaWiki\Search\SearchWidgets\FullSearchResultWidget::generateCategoryHtml ( SearchResult  $result )

protected

Parameters

SearchResult

$result

Returns

string HTML

Definition at line 209 of file FullSearchResultWidget.php.

References MediaWiki\Search\SearchWidgets\FullSearchResultWidget\generateAltTitleHtml().

Referenced by MediaWiki\Search\SearchWidgets\FullSearchResultWidget\render().

generateFileHtml()

MediaWiki\Search\SearchWidgets\FullSearchResultWidget::generateFileHtml ( SearchResult  $result )

protected

Parameters

SearchResult

$result

Returns

array Three element array containing the main file html, a text description of the file, and finally the thumbnail html. If no thumbnail is available the second and third will be null.

Definition at line 247 of file FullSearchResultWidget.php.

References $title, MediaWiki\MediaWikiServices\getInstance(), and NS_FILE.

Referenced by MediaWiki\Search\SearchWidgets\FullSearchResultWidget\render().

generateMainLinkHtml()

MediaWiki\Search\SearchWidgets\FullSearchResultWidget::generateMainLinkHtml ( SearchResult  $result,   $position  )

protected

Generates HTML for the primary call to action.

It is typically the article title, but the search engine can return an exact snippet to use (typically the article title with highlighted words).

Parameters

SearchResult	$result
int	$position

Returns

string HTML

Definition at line 136 of file FullSearchResultWidget.php.

References MediaWiki\Search\SearchWidgets\FullSearchResultWidget\$specialPage, and $title.

Referenced by MediaWiki\Search\SearchWidgets\FullSearchResultWidget\render().

generateRedirectHtml()

MediaWiki\Search\SearchWidgets\FullSearchResultWidget::generateRedirectHtml ( SearchResult  $result )

protected

Parameters

SearchResult

$result

Returns

string HTML

Definition at line 187 of file FullSearchResultWidget.php.

References $title, and MediaWiki\Search\SearchWidgets\FullSearchResultWidget\generateAltTitleHtml().

Referenced by MediaWiki\Search\SearchWidgets\FullSearchResultWidget\render().

generateSectionHtml()

MediaWiki\Search\SearchWidgets\FullSearchResultWidget::generateSectionHtml ( SearchResult  $result )

protected

Parameters

SearchResult

$result

Returns

string HTML

Definition at line 198 of file FullSearchResultWidget.php.

References $title, and MediaWiki\Search\SearchWidgets\FullSearchResultWidget\generateAltTitleHtml().

Referenced by MediaWiki\Search\SearchWidgets\FullSearchResultWidget\render().

generateSizeHtml()

MediaWiki\Search\SearchWidgets\FullSearchResultWidget::generateSizeHtml ( SearchResult  $result )

protected

Parameters

SearchResult

$result

Returns

string HTML

Definition at line 220 of file FullSearchResultWidget.php.

References $lang, $title, and NS_CATEGORY.

Referenced by MediaWiki\Search\SearchWidgets\FullSearchResultWidget\render().

render()

MediaWiki\Search\SearchWidgets\FullSearchResultWidget::render	(	SearchResult	$result,
			$position
	)

Parameters

SearchResult	$result	The result to render
int	$position	The result position, including offset

Returns

string HTML

Implements MediaWiki\Search\SearchWidgets\SearchResultWidget.

Definition at line 43 of file FullSearchResultWidget.php.

References $file, MediaWiki\Search\SearchWidgets\FullSearchResultWidget\buildMeta(), MediaWiki\Search\SearchWidgets\FullSearchResultWidget\generateCategoryHtml(), MediaWiki\Search\SearchWidgets\FullSearchResultWidget\generateFileHtml(), MediaWiki\Search\SearchWidgets\FullSearchResultWidget\generateMainLinkHtml(), MediaWiki\Search\SearchWidgets\FullSearchResultWidget\generateRedirectHtml(), MediaWiki\Search\SearchWidgets\FullSearchResultWidget\generateSectionHtml(), MediaWiki\Search\SearchWidgets\FullSearchResultWidget\generateSizeHtml(), and MediaWiki\MediaWikiServices\getInstance().

Member Data Documentation

$hookRunner

HookRunner MediaWiki\Search\SearchWidgets\FullSearchResultWidget::$hookRunner

private

Definition at line 28 of file FullSearchResultWidget.php.

$linkRenderer

LinkRenderer MediaWiki\Search\SearchWidgets\FullSearchResultWidget::$linkRenderer

protected

Definition at line 26 of file FullSearchResultWidget.php.

Referenced by MediaWiki\Search\SearchWidgets\FullSearchResultWidget\__construct().

$specialPage

SpecialSearch MediaWiki\Search\SearchWidgets\FullSearchResultWidget::$specialPage

protected

Definition at line 24 of file FullSearchResultWidget.php.

Referenced by MediaWiki\Search\SearchWidgets\FullSearchResultWidget\__construct(), and MediaWiki\Search\SearchWidgets\FullSearchResultWidget\generateMainLinkHtml().

---

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

• includes/search/searchwidgets/FullSearchResultWidget.php