MediaWiki  master
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, $showMultimedia=false)
 
 render ( $term, $resultSets)
 

Protected Member Functions

 footerHtml ( $term, $iwPrefix)
 Generates an HTML footer for the given interwiki prefix. More...
 
 iwIcon ( $iwPrefix)
 Generates a custom OOUI icon element with a favicon as the image. More...
 
 loadCustomCaptions ()
 

Protected Attributes

 $customCaptions
 
 $iwLookup
 
 $linkRenderer
 
 $output
 
 $resultWidget
 
 $showMultimedia
 
 $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 18 of file InterwikiSearchResultSetWidget.php.

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ footerHtml()

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

Definition at line 124 of file InterwikiSearchResultSetWidget.php.

References $term, MediaWiki\Widget\Search\InterwikiSearchResultSetWidget\iwIcon(), Title\makeTitle(), NS_SPECIAL, null, Html\rawElement(), wfExpandUrl(), and wfParseUrl().

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

◆ iwIcon()

MediaWiki\Widget\Search\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$iwPrefixInterwiki prefix
Returns
OOUI\IconWidget

Definition at line 168 of file InterwikiSearchResultSetWidget.php.

References wfExpandUrl(), and wfParseUrl().

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

◆ loadCustomCaptions()

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

◆ render()

MediaWiki\Widget\Search\InterwikiSearchResultSetWidget::render (   $term,
  $resultSets 
)
Parameters
string$termUser provided search term
SearchResultSet|SearchResultSet[]$resultSets List of interwiki results to render.
Returns
string HTML

Implements MediaWiki\Widget\Search\SearchResultSetWidget.

Definition at line 55 of file InterwikiSearchResultSetWidget.php.

References $term, as, MediaWiki\Widget\Search\InterwikiSearchResultSetWidget\footerHtml(), MediaWiki\Widget\Search\InterwikiSearchResultSetWidget\loadCustomCaptions(), and Html\rawElement().

Member Data Documentation

◆ $customCaptions

MediaWiki\Widget\Search\InterwikiSearchResultSetWidget::$customCaptions
protected

Definition at line 24 of file InterwikiSearchResultSetWidget.php.

◆ $iwLookup

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

◆ $linkRenderer

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

◆ $output

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

Definition at line 30 of file InterwikiSearchResultSetWidget.php.

◆ $resultWidget

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

◆ $showMultimedia

MediaWiki\Widget\Search\InterwikiSearchResultSetWidget::$showMultimedia
protected

◆ $specialSearch

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

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