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

Inheritance diagram for MediaWiki\Search\SearchWidgets\FullSearchResultWidget:

Collaboration diagram for MediaWiki\Search\SearchWidgets\FullSearchResultWidget:

[legend]

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

Detailed Description

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

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

Definition at line 24 of file FullSearchResultWidget.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 32 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 301 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 184 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 220 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 255 of file FullSearchResultWidget.php.

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

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