MediaWiki REL1_37
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
MediaWiki\Search\SearchWidgets\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\Search\SearchWidgets\DidYouMeanWidget:
Collaboration graph
[legend]

Public Member Functions

 __construct (SpecialSearch $specialSearch)
 
 render ( $term, ISearchResultSet $resultSet)
 

Protected Member Functions

 rewrittenHtml ( $term, ISearchResultSet $resultSet)
 Generates HTML shown to user when their query has been internally rewritten, and the results of the rewritten query are being returned.
 
 suggestionHtml (ISearchResultSet $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.
 

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\Search\SearchWidgets\DidYouMeanWidget::__construct ( SpecialSearch  $specialSearch)

Definition at line 17 of file DidYouMeanWidget.php.

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

Member Function Documentation

◆ render()

MediaWiki\Search\SearchWidgets\DidYouMeanWidget::render (   $term,
ISearchResultSet  $resultSet 
)
Parameters
string$termThe user provided search term
ISearchResultSet$resultSet
Returns
string HTML

Definition at line 26 of file DidYouMeanWidget.php.

References ISearchResultSet\hasRewrittenQuery(), ISearchResultSet\hasSuggestion(), MediaWiki\Search\SearchWidgets\DidYouMeanWidget\rewrittenHtml(), and MediaWiki\Search\SearchWidgets\DidYouMeanWidget\suggestionHtml().

◆ rewrittenHtml()

MediaWiki\Search\SearchWidgets\DidYouMeanWidget::rewrittenHtml (   $term,
ISearchResultSet  $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$termThe users search input
ISearchResultSet$resultSetThe 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 ISearchResultSet\getQueryAfterRewrite(), ISearchResultSet\getQueryAfterRewriteSnippet(), and wfDeprecatedMsg().

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

◆ suggestionHtml()

MediaWiki\Search\SearchWidgets\DidYouMeanWidget::suggestionHtml ( ISearchResultSet  $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
ISearchResultSet$resultSet
Returns
string HTML

Definition at line 100 of file DidYouMeanWidget.php.

References ISearchResultSet\getSuggestionQuery(), ISearchResultSet\getSuggestionSnippet(), and wfDeprecatedMsg().

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

Member Data Documentation

◆ $specialSearch

SpecialSearch MediaWiki\Search\SearchWidgets\DidYouMeanWidget::$specialSearch
protected

Definition at line 15 of file DidYouMeanWidget.php.

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

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