Renders one or more ISearchResultSets into a sidebar grouped by interwiki prefix. More...

Inheritance diagram for MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget:

Collaboration diagram for MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget:

[legend]

Public Member Functions
	__construct (SpecialSearch $specialSearch, SearchResultWidget $resultWidget, LinkRenderer $linkRenderer, InterwikiLookup $iwLookup, $showMultimedia=false)

	render ( $term, $resultSets)

Protected Member Functions
	footerHtml ( $term, $iwPrefix)
	Generates an HTML footer for the given interwiki prefix.

	headerHtml ( $term, $iwPrefix)
	Generates an HTML header for the given interwiki prefix.

	iwIcon ( $iwPrefix)
	Generates a custom OOUI icon element with a favicon as the image.

	loadCustomCaptions ()

Protected Attributes
string[] null	$customCaptions

InterwikiLookup	$iwLookup

LinkRenderer	$linkRenderer

OutputPage	$output

SearchResultWidget	$resultWidget

bool	$showMultimedia

SpecialSearch	$specialSearch

Detailed Description

Renders one or more ISearchResultSets into a sidebar grouped by interwiki prefix.

Includes a per-wiki header indicating where the results are from.

Definition at line 18 of file InterwikiSearchResultSetWidget.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget::__construct	(	SpecialSearch	$specialSearch,
		SearchResultWidget	$resultWidget,
		LinkRenderer	$linkRenderer,
		InterwikiLookup	$iwLookup,
			$showMultimedia = false )

Definition at line 34 of file InterwikiSearchResultSetWidget.php.

References MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget\$iwLookup, MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget\$linkRenderer, MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget\$resultWidget, MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget\$showMultimedia, MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget\$specialSearch, and SpecialPage\getOutput().

Member Function Documentation

◆ footerHtml()

MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget::footerHtml	(		$term,
			$iwPrefix )

protected

Generates an HTML footer for the given interwiki prefix.

Parameters

string	$term	User provided search term
string	$iwPrefix	Interwiki prefix of wiki to show heading for

Returns: string HTML

Definition at line 144 of file InterwikiSearchResultSetWidget.php.

References NS_SPECIAL, wfExpandUrl(), and wfParseUrl().

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

◆ headerHtml()

MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget::headerHtml	(		$term,
			$iwPrefix )

protected

Generates an HTML header for the given interwiki prefix.

Parameters

string	$term	User provided search term
string	$iwPrefix	Interwiki prefix of wiki to show heading for

Returns: string HTML

Definition at line 120 of file InterwikiSearchResultSetWidget.php.

References MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget\iwIcon(), NS_SPECIAL, wfExpandUrl(), and wfParseUrl().

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

◆ iwIcon()

MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget::iwIcon ( $iwPrefix )

protected

Generates a custom OOUI icon element with a favicon as the image.

The favicon image URL is generated by parsing the interwiki URL and returning the default location of the favicon for that domain, which is assumed to be '/favicon.ico'.

Parameters

string $iwPrefix Interwiki prefix