wiki.techinc.nl/includes/search/searchwidgets/SimpleSearchResultWidget.php
James D. Forrester 3a9a542e1d widgets: Split out SearchWidgets into their own tree
Expecting people to magically know that MediaWiki\Widget\SearchInputWidget is
generic and for use on random pages, but MediaWiki\Widget\SearchResultWidget
is super-specialised, based on bespoke technologies, and only for use on
Special:Search, is not great.

None of these are used outside the MediaWiki core codebase and so this change
whilst it would otherwise be technically breaking is fine.

Change-Id: I16d21dd5e1ac3aa9893863df272d1bbb4788066f
2020-02-11 14:37:27 -08:00

62 lines
1.6 KiB
PHP

<?php
namespace MediaWiki\Search\SearchWidgets;
use HtmlArmor;
use MediaWiki\Linker\LinkRenderer;
use SearchResult;
use SpecialSearch;
/**
* Renders a simple one-line result
*
* @deprecated since 1.31. Use other result widgets.
*/
class SimpleSearchResultWidget implements SearchResultWidget {
/** @var SpecialSearch */
protected $specialSearch;
/** @var LinkRenderer */
protected $linkRenderer;
public function __construct( SpecialSearch $specialSearch, LinkRenderer $linkRenderer ) {
wfDeprecated( __METHOD__, '1.31' );
$this->specialSearch = $specialSearch;
$this->linkRenderer = $linkRenderer;
}
/**
* @param SearchResult $result The result to render
* @param int $position The result position, including offset
* @return string HTML
*/
public function render( SearchResult $result, $position ) {
$title = $result->getTitle();
$titleSnippet = $result->getTitleSnippet();
if ( $titleSnippet ) {
$titleSnippet = new HtmlArmor( $titleSnippet );
} else {
$titleSnippet = null;
}
$link = $this->linkRenderer->makeLink( $title, $titleSnippet );
$redirectTitle = $result->getRedirectTitle();
$redirect = '';
if ( $redirectTitle !== null ) {
$redirectText = $result->getRedirectSnippet();
if ( $redirectText ) {
$redirectText = new HtmlArmor( $redirectText );
} else {
$redirectText = null;
}
$redirect =
"<span class='searchalttitle'>" .
$this->specialSearch->msg( 'search-redirect' )->rawParams(
$this->linkRenderer->makeLink( $redirectTitle, $redirectText )
)->parse() .
"</span>";
}
return "<li>{$link} {$redirect}</li>";
}
}