includes/widget/search/DidYouMeanWidget.php

   1 <?php
   2
   3 namespace MediaWiki\Widget\Search;
   4
   5 use HtmlArmor;
   6 use SearchResultSet;
   7 use SpecialSearch;
   8
   9 /**
  10  * Renders a suggested search for the user, or tells the user
  11  * a suggested search was run instead of the one provided.
  12  */
  13 class DidYouMeanWidget {
  14         /** @var SpecialSearch */
  15         protected $specialSearch;
  16
  17         public function __construct( SpecialSearch $specialSearch ) {
  18                 $this->specialSearch = $specialSearch;
  19         }
  20
  21         /**
  22          * @param string $term The user provided search term
  23          * @param SearchResultSet $resultSet
  24          * @return string HTML
  25          */
  26         public function render( $term, SearchResultSet $resultSet ) {
  27                 if ( $resultSet->hasRewrittenQuery() ) {
  28                         $html = $this->rewrittenHtml( $term, $resultSet );
  29                 } elseif ( $resultSet->hasSuggestion() ) {
  30                         $html = $this->suggestionHtml( $resultSet );
  31                 } else {
  32                         return '';
  33                 }
  34
  35                 return "<div class='searchdidyoumean'>$html</div>";
  36         }
  37
  38         /**
  39          * Generates HTML shown to user when their query has been internally
  40          * rewritten, and the results of the rewritten query are being returned.
  41          *
  42          * @param string $term The users search input
  43          * @param SearchResultSet $resultSet The response to the search request
  44          * @return string HTML Links the user to their original $term query, and the
  45          *  one suggested by $resultSet
  46          */
  47         protected function rewrittenHtml( $term, SearchResultSet $resultSet ) {
  48                 $params = [
  49                         'search' => $resultSet->getQueryAfterRewrite(),
  50                         // Don't magic this link into a 'go' link, it should always
  51                         // show search results.
  52                         'fultext' => 1,
  53                 ];
  54                 $stParams = array_merge( $params, $this->specialSearch->powerSearchOptions() );
  55
  56                 $linkRenderer = $this->specialSearch->getLinkRenderer();
  57                 $snippet = $resultSet->getQueryAfterRewriteSnippet();
  58                 $rewritten = $linkRenderer->makeKnownLink(
  59                         $this->specialSearch->getPageTitle(),
  60                         $snippet ? new HtmlArmor( $snippet ) : null,
  61                         [ 'id' => 'mw-search-DYM-rewritten' ],
  62                         $stParams
  63                 );
  64
  65                 $stParams['search'] = $term;
  66                 $stParams['runsuggestion'] = 0;
  67                 $original = $linkRenderer->makeKnownLink(
  68                         $this->specialSearch->getPageTitle(),
  69                         $term,
  70                         [ 'id' => 'mwsearch-DYM-original' ],
  71                         $stParams
  72                 );
  73
  74                 return $this->specialSearch->msg( 'search-rewritten' )
  75                         ->rawParams( $rewritten, $original )
  76                         ->escaped();
  77         }
  78
  79         /**
  80          * Generates HTML shown to the user when we have a suggestion about
  81          * a query that might give more/better results than their current
  82          * query.
  83          *
  84          * @param SearchResultSet $resultSet
  85          * @return string HTML
  86          */
  87         protected function suggestionHtml( SearchResultSet $resultSet ) {
  88                 $params = [
  89                         'search' => $resultSet->getSuggestionQuery(),
  90                         'fulltext' => 1,
  91                 ];
  92                 $stParams = array_merge( $params, $this->specialSearch->powerSearchOptions() );
  93
  94                 $snippet = $resultSet->getSuggestionSnippet();
  95                 $suggest = $this->specialSearch->getLinkRenderer()->makeKnownLink(
  96                         $this->specialSearch->getPageTitle(),
  97                         $snippet ? new HtmlArmor( $snippet ) : null,
  98                         [ 'id' => 'mw-search-DYM-suggestion' ],
  99                         $stParams
 100                 );
 101
 102                 return $this->specialSearch->msg( 'search-suggest' )
 103                         ->rawParams( $suggest )->parse();
 104         }
 105 }