MediaWiki\Search\SearchWidgets\BasicSearchResultSetWidget Class Reference

Renders the search result area. More...

Collaboration diagram for MediaWiki\Search\SearchWidgets\BasicSearchResultSetWidget:

Public Member Functions
	__construct (SpecialSearch $specialPage, SearchResultWidget $resultWidget, SearchResultSetWidget $sidebarWidget)
	render ( $term, $offset, ?ISearchResultSet $titleResultSet=null, ?ISearchResultSet $textResultSet=null)

Protected Member Functions
	header (Message $msg)
	Generate a headline for a section of the search results.
	renderResultSet (ISearchResultSet $resultSet, $offset)

Protected Attributes
SearchResultWidget	$resultWidget
SearchResultSetWidget	$sidebarWidget
SpecialSearch	$specialPage

Detailed Description

Renders the search result area.

Handles Title and Full-Text search results, along with inline and sidebar secondary (interwiki) results.

Definition at line 15 of file BasicSearchResultSetWidget.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Search\SearchWidgets\BasicSearchResultSetWidget::__construct	(	SpecialSearch	$specialPage,
		SearchResultWidget	$resultWidget,
		SearchResultSetWidget	$sidebarWidget )

Definition at line 20 of file BasicSearchResultSetWidget.php.

References MediaWiki\Search\SearchWidgets\BasicSearchResultSetWidget\$resultWidget, MediaWiki\Search\SearchWidgets\BasicSearchResultSetWidget\$sidebarWidget, and MediaWiki\Search\SearchWidgets\BasicSearchResultSetWidget\$specialPage.

Member Function Documentation

header()

MediaWiki\Search\SearchWidgets\BasicSearchResultSetWidget::header ( Message $msg )

protected

Generate a headline for a section of the search results.

In prior implementations this was rendering wikitext of '==$1==', but seems a waste to call the full parser to generate this tiny bit of html

Parameters

Message

$msg

i18n message to use as header

Returns

string HTML

Definition at line 116 of file BasicSearchResultSetWidget.php.

References MediaWiki\Message\Message\escaped().

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

render()

MediaWiki\Search\SearchWidgets\BasicSearchResultSetWidget::render	(		$term,
			$offset,
		?ISearchResultSet	$titleResultSet = null,
		?ISearchResultSet	$textResultSet = null )

Parameters

string	$term	The search term to highlight
int	$offset	The offset of the first result in the result set
ISearchResultSet | null	$titleResultSet	Results of searching only page titles
ISearchResultSet | null	$textResultSet	Results of general full text search.

Returns

string HTML

Definition at line 37 of file BasicSearchResultSetWidget.php.

References MediaWiki\MediaWikiServices\getInstance(), MediaWiki\Search\SearchWidgets\BasicSearchResultSetWidget\header(), MediaWiki\Search\ISearchResultSet\INLINE_RESULTS, MediaWiki\Search\SearchWidgets\BasicSearchResultSetWidget\renderResultSet(), and MediaWiki\Search\ISearchResultSet\SECONDARY_RESULTS.

renderResultSet()

MediaWiki\Search\SearchWidgets\BasicSearchResultSetWidget::renderResultSet ( ISearchResultSet $resultSet, $offset )

protected

Parameters

ISearchResultSet	$resultSet	The search results to render
int	$offset	Offset of the first result in $resultSet

Returns

string HTML

Definition at line 125 of file BasicSearchResultSetWidget.php.

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

Member Data Documentation

$resultWidget

SearchResultWidget MediaWiki\Search\SearchWidgets\BasicSearchResultSetWidget::$resultWidget

protected

Definition at line 17 of file BasicSearchResultSetWidget.php.

Referenced by MediaWiki\Search\SearchWidgets\BasicSearchResultSetWidget\__construct().

$sidebarWidget

SearchResultSetWidget MediaWiki\Search\SearchWidgets\BasicSearchResultSetWidget::$sidebarWidget

protected

Definition at line 18 of file BasicSearchResultSetWidget.php.

Referenced by MediaWiki\Search\SearchWidgets\BasicSearchResultSetWidget\__construct().

$specialPage

SpecialSearch MediaWiki\Search\SearchWidgets\BasicSearchResultSetWidget::$specialPage

protected

Definition at line 16 of file BasicSearchResultSetWidget.php.

Referenced by MediaWiki\Search\SearchWidgets\BasicSearchResultSetWidget\__construct().

---

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

• includes/Search/SearchWidgets/BasicSearchResultSetWidget.php