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) | |
| render ( $term, $resultSets) | |
Protected Member Functions | |
| headerHtml ( $iwPrefix, $term) | |
| Generates an appropriate HTML header for the given interwiki prefix. | |
| loadCustomCaptions () | |
Protected Attributes | |
| string[] null | $customCaptions |
| InterwikiLookup | $iwLookup |
| LinkRenderer | $linkRenderer |
| SearchResultWidget | $resultWidget |
| 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.
- Deprecated
- since 1.31. Use InterwikiSearchResultSetWidget
Definition at line 19 of file SimpleSearchResultSetWidget.php.
Constructor & Destructor Documentation
◆ __construct()
| MediaWiki\Search\SearchWidgets\SimpleSearchResultSetWidget::__construct | ( | SpecialSearch | $specialSearch, |
| SearchResultWidget | $resultWidget, | ||
| LinkRenderer | $linkRenderer, | ||
| InterwikiLookup | $iwLookup ) |
Definition at line 31 of file SimpleSearchResultSetWidget.php.
References MediaWiki\Search\SearchWidgets\SimpleSearchResultSetWidget\$iwLookup, MediaWiki\Search\SearchWidgets\SimpleSearchResultSetWidget\$linkRenderer, MediaWiki\Search\SearchWidgets\SimpleSearchResultSetWidget\$resultWidget, MediaWiki\Search\SearchWidgets\SimpleSearchResultSetWidget\$specialSearch, and wfDeprecated().
Member Function Documentation
◆ headerHtml()
|
protected |
Generates an appropriate HTML header for the given interwiki prefix.
- Parameters
-
string $iwPrefix Interwiki prefix of wiki to show header for string $term User provided search term
- Returns
- string HTML
Definition at line 96 of file SimpleSearchResultSetWidget.php.
References MediaWiki\Title\TitleFactory\makeTitle(), NS_SPECIAL, wfExpandUrl(), and wfParseUrl().
Referenced by MediaWiki\Search\SearchWidgets\SimpleSearchResultSetWidget\render().
◆ loadCustomCaptions()
|
protected |
Definition at line 125 of file SimpleSearchResultSetWidget.php.
Referenced by MediaWiki\Search\SearchWidgets\SimpleSearchResultSetWidget\render().
◆ render()
| MediaWiki\Search\SearchWidgets\SimpleSearchResultSetWidget::render | ( | $term, | |
| $resultSets ) |
- Parameters
-
string $term User provided search term ISearchResultSet | ISearchResultSet[] $resultSets List of interwiki results to render.
- Returns
- string HTML
Implements MediaWiki\Search\SearchWidgets\SearchResultSetWidget.
Definition at line 50 of file SimpleSearchResultSetWidget.php.
References MediaWiki\Search\SearchWidgets\SimpleSearchResultSetWidget\headerHtml(), and MediaWiki\Search\SearchWidgets\SimpleSearchResultSetWidget\loadCustomCaptions().
Member Data Documentation
◆ $customCaptions
|
protected |
Definition at line 25 of file SimpleSearchResultSetWidget.php.
◆ $iwLookup
|
protected |
Definition at line 29 of file SimpleSearchResultSetWidget.php.
Referenced by MediaWiki\Search\SearchWidgets\SimpleSearchResultSetWidget\__construct().
◆ $linkRenderer
|
protected |
Definition at line 27 of file SimpleSearchResultSetWidget.php.
Referenced by MediaWiki\Search\SearchWidgets\SimpleSearchResultSetWidget\__construct().
◆ $resultWidget
|
protected |
Definition at line 23 of file SimpleSearchResultSetWidget.php.
Referenced by MediaWiki\Search\SearchWidgets\SimpleSearchResultSetWidget\__construct().
◆ $specialSearch
|
protected |
Definition at line 21 of file SimpleSearchResultSetWidget.php.
Referenced by MediaWiki\Search\SearchWidgets\SimpleSearchResultSetWidget\__construct().
The documentation for this class was generated from the following file:
- includes/search/searchwidgets/SimpleSearchResultSetWidget.php
