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

Inherits MediaWiki\Search\SearchWidgets\SearchResultSetWidget.

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.

	generateIconFromFavicon ( $logoUrl)
	Fetches the favicon of the provided URL.

	generateLogoName ( $prefix)
	Generates the logo name used to render the interwiki icon.

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

	iwIcon ( $iwPrefix)
	Generates a custom OOUI icon element.

	loadCustomCaptions ()

Protected Attributes
array< string, string > null	$customCaptions

array	$iwLogoOverrides

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 20 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 35 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, MediaWiki\SpecialPage\SpecialPage\getOutput(), and MediaWiki\MainConfigNames\InterwikiLogoOverride.

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 148 of file InterwikiSearchResultSetWidget.php.

References MediaWiki\Html\element(), and NS_SPECIAL.

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

◆ generateIconFromFavicon()

MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget::generateIconFromFavicon ( $logoUrl )

protected

Fetches the favicon of the provided URL.

Parameters

string $logoUrl

Returns: OOUI\IconWidget

Definition at line 224 of file InterwikiSearchResultSetWidget.php.

References PROTO_CURRENT, and wfGetUrlUtils().

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

◆ generateLogoName()

MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget::generateLogoName ( $prefix )

protected

Generates the logo name used to render the interwiki icon.

The logo name can be defined in two ways: 1) The logo is generated using interwiki getURL to fetch the site favicon 2) The logo name is defined using config wgInterwikiLogoOverride. This accept Codex icon names and URLs.

Parameters

string $prefix Interwiki prefix