MediaWiki REL1_35
BasicSearchResultSetWidget.php
Go to the documentation of this file.
1<?php
2
4
7use Message;
9use 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 . $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( ISearchResultSet::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( ISearchResultSet::SECONDARY_RESULTS )
92 );
93 }
94
95 // Convert the whole thing to desired language variant
96 // TODO: Move this up to Special:Search?
97 $converter = MediaWikiServices::getInstance()->getLanguageConverterFactory()
98 ->getLanguageConverter();
99 return $converter->convert( $out );
100 }
101
110 protected function header( Message $msg ) {
111 return "<h2>" .
112 "<span class='mw-headline'>" . $msg->escaped() . "</span>" .
113 "</h2>";
114 }
115
121 protected function renderResultSet( ISearchResultSet $resultSet, $offset ) {
122 $hits = [];
123 foreach ( $resultSet as $result ) {
124 $hits[] = $this->resultWidget->render( $result, $offset++ );
125 }
126
127 return "<ul class='mw-search-results'>" . implode( '', $hits ) . "</ul>";
128 }
129}
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)
Renders one or more ISearchResultSets into a sidebar grouped by interwiki prefix.
The Message class deals with fetching and processing of interface message into a variety of formats.
Definition Message.php:161
escaped()
Returns the message text.
Definition Message.php:1005
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.
Renders a single search result to HTML.