MediaWiki  master
MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget Class Reference

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:

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. More...
 
 generateIconFromFavicon ( $logoUrl)
 Fetches the favicon of the provided URL. More...
 
 generateLogoName ( $prefix)
 Generates the logo name used to render the interwiki icon. More...
 
 headerHtml ( $term, $iwPrefix)
 Generates an HTML header for the given interwiki prefix. More...
 
 iwIcon ( $iwPrefix)
 Generates a custom OOUI icon element. More...
 
 loadCustomCaptions ()
 

Protected Attributes

string[] null $customCaptions
 
array $iwLogoOverrides
 
InterwikiLookup $iwLookup
 
LinkRenderer $linkRenderer
 
MediaWiki Output 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()

Member Function Documentation

◆ footerHtml()

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

Generates an HTML footer for the given interwiki prefix.

Parameters
string$termUser provided search term
string$iwPrefixInterwiki prefix of wiki to show heading for
Returns
string HTML

Definition at line 148 of file InterwikiSearchResultSetWidget.php.

References MediaWiki\Title\Title\makeTitle(), NS_SPECIAL, MediaWiki\Html\Html\rawElement(), wfExpandUrl(), and wfParseUrl().

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

References wfExpandUrl(), and wfParseUrl().

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$prefixInterwiki prefix
Returns
string logoName

Definition at line 212 of file InterwikiSearchResultSetWidget.php.

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

◆ headerHtml()

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

Generates an HTML header for the given interwiki prefix.

Parameters
string$termUser provided search term
string$iwPrefixInterwiki prefix of wiki to show heading for
Returns
string HTML

Definition at line 124 of file InterwikiSearchResultSetWidget.php.

References MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget\iwIcon(), MediaWiki\Title\Title\makeTitle(), NS_SPECIAL, MediaWiki\Html\Html\rawElement(), wfExpandUrl(), and wfParseUrl().

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

◆ iwIcon()

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

Generates a custom OOUI icon element.

These icons are either generated by fetching the interwiki favicon. or by using config 'InterwikiLogoOverrides'.

Parameters
string$iwPrefixInterwiki prefix
Returns
OOUI\IconWidget

Definition at line 188 of file InterwikiSearchResultSetWidget.php.

References MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget\generateIconFromFavicon(), and MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget\generateLogoName().

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

◆ loadCustomCaptions()

MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget::loadCustomCaptions ( )
protected

◆ render()

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

Member Data Documentation

◆ $customCaptions

string [] null MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget::$customCaptions
protected

Definition at line 24 of file InterwikiSearchResultSetWidget.php.

◆ $iwLogoOverrides

array MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget::$iwLogoOverrides
protected

Definition at line 34 of file InterwikiSearchResultSetWidget.php.

◆ $iwLookup

InterwikiLookup MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget::$iwLookup
protected

◆ $linkRenderer

LinkRenderer MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget::$linkRenderer
protected

◆ $output

MediaWiki Output OutputPage MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget::$output
protected

Definition at line 30 of file InterwikiSearchResultSetWidget.php.

◆ $resultWidget

SearchResultWidget MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget::$resultWidget
protected

◆ $showMultimedia

bool MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget::$showMultimedia
protected

◆ $specialSearch

SpecialSearch MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget::$specialSearch
protected

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