MediaWiki\Widget\Search\InterwikiSearchResultSetWidget Class Reference

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

Inheritance diagram for MediaWiki\Widget\Search\InterwikiSearchResultSetWidget:

Collaboration diagram for MediaWiki\Widget\Search\InterwikiSearchResultSetWidget:

Public Member Functions
	__construct (SpecialSearch $specialSearch, SearchResultWidget $resultWidget, LinkRenderer $linkRenderer, InterwikiLookup $iwLookup)
	render ( $term, $resultSets)

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

Protected Attributes
string[] null	$customCaptions
InterwikiLookup	$iwLookup
$iwPrefixDisplayTypes	$iwPrefixDisplayTypes
LinkRenderer	$linkRenderer
$output	$output
SearchResultWidget	$resultWidget
SpecialSearch	$specialSearch

Detailed Description

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

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

Definition at line 17 of file InterwikiSearchResultSetWidget.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Widget\Search\InterwikiSearchResultSetWidget::__construct	(	SpecialSearch	$specialSearch,
		SearchResultWidget	$resultWidget,
		LinkRenderer	$linkRenderer,
		InterwikiLookup	$iwLookup
	)

Definition at line 33 of file InterwikiSearchResultSetWidget.php.

References MediaWiki\Widget\Search\InterwikiSearchResultSetWidget\$iwLookup, MediaWiki\Widget\Search\InterwikiSearchResultSetWidget\$linkRenderer, MediaWiki\Widget\Search\InterwikiSearchResultSetWidget\$resultWidget, MediaWiki\Widget\Search\InterwikiSearchResultSetWidget\$specialSearch, SpecialPage\getConfig(), SpecialPage\getOutput(), and output().

Member Function Documentation

footerHtml()

MediaWiki\Widget\Search\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 footer for

Returns

string HTML

Definition at line 155 of file InterwikiSearchResultSetWidget.php.

References $term, Title\makeTitle(), NS_SPECIAL, and Html\rawElement().

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

headerHtml()

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

protected

Generates an appropriate HTML header for the given interwiki prefix.

Parameters

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

Returns

string HTML

Definition at line 127 of file InterwikiSearchResultSetWidget.php.

References Html\rawElement(), wfExpandUrl(), and wfParseUrl().

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

loadCustomCaptions()

MediaWiki\Widget\Search\InterwikiSearchResultSetWidget::loadCustomCaptions ( )

protected

Definition at line 170 of file InterwikiSearchResultSetWidget.php.

References $line, as, and captcha-old\count.

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

render()

MediaWiki\Widget\Search\InterwikiSearchResultSetWidget::render	(		$term,
			$resultSets
	)

Parameters

string	$term	User provided search term
SearchResultSet | SearchResultSet[]	$resultSets	List of interwiki results to render.

Returns

string HTML

Implements MediaWiki\Widget\Search\SearchResultSetWidget.

Definition at line 54 of file InterwikiSearchResultSetWidget.php.

References $term, OutputPage\addModules(), OutputPage\addModuleStyles(), as, MediaWiki\Widget\Search\InterwikiSearchResultSetWidget\footerHtml(), MediaWiki\Widget\Search\InterwikiSearchResultSetWidget\headerHtml(), MediaWiki\Widget\Search\InterwikiSearchResultSetWidget\loadCustomCaptions(), output(), and Html\rawElement().

Member Data Documentation

$customCaptions

string [] null MediaWiki\Widget\Search\InterwikiSearchResultSetWidget::$customCaptions

protected

Definition at line 23 of file InterwikiSearchResultSetWidget.php.

$iwLookup

InterwikiLookup MediaWiki\Widget\Search\InterwikiSearchResultSetWidget::$iwLookup

protected

Definition at line 27 of file InterwikiSearchResultSetWidget.php.

Referenced by MediaWiki\Widget\Search\InterwikiSearchResultSetWidget\__construct().

$iwPrefixDisplayTypes

$iwPrefixDisplayTypes MediaWiki\Widget\Search\InterwikiSearchResultSetWidget::$iwPrefixDisplayTypes

protected

Definition at line 31 of file InterwikiSearchResultSetWidget.php.

$linkRenderer

LinkRenderer MediaWiki\Widget\Search\InterwikiSearchResultSetWidget::$linkRenderer

protected

Definition at line 25 of file InterwikiSearchResultSetWidget.php.

Referenced by MediaWiki\Widget\Search\InterwikiSearchResultSetWidget\__construct().

$output

$output MediaWiki\Widget\Search\InterwikiSearchResultSetWidget::$output

protected

Definition at line 29 of file InterwikiSearchResultSetWidget.php.

$resultWidget

SearchResultWidget MediaWiki\Widget\Search\InterwikiSearchResultSetWidget::$resultWidget

protected

Definition at line 21 of file InterwikiSearchResultSetWidget.php.

Referenced by MediaWiki\Widget\Search\InterwikiSearchResultSetWidget\__construct().

$specialSearch

SpecialSearch MediaWiki\Widget\Search\InterwikiSearchResultSetWidget::$specialSearch

protected

Definition at line 19 of file InterwikiSearchResultSetWidget.php.

Referenced by MediaWiki\Widget\Search\InterwikiSearchResultSetWidget\__construct().

---

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

• includes/widget/search/InterwikiSearchResultSetWidget.php