MediaWiki master
|
Renders one or more ISearchResultSets into a sidebar grouped by interwiki prefix. More...
Inherits MediaWiki\Search\SearchWidgets\SearchResultSetWidget.
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 | |
string[] null | $customCaptions |
array | $iwLogoOverrides |
InterwikiLookup | $iwLookup |
LinkRenderer | $linkRenderer |
OutputPage | $output |
SearchResultWidget | $resultWidget |
bool | $showMultimedia |
SpecialSearch | $specialSearch |
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 19 of file InterwikiSearchResultSetWidget.php.
MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget::__construct | ( | SpecialSearch | $specialSearch, |
SearchResultWidget | $resultWidget, | ||
LinkRenderer | $linkRenderer, | ||
InterwikiLookup | $iwLookup, | ||
$showMultimedia = false ) |
Definition at line 37 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 MediaWiki\SpecialPage\SpecialPage\getOutput().
|
protected |
Generates an HTML footer for the given interwiki prefix.
string | $term | User provided search term |
string | $iwPrefix | Interwiki prefix of wiki to show heading for |
Definition at line 149 of file InterwikiSearchResultSetWidget.php.
References NS_SPECIAL, wfExpandUrl(), and wfParseUrl().
Referenced by MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget\render().
|
protected |
Fetches the favicon of the provided URL.
string | $logoUrl |
Definition at line 229 of file InterwikiSearchResultSetWidget.php.
References wfExpandUrl(), and wfParseUrl().
Referenced by MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget\iwIcon().
|
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.
string | $prefix | Interwiki prefix |
Definition at line 213 of file InterwikiSearchResultSetWidget.php.
Referenced by MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget\iwIcon().
|
protected |
Generates an HTML header for the given interwiki prefix.
string | $term | User provided search term |
string | $iwPrefix | Interwiki prefix of wiki to show heading for |
Definition at line 125 of file InterwikiSearchResultSetWidget.php.
References MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget\iwIcon(), NS_SPECIAL, wfExpandUrl(), and wfParseUrl().
Referenced by MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget\render().
|
protected |
Generates a custom OOUI icon element.
These icons are either generated by fetching the interwiki favicon. or by using config 'InterwikiLogoOverrides'.
string | $iwPrefix | Interwiki prefix |
Definition at line 189 of file InterwikiSearchResultSetWidget.php.
References MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget\generateIconFromFavicon(), and MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget\generateLogoName().
Referenced by MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget\headerHtml().
|
protected |
Definition at line 166 of file InterwikiSearchResultSetWidget.php.
Referenced by MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget\render().
MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget::render | ( | $term, | |
$resultSets ) |
string | $term | User provided search term |
ISearchResultSet | ISearchResultSet[] | $resultSets | List of interwiki results to render. |
Implements MediaWiki\Search\SearchWidgets\SearchResultSetWidget.
Definition at line 59 of file InterwikiSearchResultSetWidget.php.
References MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget\footerHtml(), MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget\headerHtml(), and MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget\loadCustomCaptions().
|
protected |
Definition at line 25 of file InterwikiSearchResultSetWidget.php.
|
protected |
Definition at line 35 of file InterwikiSearchResultSetWidget.php.
|
protected |
Definition at line 29 of file InterwikiSearchResultSetWidget.php.
Referenced by MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget\__construct().
|
protected |
Definition at line 27 of file InterwikiSearchResultSetWidget.php.
Referenced by MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget\__construct().
|
protected |
Definition at line 31 of file InterwikiSearchResultSetWidget.php.
|
protected |
Definition at line 23 of file InterwikiSearchResultSetWidget.php.
Referenced by MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget\__construct().
|
protected |
Definition at line 33 of file InterwikiSearchResultSetWidget.php.
Referenced by MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget\__construct().
|
protected |
Definition at line 21 of file InterwikiSearchResultSetWidget.php.
Referenced by MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget\__construct().