SimpleSearchResultSetWidget.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Search\SearchWidgets;
 
use ISearchResultSet;
use MediaWiki\Html\Html;
use MediaWiki\Interwiki\InterwikiLookup;
use MediaWiki\Linker\LinkRenderer;
use MediaWiki\Title\Title;
use SpecialSearch;
 
class SimpleSearchResultSetWidget implements SearchResultSetWidget {
    protected $specialSearch;
    protected $resultWidget;
    protected $customCaptions;
    protected $linkRenderer;
    protected $iwLookup;
 
    public function __construct(
        SpecialSearch $specialSearch,
        SearchResultWidget $resultWidget,
        LinkRenderer $linkRenderer,
        InterwikiLookup $iwLookup
    ) {
        wfDeprecated( __METHOD__, '1.31' );
        $this->specialSearch = $specialSearch;
        $this->resultWidget = $resultWidget;
        $this->linkRenderer = $linkRenderer;
        $this->iwLookup = $iwLookup;
    }
 
    public function render( $term, $resultSets ) {
        if ( !is_array( $resultSets ) ) {
            $resultSets = [ $resultSets ];
        }
 
        $this->loadCustomCaptions();
 
        $iwResults = [];
        foreach ( $resultSets as $resultSet ) {
            foreach ( $resultSet as $result ) {
                if ( !$result->isBrokenTitle() ) {
                    $iwResults[$result->getTitle()->getInterwiki()][] = $result;
                }
            }
        }
 
        $out = '';
        foreach ( $iwResults as $iwPrefix => $results ) {
            $out .= $this->headerHtml( $iwPrefix, $term );
            $out .= Html::openElement( 'ul', [ 'class' => 'mw-search-iwresults' ] );
            // TODO: Assumes interwiki results are never paginated
            $position = 0;
            foreach ( $results as $result ) {
                $out .= $this->resultWidget->render( $result, $position++ );
            }
            $out .= Html::closeElement( 'ul' );
        }
 
        return Html::rawElement(
            'div',
            [ 'id' => 'mw-search-interwiki' ],
            Html::rawElement(
                'div',
                [ 'id' => 'mw-search-interwiki-caption' ],
                $this->specialSearch->msg( 'search-interwiki-caption' )->parse()
            ) . $out
        );
    }
 
    protected function headerHtml( $iwPrefix, $term ) {
        if ( isset( $this->customCaptions[$iwPrefix] ) ) {
            $caption = $this->customCaptions[$iwPrefix];
        } else {
            $interwiki = $this->iwLookup->fetch( $iwPrefix );
            $parsed = wfParseUrl( wfExpandUrl( $interwiki ? $interwiki->getURL() : '/' ) );
            $caption = $this->specialSearch->msg( 'search-interwiki-default', $parsed['host'] )->escaped();
        }
 
        $href = Title::makeTitle( NS_SPECIAL, 'Search', '', $iwPrefix )->getLocalURL(
            [ 'search' => $term, 'fulltext' => 1 ]
        );
        $searchLink = Html::rawElement(
            'a',
            [ 'href' => $href ],
            $this->specialSearch->msg( 'search-interwiki-more' )->escaped()
        );
 
        return Html::rawElement(
            'div',
            [ 'class' => 'mw-search-interwiki-project' ],
            Html::rawElement(
                'span',
                [ 'class' => 'mw-search-interwiki-more' ],
                $searchLink
            ) . $caption
        );
    }
 
    protected function loadCustomCaptions() {
        if ( $this->customCaptions !== null ) {
            return;
        }
 
        $this->customCaptions = [];
        $customLines = explode( "\n", $this->specialSearch->msg( 'search-interwiki-custom' )->escaped() );
        foreach ( $customLines as $line ) {
            $parts = explode( ':', $line, 2 );
            if ( count( $parts ) === 2 ) {
                $this->customCaptions[$parts[0]] = $parts[1];
            }
        }
    }
}