MediaWiki\Widget\Search\DidYouMeanWidget Class Reference

Renders a suggested search for the user, or tells the user a suggested search was run instead of the one provided. More...

Collaboration diagram for MediaWiki\Widget\Search\DidYouMeanWidget:

Public Member Functions
	__construct (SpecialSearch $specialSearch)
	render ( $term, SearchResultSet $resultSet)

Protected Member Functions
	rewrittenHtml ( $term, SearchResultSet $resultSet)
	Generates HTML shown to user when their query has been internally rewritten, and the results of the rewritten query are being returned. More...
	suggestionHtml (SearchResultSet $resultSet)
	Generates HTML shown to the user when we have a suggestion about a query that might give more/better results than their current query. More...

Protected Attributes
SpecialSearch	$specialSearch

Detailed Description

Renders a suggested search for the user, or tells the user a suggested search was run instead of the one provided.

Definition at line 13 of file DidYouMeanWidget.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Widget\Search\DidYouMeanWidget::__construct

(

SpecialSearch

$specialSearch

)

Definition at line 17 of file DidYouMeanWidget.php.

References MediaWiki\Widget\Search\DidYouMeanWidget\$specialSearch.

Member Function Documentation

render()

MediaWiki\Widget\Search\DidYouMeanWidget::render	(		$term,
		SearchResultSet	$resultSet
	)

Parameters

string	$term	The user provided search term
SearchResultSet	$resultSet

Returns

string HTML

Definition at line 26 of file DidYouMeanWidget.php.

References $html, $term, SearchResultSet\hasRewrittenQuery(), SearchResultSet\hasSuggestion(), MediaWiki\Widget\Search\DidYouMeanWidget\rewrittenHtml(), and MediaWiki\Widget\Search\DidYouMeanWidget\suggestionHtml().

rewrittenHtml()

MediaWiki\Widget\Search\DidYouMeanWidget::rewrittenHtml (   $term, SearchResultSet  $resultSet  )

protected

Generates HTML shown to user when their query has been internally rewritten, and the results of the rewritten query are being returned.

Parameters

string	$term	The users search input
SearchResultSet	$resultSet	The response to the search request

Returns

string HTML Links the user to their original $term query, and the one suggested by $resultSet

Definition at line 47 of file DidYouMeanWidget.php.

References $params, $term, SearchResultSet\getQueryAfterRewrite(), SearchResultSet\getQueryAfterRewriteSnippet(), and Linker\linkKnown().

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

suggestionHtml()

MediaWiki\Widget\Search\DidYouMeanWidget::suggestionHtml ( SearchResultSet  $resultSet )

protected

Generates HTML shown to the user when we have a suggestion about a query that might give more/better results than their current query.

Parameters

SearchResultSet

$resultSet

Returns

string HTML

Definition at line 85 of file DidYouMeanWidget.php.

References $params, SearchResultSet\getSuggestionQuery(), SearchResultSet\getSuggestionSnippet(), and Linker\linkKnown().

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

Member Data Documentation

$specialSearch

SpecialSearch MediaWiki\Widget\Search\DidYouMeanWidget::$specialSearch

protected

Definition at line 15 of file DidYouMeanWidget.php.

Referenced by MediaWiki\Widget\Search\DidYouMeanWidget\__construct().

---

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

• includes/widget/search/DidYouMeanWidget.php