MediaWiki  master
SpecialSearch.php
Go to the documentation of this file.
1 <?php
33 
38 class SpecialSearch extends SpecialPage {
47  protected $profile;
48 
50  protected $searchEngine;
51 
53  protected $searchEngineType;
54 
56  protected $extraParams = [];
57 
62  protected $mPrefix;
63 
67  protected $limit, $offset;
68 
72  protected $namespaces;
73 
77  protected $fulltext;
78 
83 
87  protected $runSuggestion = true;
88 
93  protected $searchConfig;
94 
99  private $loadStatus;
100 
101  const NAMESPACES_CURRENT = 'sense';
102 
103  public function __construct() {
104  parent::__construct( 'Search' );
105  $this->searchConfig = MediaWikiServices::getInstance()->getSearchEngineConfig();
106  }
107 
113  public function execute( $par ) {
114  $request = $this->getRequest();
115  $out = $this->getOutput();
116 
117  // Fetch the search term
118  $term = str_replace( "\n", " ", $request->getText( 'search' ) );
119 
120  // Historically search terms have been accepted not only in the search query
121  // parameter, but also as part of the primary url. This can have PII implications
122  // in releasing page view data. As such issue a 301 redirect to the correct
123  // URL.
124  if ( $par !== null && $par !== '' && $term === '' ) {
125  $query = $request->getValues();
126  unset( $query['title'] );
127  // Strip underscores from title parameter; most of the time we'll want
128  // text form here. But don't strip underscores from actual text params!
129  $query['search'] = str_replace( '_', ' ', $par );
130  $out->redirect( $this->getPageTitle()->getFullURL( $query ), 301 );
131  return;
132  }
133 
134  // Need to load selected namespaces before handling nsRemember
135  $this->load();
136  // TODO: This performs database actions on GET request, which is going to
137  // be a problem for our multi-datacenter work.
138  if ( $request->getCheck( 'nsRemember' ) ) {
139  $this->saveNamespaces();
140  // Remove the token from the URL to prevent the user from inadvertently
141  // exposing it (e.g. by pasting it into a public wiki page) or undoing
142  // later settings changes (e.g. by reloading the page).
143  $query = $request->getValues();
144  unset( $query['title'], $query['nsRemember'] );
145  $out->redirect( $this->getPageTitle()->getFullURL( $query ) );
146  return;
147  }
148 
149  $this->searchEngineType = $request->getVal( 'srbackend' );
150  if ( !$request->getVal( 'fulltext' ) && !$request->getCheck( 'offset' ) ) {
151  $url = $this->goResult( $term );
152  if ( $url !== null ) {
153  // successful 'go'
154  $out->redirect( $url );
155  return;
156  }
157  // No match. If it could plausibly be a title
158  // run the No go match hook.
159  $title = Title::newFromText( $term );
160  if ( !is_null( $title ) ) {
161  Hooks::run( 'SpecialSearchNogomatch', [ &$title ] );
162  }
163  }
164 
165  $this->setupPage( $term );
166 
167  if ( $this->getConfig()->get( 'DisableTextSearch' ) ) {
168  $searchForwardUrl = $this->getConfig()->get( 'SearchForwardUrl' );
169  if ( $searchForwardUrl ) {
170  $url = str_replace( '$1', urlencode( $term ), $searchForwardUrl );
171  $out->redirect( $url );
172  } else {
173  $this->showGoogleSearch( $term );
174  }
175 
176  return;
177  }
178 
179  $this->showResults( $term );
180  }
181 
189  private function showGoogleSearch( $term ) {
190  $this->getOutput()->addHTML(
191  "<fieldset>" .
192  "<legend>" .
193  $this->msg( 'search-external' )->escaped() .
194  "</legend>" .
195  "<p class='mw-searchdisabled'>" .
196  $this->msg( 'searchdisabled' )->escaped() .
197  "</p>" .
198  $this->msg( 'googlesearch' )->rawParams(
199  htmlspecialchars( $term ),
200  'UTF-8',
201  $this->msg( 'searchbutton' )->escaped()
202  )->text() .
203  "</fieldset>"
204  );
205  }
206 
212  public function load() {
213  $this->loadStatus = new Status();
214 
215  $request = $this->getRequest();
216  list( $this->limit, $this->offset ) = $request->getLimitOffset( 20, '' );
217  $this->mPrefix = $request->getVal( 'prefix', '' );
218  if ( $this->mPrefix !== '' ) {
219  $this->setExtraParam( 'prefix', $this->mPrefix );
220  }
221 
222  $sort = $request->getVal( 'sort', SearchEngine::DEFAULT_SORT );
223  $validSorts = $this->getSearchEngine()->getValidSorts();
224  if ( !in_array( $sort, $validSorts ) ) {
225  $this->loadStatus->warning( 'search-invalid-sort-order', $sort,
226  implode( ', ', $validSorts ) );
227  } elseif ( $sort !== $this->sort ) {
228  $this->sort = $sort;
229  $this->setExtraParam( 'sort', $this->sort );
230  }
231 
232  $user = $this->getUser();
233 
234  # Extract manually requested namespaces
235  $nslist = $this->powerSearch( $request );
236  if ( $nslist === [] ) {
237  # Fallback to user preference
238  $nslist = $this->searchConfig->userNamespaces( $user );
239  }
240 
241  $profile = null;
242  if ( $nslist === [] ) {
243  $profile = 'default';
244  }
245 
246  $profile = $request->getVal( 'profile', $profile );
247  $profiles = $this->getSearchProfiles();
248  if ( $profile === null ) {
249  // BC with old request format
250  $profile = 'advanced';
251  foreach ( $profiles as $key => $data ) {
252  if ( $nslist === $data['namespaces'] && $key !== 'advanced' ) {
253  $profile = $key;
254  }
255  }
256  $this->namespaces = $nslist;
257  } elseif ( $profile === 'advanced' ) {
258  $this->namespaces = $nslist;
259  } elseif ( isset( $profiles[$profile]['namespaces'] ) ) {
260  $this->namespaces = $profiles[$profile]['namespaces'];
261  } else {
262  // Unknown profile requested
263  $this->loadStatus->warning( 'search-unknown-profile', $profile );
264  $profile = 'default';
265  $this->namespaces = $profiles['default']['namespaces'];
266  }
267 
268  $this->fulltext = $request->getVal( 'fulltext' );
269  $this->runSuggestion = (bool)$request->getVal( 'runsuggestion', true );
270  $this->profile = $profile;
271  }
272 
279  public function goResult( $term ) {
280  # If the string cannot be used to create a title
281  if ( is_null( Title::newFromText( $term ) ) ) {
282  return null;
283  }
284  # If there's an exact or very near match, jump right there.
285  $title = $this->getSearchEngine()
286  ->getNearMatcher( $this->getConfig() )->getNearMatch( $term );
287  if ( is_null( $title ) ) {
288  return null;
289  }
290  $url = null;
291  if ( !Hooks::run( 'SpecialSearchGoResult', [ $term, $title, &$url ] ) ) {
292  return null;
293  }
294 
295  return $url ?? $title->getFullUrlForRedirect();
296  }
297 
301  public function showResults( $term ) {
302  if ( $this->searchEngineType !== null ) {
303  $this->setExtraParam( 'srbackend', $this->searchEngineType );
304  }
305 
306  $out = $this->getOutput();
307  $widgetOptions = $this->getConfig()->get( 'SpecialSearchFormOptions' );
309  $this,
310  $this->searchConfig,
311  $this->getSearchProfiles()
312  );
313  $filePrefix = MediaWikiServices::getInstance()->getContentLanguage()->
314  getFormattedNsText( NS_FILE ) . ':';
315  if ( trim( $term ) === '' || $filePrefix === trim( $term ) ) {
316  // Empty query -- straight view of search form
317  if ( !Hooks::run( 'SpecialSearchResultsPrepend', [ $this, $out, $term ] ) ) {
318  # Hook requested termination
319  return;
320  }
321  $out->enableOOUI();
322  // The form also contains the 'Showing results 0 - 20 of 1234' so we can
323  // only do the form render here for the empty $term case. Rendering
324  // the form when a search is provided is repeated below.
325  $out->addHTML( $formWidget->render(
326  $this->profile, $term, 0, 0, $this->offset, $this->isPowerSearch(), $widgetOptions
327  ) );
328  return;
329  }
330 
331  $engine = $this->getSearchEngine();
332  $engine->setFeatureData( 'rewrite', $this->runSuggestion );
333  $engine->setLimitOffset( $this->limit, $this->offset );
334  $engine->setNamespaces( $this->namespaces );
335  $engine->setSort( $this->sort );
336  $engine->prefix = $this->mPrefix;
337 
338  Hooks::run( 'SpecialSearchSetupEngine', [ $this, $this->profile, $engine ] );
339  if ( !Hooks::run( 'SpecialSearchResultsPrepend', [ $this, $out, $term ] ) ) {
340  # Hook requested termination
341  return;
342  }
343 
344  $title = Title::newFromText( $term );
345  $showSuggestion = $title === null || !$title->isKnown();
346  $engine->setShowSuggestion( $showSuggestion );
347 
348  $rewritten = $engine->replacePrefixes( $term );
349  if ( $rewritten !== $term ) {
350  wfDeprecated( 'SearchEngine::replacePrefixes() (overridden by ' .
351  get_class( $engine ) . ')', '1.32' );
352  }
353 
354  // fetch search results
355  $titleMatches = $engine->searchTitle( $rewritten );
356  $textMatches = $engine->searchText( $rewritten );
357 
358  $textStatus = null;
359  if ( $textMatches instanceof Status ) {
360  $textStatus = $textMatches;
361  $textMatches = $textStatus->getValue();
362  }
363 
364  // Get number of results
365  $titleMatchesNum = $textMatchesNum = $numTitleMatches = $numTextMatches = 0;
366  if ( $titleMatches ) {
367  $titleMatchesNum = $titleMatches->numRows();
368  $numTitleMatches = $titleMatches->getTotalHits();
369  }
370  if ( $textMatches ) {
371  $textMatchesNum = $textMatches->numRows();
372  $numTextMatches = $textMatches->getTotalHits();
373  if ( $textMatchesNum > 0 ) {
374  $engine->augmentSearchResults( $textMatches );
375  }
376  }
377  $num = $titleMatchesNum + $textMatchesNum;
378  $totalRes = $numTitleMatches + $numTextMatches;
379 
380  // start rendering the page
381  $out->enableOOUI();
382  $out->addHTML( $formWidget->render(
383  $this->profile, $term, $num, $totalRes, $this->offset, $this->isPowerSearch(), $widgetOptions
384  ) );
385 
386  // did you mean... suggestions
387  if ( $textMatches ) {
388  $dymWidget = new MediaWiki\Widget\Search\DidYouMeanWidget( $this );
389  $out->addHTML( $dymWidget->render( $term, $textMatches ) );
390  }
391 
392  $hasSearchErrors = $textStatus && $textStatus->getErrors() !== [];
393  $hasOtherResults = $textMatches &&
394  $textMatches->hasInterwikiResults( ISearchResultSet::INLINE_RESULTS );
395 
396  if ( $textMatches && $textMatches->hasInterwikiResults( ISearchResultSet::SECONDARY_RESULTS ) ) {
397  $out->addHTML( '<div class="searchresults mw-searchresults-has-iw">' );
398  } else {
399  $out->addHTML( '<div class="searchresults">' );
400  }
401 
402  if ( $hasSearchErrors || $this->loadStatus->getErrors() ) {
403  if ( $textStatus === null ) {
404  $textStatus = $this->loadStatus;
405  } else {
406  $textStatus->merge( $this->loadStatus );
407  }
408  list( $error, $warning ) = $textStatus->splitByErrorType();
409  if ( $error->getErrors() ) {
410  $out->addHTML( Html::errorBox(
411  $error->getHTML( 'search-error' )
412  ) );
413  }
414  if ( $warning->getErrors() ) {
415  $out->addHTML( Html::warningBox(
416  $warning->getHTML( 'search-warning' )
417  ) );
418  }
419  }
420 
421  // Show the create link ahead
422  $this->showCreateLink( $title, $num, $titleMatches, $textMatches );
423 
424  Hooks::run( 'SpecialSearchResults', [ $term, &$titleMatches, &$textMatches ] );
425 
426  // If we have no results and have not already displayed an error message
427  if ( $num === 0 && !$hasSearchErrors ) {
428  $out->wrapWikiMsg( "<p class=\"mw-search-nonefound\">\n$1</p>", [
429  $hasOtherResults ? 'search-nonefound-thiswiki' : 'search-nonefound',
430  wfEscapeWikiText( $term )
431  ] );
432  }
433 
434  // Although $num might be 0 there can still be secondary or inline
435  // results to display.
436  $linkRenderer = $this->getLinkRenderer();
437  $mainResultWidget = new FullSearchResultWidget( $this, $linkRenderer );
438 
439  // Default (null) on. Can be explicitly disabled.
440  if ( $engine->getFeatureData( 'enable-new-crossproject-page' ) !== false ) {
441  $sidebarResultWidget = new InterwikiSearchResultWidget( $this, $linkRenderer );
442  $sidebarResultsWidget = new InterwikiSearchResultSetWidget(
443  $this,
444  $sidebarResultWidget,
446  MediaWikiServices::getInstance()->getInterwikiLookup(),
447  $engine->getFeatureData( 'show-multimedia-search-results' )
448  );
449  } else {
450  $sidebarResultWidget = new SimpleSearchResultWidget( $this, $linkRenderer );
451  $sidebarResultsWidget = new SimpleSearchResultSetWidget(
452  $this,
453  $sidebarResultWidget,
455  MediaWikiServices::getInstance()->getInterwikiLookup()
456  );
457  }
458 
459  $widget = new BasicSearchResultSetWidget( $this, $mainResultWidget, $sidebarResultsWidget );
460 
461  $out->addHTML( $widget->render(
462  $term, $this->offset, $titleMatches, $textMatches
463  ) );
464 
465  $out->addHTML( '<div class="mw-search-visualclear"></div>' );
466 
467  // prev/next links
468  if ( $totalRes > $this->limit || $this->offset ) {
469  // Allow matches to define the correct offset, as interleaved
470  // AB testing may require a different next page offset.
471  if ( $textMatches && $textMatches->getOffset() !== null ) {
472  $offset = $textMatches->getOffset();
473  } else {
474  $offset = $this->offset;
475  }
476 
477  $prevNext = $this->buildPrevNextNavigation(
478  $offset,
479  $this->limit,
480  $this->powerSearchOptions() + [ 'search' => $term ],
481  $this->limit + $this->offset >= $totalRes
482  );
483  $out->addHTML( "<p class='mw-search-pager-bottom'>{$prevNext}</p>\n" );
484  }
485 
486  // Close <div class='searchresults'>
487  $out->addHTML( "</div>" );
488 
489  Hooks::run( 'SpecialSearchResultsAppend', [ $this, $out, $term ] );
490  }
491 
498  protected function showCreateLink( $title, $num, $titleMatches, $textMatches ) {
499  // show direct page/create link if applicable
500 
501  // Check DBkey !== '' in case of fragment link only.
502  if ( is_null( $title ) || $title->getDBkey() === ''
503  || ( $titleMatches !== null && $titleMatches->searchContainedSyntax() )
504  || ( $textMatches !== null && $textMatches->searchContainedSyntax() )
505  ) {
506  // invalid title
507  // preserve the paragraph for margins etc...
508  $this->getOutput()->addHTML( '<p></p>' );
509 
510  return;
511  }
512 
513  $messageName = 'searchmenu-new-nocreate';
514  $linkClass = 'mw-search-createlink';
515 
516  if ( !$title->isExternal() ) {
517  if ( $title->isKnown() ) {
518  $messageName = 'searchmenu-exists';
519  $linkClass = 'mw-search-exists';
520  } elseif ( ContentHandler::getForTitle( $title )->supportsDirectEditing()
521  && MediaWikiServices::getInstance()->getPermissionManager()->quickUserCan( 'create',
522  $this->getUser(), $title )
523  ) {
524  $messageName = 'searchmenu-new';
525  }
526  }
527 
528  $params = [
529  $messageName,
530  wfEscapeWikiText( $title->getPrefixedText() ),
531  Message::numParam( $num )
532  ];
533  Hooks::run( 'SpecialSearchCreateLink', [ $title, &$params ] );
534 
535  // Extensions using the hook might still return an empty $messageName
536  if ( $messageName ) {
537  $this->getOutput()->wrapWikiMsg( "<p class=\"$linkClass\">\n$1</p>", $params );
538  } else {
539  // preserve the paragraph for margins etc...
540  $this->getOutput()->addHTML( '<p></p>' );
541  }
542  }
543 
550  protected function setupPage( $term ) {
551  $out = $this->getOutput();
552 
553  $this->setHeaders();
554  $this->outputHeader();
555  // TODO: Is this true? The namespace remember uses a user token
556  // on save.
557  $out->allowClickjacking();
558  $this->addHelpLink( 'Help:Searching' );
559 
560  if ( strval( $term ) !== '' ) {
561  $out->setPageTitle( $this->msg( 'searchresults' ) );
562  $out->setHTMLTitle( $this->msg( 'pagetitle' )
563  ->plaintextParams( $this->msg( 'searchresults-title' )->plaintextParams( $term )->text() )
564  ->inContentLanguage()->text()
565  );
566  }
567 
568  if ( $this->mPrefix !== '' ) {
569  $subtitle = $this->msg( 'search-filter-title-prefix' )->plaintextParams( $this->mPrefix );
570  $params = $this->powerSearchOptions();
571  unset( $params['prefix'] );
572  $params += [
573  'search' => $term,
574  'fulltext' => 1,
575  ];
576 
577  $subtitle .= ' (';
578  $subtitle .= Xml::element(
579  'a',
580  [
581  'href' => $this->getPageTitle()->getLocalURL( $params ),
582  'title' => $this->msg( 'search-filter-title-prefix-reset' )->text(),
583  ],
584  $this->msg( 'search-filter-title-prefix-reset' )->text()
585  );
586  $subtitle .= ')';
587  $out->setSubtitle( $subtitle );
588  }
589 
590  $out->addJsConfigVars( [ 'searchTerm' => $term ] );
591  $out->addModules( 'mediawiki.special.search' );
592  $out->addModuleStyles( [
593  'mediawiki.special', 'mediawiki.special.search.styles', 'mediawiki.ui', 'mediawiki.ui.button',
594  'mediawiki.ui.input', 'mediawiki.widgets.SearchInputWidget.styles',
595  ] );
596  }
597 
603  protected function isPowerSearch() {
604  return $this->profile === 'advanced';
605  }
606 
614  protected function powerSearch( &$request ) {
615  $arr = [];
616  foreach ( $this->searchConfig->searchableNamespaces() as $ns => $name ) {
617  if ( $request->getCheck( 'ns' . $ns ) ) {
618  $arr[] = $ns;
619  }
620  }
621 
622  return $arr;
623  }
624 
632  public function powerSearchOptions() {
633  $opt = [];
634  if ( $this->isPowerSearch() ) {
635  foreach ( $this->namespaces as $n ) {
636  $opt['ns' . $n] = 1;
637  }
638  } else {
639  $opt['profile'] = $this->profile;
640  }
641 
642  return $opt + $this->extraParams;
643  }
644 
650  protected function saveNamespaces() {
651  $user = $this->getUser();
652  $request = $this->getRequest();
653 
654  if ( $user->isLoggedIn() &&
655  $user->matchEditToken(
656  $request->getVal( 'nsRemember' ),
657  'searchnamespace',
658  $request
659  ) && !wfReadOnly()
660  ) {
661  // Reset namespace preferences: namespaces are not searched
662  // when they're not mentioned in the URL parameters.
663  foreach ( MediaWikiServices::getInstance()->getNamespaceInfo()->getValidNamespaces()
664  as $n
665  ) {
666  $user->setOption( 'searchNs' . $n, false );
667  }
668  // The request parameters include all the namespaces to be searched.
669  // Even if they're the same as an existing profile, they're not eaten.
670  foreach ( $this->namespaces as $n ) {
671  $user->setOption( 'searchNs' . $n, true );
672  }
673 
674  DeferredUpdates::addCallableUpdate( function () use ( $user ) {
675  $user->saveSettings();
676  } );
677 
678  return true;
679  }
680 
681  return false;
682  }
683 
688  protected function getSearchProfiles() {
689  // Builds list of Search Types (profiles)
690  $nsAllSet = array_keys( $this->searchConfig->searchableNamespaces() );
691  $defaultNs = $this->searchConfig->defaultNamespaces();
692  $profiles = [
693  'default' => [
694  'message' => 'searchprofile-articles',
695  'tooltip' => 'searchprofile-articles-tooltip',
696  'namespaces' => $defaultNs,
697  'namespace-messages' => $this->searchConfig->namespacesAsText(
698  $defaultNs
699  ),
700  ],
701  'images' => [
702  'message' => 'searchprofile-images',
703  'tooltip' => 'searchprofile-images-tooltip',
704  'namespaces' => [ NS_FILE ],
705  ],
706  'all' => [
707  'message' => 'searchprofile-everything',
708  'tooltip' => 'searchprofile-everything-tooltip',
709  'namespaces' => $nsAllSet,
710  ],
711  'advanced' => [
712  'message' => 'searchprofile-advanced',
713  'tooltip' => 'searchprofile-advanced-tooltip',
714  'namespaces' => self::NAMESPACES_CURRENT,
715  ]
716  ];
717 
718  Hooks::run( 'SpecialSearchProfiles', [ &$profiles ] );
719 
720  foreach ( $profiles as &$data ) {
721  if ( !is_array( $data['namespaces'] ) ) {
722  continue;
723  }
724  sort( $data['namespaces'] );
725  }
726 
727  return $profiles;
728  }
729 
735  public function getSearchEngine() {
736  if ( $this->searchEngine === null ) {
737  $services = MediaWikiServices::getInstance();
738  $this->searchEngine = $this->searchEngineType ?
739  $services->getSearchEngineFactory()->create( $this->searchEngineType ) :
740  $services->newSearchEngine();
741  }
742 
743  return $this->searchEngine;
744  }
745 
750  function getProfile() {
751  return $this->profile;
752  }
753 
758  function getNamespaces() {
759  return $this->namespaces;
760  }
761 
771  public function setExtraParam( $key, $value ) {
772  $this->extraParams[$key] = $value;
773  }
774 
783  public function getPrefix() {
784  return $this->mPrefix;
785  }
786 
787  protected function getGroupName() {
788  return 'pages';
789  }
790 }
Renders one or more ISearchResultSets into a sidebar grouped by interwiki prefix. ...
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking, formatting, etc.
setupPage( $term)
Sets up everything for the HTML output page including styles, javascript, page title, etc.
SearchEngineConfig $searchConfig
Search engine configurations.
const INLINE_RESULTS
Identifier for interwiki results that can be displayed even if no existing main wiki results exist...
getNamespaces()
Current namespaces.
string $searchEngineType
Search engine type, if not default.
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
saveNamespaces()
Save namespace preferences when we&#39;re supposed to.
getOutput()
Get the OutputPage being used for this instance.
static numParam( $num)
Definition: Message.php:1038
Renders one or more ISearchResultSets into a sidebar grouped by interwiki prefix. ...
getPermissionManager()
buildPrevNextNavigation( $offset, $limit, array $query=[], $atend=false, $subpage=false)
Generate (prev x| next x) (20|50|100...) type links for paging.
static errorBox( $html, $heading='', $className='')
Return an error box.
Definition: Html.php:739
msg( $key,... $params)
Wrapper around wfMessage that sets the current context.
static addCallableUpdate( $callable, $stage=self::POSTSEND, $dbw=null)
Add a callable update.
isPowerSearch()
Return true if current search is a power (advanced) search.
Renders a &#39;full&#39; multi-line search result with metadata.
getProfile()
Current search profile.
wfReadOnly()
Check whether the wiki is in read-only mode.
array $extraParams
For links.
const NAMESPACES_CURRENT
goResult( $term)
If an exact title match can be found, jump straight ahead to it.
showResults( $term)
load()
Set up basic search parameters from the request and user settings.
string $mPrefix
The prefix url parameter.
showGoogleSearch( $term)
Output a google search form if search is disabled.
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes! ...
const DEFAULT_SORT
const NS_FILE
Definition: Defines.php:66
static getForTitle(Title $title)
Returns the appropriate ContentHandler singleton for the given title.
static warningBox( $html, $className='')
Return a warning box.
Definition: Html.php:726
merge( $other, $overwriteValue=false)
Merge another status object into this one.
powerSearchOptions()
Reconstruct the &#39;power search&#39; options for links TODO: Instead of exposing this publicly, could we instead expose a function for creating search links?
setExtraParam( $key, $value)
Users of hook SpecialSearchSetupEngine can use this to add more params to links to not lose selection...
const SECONDARY_RESULTS
Identifier for interwiki results that are displayed only together with existing main wiki results...
getUser()
Shortcut to get the User executing this instance.
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
getConfig()
Shortcut to get main config object.
static element( $element, $attribs=null, $contents='', $allowShortTag=true)
Format an XML element with given attributes and, optionally, text content.
Definition: Xml.php:41
getPrefix()
The prefix value send to Special:Search using the &#39;prefix&#39; URI param It means that the user is willin...
null string $profile
Current search profile.
getRequest()
Get the WebRequest being used for this instance.
SearchEngine $searchEngine
Search engine.
execute( $par)
Entry point.
Renders a suggested search for the user, or tells the user a suggested search was run instead of the ...
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
getPageTitle( $subpage=false)
Get a self-referential title object.
powerSearch(&$request)
Extract "power search" namespace settings from the request object, returning a list of index numbers ...
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
Status $loadStatus
Holds any parameter validation errors that should be displayed back to the user.
showCreateLink( $title, $num, $titleMatches, $textMatches)
MediaWiki Linker LinkRenderer null $linkRenderer
Definition: SpecialPage.php:67
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:319