MediaWiki  master
BasicSearchResultSetWidget.php
Go to the documentation of this file.
1 <?php
2 
4 
7 use Message;
8 use SpecialSearch;
9 use Status;
10 
17  protected $specialPage;
19  protected $resultWidget;
21  protected $sidebarWidget;
22 
23  public function __construct(
27  ) {
28  $this->specialPage = $specialPage;
29  $this->resultWidget = $resultWidget;
30  $this->sidebarWidget = $sidebarWidget;
31  }
32 
40  public function render(
41  $term,
42  $offset,
43  ISearchResultSet $titleResultSet = null,
44  ISearchResultSet $textResultSet = null
45  ) {
46  $hasTitle = $titleResultSet ? $titleResultSet->numRows() > 0 : false;
47  $hasText = $textResultSet ? $textResultSet->numRows() > 0 : false;
48  $hasSecondary = $textResultSet
49  ? $textResultSet->hasInterwikiResults( ISearchResultSet::SECONDARY_RESULTS )
50  : false;
51  $hasSecondaryInline = $textResultSet
52  ? $textResultSet->hasInterwikiResults( ISearchResultSet::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  // @phan-suppress-next-line PhanTypeMismatchArgumentNullable titleResultSet is set when used here
63  . $this->renderResultSet( $titleResultSet, $offset );
64  }
65 
66  if ( $hasText ) {
67  if ( $hasTitle ) {
68  $out .= "<div class='mw-search-visualclear'></div>" .
69  $this->header( $this->specialPage->msg( 'textmatches' ) );
70  }
71  // @phan-suppress-next-line PhanTypeMismatchArgumentNullable textResultSet is set when used
72  $out .= $this->renderResultSet( $textResultSet, $offset );
73  }
74 
75  if ( $hasSecondaryInline ) {
76  $iwResults = $textResultSet->getInterwikiResults( ISearchResultSet::INLINE_RESULTS );
77  foreach ( $iwResults as $interwiki => $results ) {
78  if ( $results instanceof Status || $results->numRows() === 0 ) {
79  // ignore bad interwikis for now
80  continue;
81  }
82  $out .=
83  "<h2 class='mw-search-interwiki-header mw-search-visualclear'>" .
84  $this->specialPage->msg( "search-interwiki-results-{$interwiki}" )->parse() .
85  "</h2>";
86  $out .= $this->renderResultSet( $results, $offset );
87  }
88  }
89 
90  if ( $hasSecondary ) {
91  $out .= $this->sidebarWidget->render(
92  $term,
93  $textResultSet->getInterwikiResults( ISearchResultSet::SECONDARY_RESULTS )
94  );
95  }
96 
97  // Convert the whole thing to desired language variant
98  // TODO: Move this up to Special:Search?
99  $converter = MediaWikiServices::getInstance()->getLanguageConverterFactory()
100  ->getLanguageConverter();
101  return $converter->convert( $out );
102  }
103 
112  protected function header( Message $msg ) {
113  return "<h2>" .
114  "<span class='mw-headline'>" . $msg->escaped() . "</span>" .
115  "</h2>";
116  }
117 
123  protected function renderResultSet( ISearchResultSet $resultSet, $offset ) {
124  $hits = [];
125  foreach ( $resultSet as $result ) {
126  $hits[] = $this->resultWidget->render( $result, $offset++ );
127  }
128 
129  return "<ul class='mw-search-results'>" . implode( '', $hits ) . "</ul>";
130  }
131 }
MediaWikiServices is the service locator for the application scope of MediaWiki.
static getInstance()
Returns the global default instance of the top level service locator.
header(Message $msg)
Generate a headline for a section of the search results.
__construct(SpecialSearch $specialPage, SearchResultWidget $resultWidget, SearchResultSetWidget $sidebarWidget)
render( $term, $offset, ISearchResultSet $titleResultSet=null, ISearchResultSet $textResultSet=null)
The Message class deals with fetching and processing of interface message into a variety of formats.
Definition: Message.php:141
escaped()
Returns the message text.
Definition: Message.php:1107
implements Special:Search - Run text & title search and display the output
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: Status.php:44
A set of SearchEngine results.
const INLINE_RESULTS
Identifier for interwiki results that can be displayed even if no existing main wiki results exist.
const SECONDARY_RESULTS
Identifier for interwiki results that are displayed only together with existing main wiki results.
Renders a single search result to HTML.