includes/widget/search/SimpleSearchResultWidget.php

   1 <?php
   2
   3 namespace MediaWiki\Widget\Search;
   4
   5 use HtmlArmor;
   6 use MediaWiki\Linker\LinkRenderer;
   7 use SearchResult;
   8 use SpecialSearch;
   9
  10 /**
  11  * Renders a simple one-line result
  12  *
  13  * @deprecated since 1.31. Use other result widgets.
  14  */
  15 class SimpleSearchResultWidget implements SearchResultWidget {
  16         /** @var SpecialSearch */
  17         protected $specialSearch;
  18         /** @var LinkRenderer */
  19         protected $linkRenderer;
  20
  21         public function __construct( SpecialSearch $specialSearch, LinkRenderer $linkRenderer ) {
  22                 wfDeprecated( __METHOD__, '1.31' );
  23                 $this->specialSearch = $specialSearch;
  24                 $this->linkRenderer = $linkRenderer;
  25         }
  26
  27         /**
  28          * @param SearchResult $result The result to render
  29          * @param string $terms Terms to be highlighted (@see SearchResult::getTextSnippet)
  30          * @param int $position The result position, including offset
  31          * @return string HTML
  32          */
  33         public function render( SearchResult $result, $terms, $position ) {
  34                 $title = $result->getTitle();
  35                 $titleSnippet = $result->getTitleSnippet();
  36                 if ( $titleSnippet ) {
  37                         $titleSnippet = new HtmlArmor( $titleSnippet );
  38                 } else {
  39                         $titleSnippet = null;
  40                 }
  41
  42                 $link = $this->linkRenderer->makeLink( $title, $titleSnippet );
  43
  44                 $redirectTitle = $result->getRedirectTitle();
  45                 $redirect = '';
  46                 if ( $redirectTitle !== null ) {
  47                         $redirectText = $result->getRedirectSnippet();
  48                         if ( $redirectText ) {
  49                                 $redirectText = new HtmlArmor( $redirectText );
  50                         } else {
  51                                 $redirectText = null;
  52                         }
  53                         $redirect =
  54                                 "<span class='searchalttitle'>" .
  55                                         $this->specialSearch->msg( 'search-redirect' )->rawParams(
  56                                                 $this->linkRenderer->makeLink( $redirectTitle, $redirectText )
  57                                         )->parse() .
  58                                 "</span>";
  59                 }
  60
  61                 return "<li>{$link} {$redirect}</li>";
  62         }
  63 }