3 namespace MediaWiki\Widget\Search
;
7 use MediaWiki\Widget\SearchInputWidget
;
9 use SearchEngineConfig
;
13 class SearchFormWidget
{
14 /** @var SpecialSearch */
15 protected $specialSearch;
16 /** @var SearchEngineConfig */
17 protected $searchConfig;
22 * @param SpecialSearch $specialSearch
23 * @param SearchEngineConfig $searchConfig
24 * @param array $profiles
26 public function __construct(
27 SpecialSearch
$specialSearch,
28 SearchEngineConfig
$searchConfig,
31 $this->specialSearch
= $specialSearch;
32 $this->searchConfig
= $searchConfig;
33 $this->profiles
= $profiles;
37 * @param string $profile The current search profile
38 * @param string $term The current search term
39 * @param int $numResults The number of results shown
40 * @param int $totalResults The total estimated results found
41 * @param int $offset Current offset in search results
42 * @param bool $isPowerSearch Is the 'advanced' section open?
45 public function render(
53 return Xml
::openElement(
56 'id' => $isPowerSearch ?
'powersearch' : 'search',
58 'action' => wfScript(),
61 '<div id="mw-search-top-table">' .
62 $this->shortDialogHtml( $profile, $term, $numResults, $totalResults, $offset ) .
64 "<div class='mw-search-visualclear'></div>" .
65 "<div class='mw-search-profile-tabs'>" .
66 $this->profileTabsHtml( $profile, $term ) .
67 "<div style='clear:both'></div>" .
69 $this->optionsHtml( $term, $isPowerSearch, $profile ) .
74 * @param string $profile The current search profile
75 * @param string $term The current search term
76 * @param int $numResults The number of results shown
77 * @param int $totalResults The total estimated results found
78 * @param int $offset Current offset in search results
81 protected function shortDialogHtml( $profile, $term, $numResults, $totalResults, $offset ) {
84 $searchWidget = new SearchInputWidget( [
87 'autofocus' => trim( $term ) === '',
89 'dataLocation' => 'content',
93 $layout = new \OOUI\
ActionFieldLayout( $searchWidget, new \OOUI\
ButtonInputWidget( [
95 'label' => $this->specialSearch
->msg( 'searchbutton' )->text(),
96 'flags' => [ 'progressive', 'primary' ],
103 if ( $this->specialSearch
->getPrefix() !== '' ) {
104 $html .= Html
::hidden( 'prefix', $this->specialSearch
->getPrefix() );
107 if ( $totalResults > 0 && $offset < $totalResults ) {
111 'class' => 'results-info',
112 'data-mw-num-results-offset' => $offset,
113 'data-mw-num-results-total' => $totalResults
115 $this->specialSearch
->msg( 'search-showingresults' )
116 ->numParams( $offset +
1, $offset +
$numResults, $totalResults )
117 ->numParams( $numResults )
123 Html
::hidden( 'title', $this->specialSearch
->getPageTitle()->getPrefixedText() ) .
124 Html
::hidden( 'profile', $profile ) .
125 Html
::hidden( 'fulltext', '1' );
131 * Generates HTML for the list of available search profiles.
133 * @param string $profile The currently selected profile
134 * @param string $term The user provided search terms
135 * @return string HTML
137 protected function profileTabsHtml( $profile, $term ) {
138 $bareterm = $this->startsWithImage( $term )
139 ?
substr( $term, strpos( $term, ':' ) +
1 )
141 $lang = $this->specialSearch
->getLanguage();
143 foreach ( $this->profiles
as $id => $profileConfig ) {
144 $profileConfig['parameters']['profile'] = $id;
145 $tooltipParam = isset( $profileConfig['namespace-messages'] )
146 ?
$lang->commaList( $profileConfig['namespace-messages'] )
148 $items[] = Xml
::tags(
150 [ 'class' => $profile === $id ?
'current' : 'normal' ],
151 $this->makeSearchLink(
153 $this->specialSearch
->msg( $profileConfig['message'] )->text(),
154 $this->specialSearch
->msg( $profileConfig['tooltip'], $tooltipParam )->text(),
155 $profileConfig['parameters']
160 return "<div class='search-types'>" .
161 "<ul>" . implode( '', $items ) . "</ul>" .
166 * Check if query starts with image: prefix
168 * @param string $term The string to check
171 protected function startsWithImage( $term ) {
174 $parts = explode( ':', $term );
175 return count( $parts ) > 1
176 ?
$wgContLang->getNsIndex( $parts[0] ) === NS_FILE
181 * Make a search link with some target namespaces
183 * @param string $term The term to search for
184 * @param string $label Link's text
185 * @param string $tooltip Link's tooltip
186 * @param array $params Query string parameters
187 * @return string HTML fragment
189 protected function makeSearchLink( $term, $label, $tooltip, array $params = [] ) {
198 'href' => $this->specialSearch
->getPageTitle()->getLocalURL( $params ),
206 * Generates HTML for advanced options available with the currently
207 * selected search profile.
209 * @param string $term User provided search term
210 * @param bool $isPowerSearch Is the advanced search profile enabled?
211 * @param string $profile The current search profile
212 * @return string HTML
214 protected function optionsHtml( $term, $isPowerSearch, $profile ) {
217 if ( $isPowerSearch ) {
218 $html .= $this->powerSearchBox( $term, [] );
221 Hooks
::run( 'SpecialSearchProfileForm', [
222 $this->specialSearch
, &$form, $profile, $term, []
231 * @param string $term The current search term
232 * @param array $opts Additional key/value pairs that will be submitted
233 * with the generated form.
234 * @return string HTML
236 protected function powerSearchBox( $term, array $opts ) {
240 $activeNamespaces = $this->specialSearch
->getNamespaces();
241 foreach ( $this->searchConfig
->searchableNamespaces() as $namespace => $name ) {
242 $subject = MWNamespace
::getSubject( $namespace );
243 if ( !isset( $rows[$subject] ) ) {
244 $rows[$subject] = "";
247 $name = $wgContLang->getConverter()->convertNamespace( $namespace );
248 if ( $name === '' ) {
249 $name = $this->specialSearch
->msg( 'blanknamespace' )->text();
257 "mw-search-ns{$namespace}",
258 in_array( $namespace, $activeNamespaces )
263 // Lays out namespaces in multiple floating two-column tables so they'll
264 // be arranged nicely while still accomodating diferent screen widths
266 foreach ( $rows as $row ) {
267 $tableRows[] = "<tr>{$row}</tr>";
269 $namespaceTables = [];
270 foreach ( array_chunk( $tableRows, 4 ) as $chunk ) {
271 $namespaceTables[] = implode( '', $chunk );
275 'namespaceTables' => "<table>" . implode( '</table><table>', $namespaceTables ) . '</table>',
277 Hooks
::run( 'SpecialSearchPowerBox', [ &$showSections, $term, &$opts ] );
280 foreach ( $opts as $key => $value ) {
281 $hidden .= Html
::hidden( $key, $value );
284 $divider = "<div class='divider'></div>";
286 // Stuff to feed SpecialSearch::saveNamespaces()
287 $user = $this->specialSearch
->getUser();
289 if ( $user->isLoggedIn() ) {
290 $remember = $divider . Xml
::checkLabel(
291 $this->specialSearch
->msg( 'powersearch-remember' )->text(),
293 'mw-search-powersearch-remember',
295 // The token goes here rather than in a hidden field so it
296 // is only sent when necessary (not every form submission)
297 [ 'value' => $user->getEditToken(
299 $this->specialSearch
->getRequest()
304 return "<fieldset id='mw-searchoptions'>" .
305 "<legend>" . $this->specialSearch
->msg( 'powersearch-legend' )->escaped() . '</legend>' .
306 "<h4>" . $this->specialSearch
->msg( 'powersearch-ns' )->parse() . '</h4>' .
307 // populated by js if available
308 "<div id='mw-search-togglebox'></div>" .