DidYouMeanWidget.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Search\SearchWidgets;
 
use ISearchResultSet;
use MediaWiki\Html\Html;
use MediaWiki\Specials\SpecialSearch;
 
class DidYouMeanWidget {
    protected SpecialSearch $specialSearch;
 
    public function __construct( SpecialSearch $specialSearch ) {
        $this->specialSearch = $specialSearch;
    }
 
    public function render( $term, ISearchResultSet $resultSet ) {
        if ( $resultSet->hasRewrittenQuery() ) {
            $html = $this->rewrittenHtml( $term, $resultSet );
        } elseif ( $resultSet->hasSuggestion() ) {
            $html = $this->suggestionHtml( $resultSet );
        } else {
            return '';
        }
 
        return Html::rawElement( 'div', [ 'class' => 'searchdidyoumean' ], $html );
    }
 
    protected function rewrittenHtml( $term, ISearchResultSet $resultSet ) {
        $params = [
            'search' => $resultSet->getQueryAfterRewrite(),
            // Don't magic this link into a 'go' link, it should always
            // show search results.
            'fulltext' => 1,
        ];
        $stParams = array_merge( $params, $this->specialSearch->powerSearchOptions() );
 
        $linkRenderer = $this->specialSearch->getLinkRenderer();
        $snippet = $resultSet->getQueryAfterRewriteSnippet();
        if ( $snippet === '' || $snippet === null ) {
            // This should never happen. But if it did happen we would render
            // links as `Special:Search` which is even more useless. Since this
            // was only documented but not enforced previously emit a
            // deprecation warning and in the future we can simply fail on bad
            // inputs
            wfDeprecatedMsg(
                get_class( $resultSet ) . '::getQueryAfterRewriteSnippet returning empty snippet ' .
                'was deprecated in MediaWiki 1.35',
                '1.34', false, false
            );
            $snippet = $resultSet->getQueryAfterRewrite();
        }
        $rewritten = $linkRenderer->makeKnownLink(
            $this->specialSearch->getPageTitle(),
            $snippet,
            [ 'id' => 'mw-search-DYM-rewritten' ],
            $stParams
        );
 
        $original = $term;
 
        return $this->specialSearch->msg( 'search-rewritten' )
            ->rawParams( $rewritten )
            ->params( $original )
            ->escaped();
    }
 
    protected function suggestionHtml( ISearchResultSet $resultSet ) {
        $params = [
            'search' => $resultSet->getSuggestionQuery(),
            'fulltext' => 1,
        ];
        $stParams = array_merge( $params, $this->specialSearch->powerSearchOptions() );
 
        $snippet = $resultSet->getSuggestionSnippet();
        if ( $snippet === '' || $snippet === null ) {
            // This should never happen. But if it did happen we would render
            // links as `Special:Search` which is even more useless. Since this
            // was only documented but not enforced previously emit a
            // deprecation warning and in the future we can simply fail on bad
            // inputs
            wfDeprecatedMsg(
                get_class( $resultSet ) . '::getSuggestionSnippet returning empty snippet ' .
                'was deprecated in MediaWiki 1.35',
                '1.34', false, false
            );
            $snippet = $resultSet->getSuggestionSnippet();
        }
        $suggest = $this->specialSearch->getLinkRenderer()->makeKnownLink(
            $this->specialSearch->getPageTitle(),
            $snippet,
            [ 'id' => 'mw-search-DYM-suggestion' ],
            $stParams
        );
 
        return $this->specialSearch->msg( 'search-suggest' )
            ->rawParams( $suggest )->parse();
    }
}