includes/widget/search/BasicSearchResultSetWidget.php

   1 <?php
   2
   3 namespace MediaWiki\Widget\Search;
   4
   5 use MediaWiki\MediaWikiServices;
   6 use Message;
   7 use SearchResultSet;
   8 use SpecialSearch;
   9 use Status;
  10
  11 /**
  12  * Renders the search result area. Handles Title and Full-Text search results,
  13  * along with inline and sidebar secondary (interwiki) results.
  14  */
  15 class BasicSearchResultSetWidget {
  16         /** @var SpecialSearch */
  17         protected $specialPage;
  18         /** @var SearchResultWidget */
  19         protected $resultWidget;
  20         /** @var InterwikiSearchResultSetWidget */
  21         protected $sidebarWidget;
  22
  23         public function __construct(
  24                 SpecialSearch $specialPage,
  25                 SearchResultWidget $resultWidget,
  26                 SearchResultSetWidget $sidebarWidget
  27         ) {
  28                 $this->specialPage = $specialPage;
  29                 $this->resultWidget = $resultWidget;
  30                 $this->sidebarWidget = $sidebarWidget;
  31         }
  32
  33         /**
  34          * @param string $term The search term to highlight
  35          * @param int $offset The offset of the first result in the result set
  36          * @param SearchResultSet|null $titleResultSet Results of searching only page titles
  37          * @param SearchResultSet|null $textResultSet Results of general full text search.
  38          * @return string HTML
  39          */
  40         public function render(
  41                 $term,
  42                 $offset,
  43                 SearchResultSet $titleResultSet = null,
  44                 SearchResultSet $textResultSet = null
  45         ) {
  46                 $hasTitle = $titleResultSet ? $titleResultSet->numRows() > 0 : false;
  47                 $hasText = $textResultSet ? $textResultSet->numRows() > 0 : false;
  48                 $hasSecondary = $textResultSet
  49                         ? $textResultSet->hasInterwikiResults( SearchResultSet::SECONDARY_RESULTS )
  50                         : false;
  51                 $hasSecondaryInline = $textResultSet
  52                         ? $textResultSet->hasInterwikiResults( SearchResultSet::INLINE_RESULTS )
  53                         : false;
  54
  55                 if ( !$hasTitle && !$hasText && !$hasSecondary && !$hasSecondaryInline ) {
  56                         return '';
  57                 }
  58
  59                 $out = '';
  60                 if ( $hasTitle ) {
  61                         $out .= $this->header( $this->specialPage->msg( 'titlematches' ) )
  62                                 . $this->renderResultSet( $titleResultSet, $offset );
  63                 }
  64
  65                 if ( $hasText ) {
  66                         if ( $hasTitle ) {
  67                                 $out .= "<div class='mw-search-visualclear'></div>" .
  68                                         $this->header( $this->specialPage->msg( 'textmatches' ) );
  69                         }
  70                         $out .= $this->renderResultSet( $textResultSet, $offset );
  71                 }
  72
  73                 if ( $hasSecondaryInline ) {
  74                         $iwResults = $textResultSet->getInterwikiResults( SearchResultSet::INLINE_RESULTS );
  75                         foreach ( $iwResults as $interwiki => $results ) {
  76                                 if ( $results instanceof Status || $results->numRows() === 0 ) {
  77                                         // ignore bad interwikis for now
  78                                         continue;
  79                                 }
  80                                 $out .=
  81                                         "<h2 class='mw-search-interwiki-header mw-search-visualclear'>" .
  82                                                 $this->specialPage->msg( "search-interwiki-results-{$interwiki}" )->parse() .
  83                                         "</h2>";
  84                                 $out .= $this->renderResultSet( $results, $offset );
  85                         }
  86                 }
  87
  88                 if ( $hasSecondary ) {
  89                         $out .= $this->sidebarWidget->render(
  90                                 $term,
  91                                 $textResultSet->getInterwikiResults( SearchResultSet::SECONDARY_RESULTS )
  92                         );
  93                 }
  94
  95                 // Convert the whole thing to desired language variant
  96                 // TODO: Move this up to Special:Search?
  97                 return MediaWikiServices::getInstance()->getContentLanguage()->convert( $out );
  98         }
  99
 100         /**
 101          * Generate a headline for a section of the search results. In prior
 102          * implementations this was rendering wikitext of '==$1==', but seems
 103          * a waste to call the full parser to generate this tiny bit of html
 104          *
 105          * @param Message $msg i18n message to use as header
 106          * @return string HTML
 107          */
 108         protected function header( Message $msg ) {
 109                 return "<h2>" .
 110                         "<span class='mw-headline'>" . $msg->escaped() . "</span>" .
 111                 "</h2>";
 112         }
 113
 114         /**
 115          * @param SearchResultSet $resultSet The search results to render
 116          * @param int $offset Offset of the first result in $resultSet
 117          * @return string HTML
 118          */
 119         protected function renderResultSet( SearchResultSet $resultSet, $offset ) {
 120                 $hits = [];
 121                 foreach ( $resultSet as $result ) {
 122                         $hits[] = $this->resultWidget->render( $result, $offset++ );
 123                 }
 124
 125                 return "<ul class='mw-search-results'>" . implode( '', $hits ) . "</ul>";
 126         }
 127 }