MediaWiki  master
SearchEngine.php
Go to the documentation of this file.
1 <?php
29 
34 abstract class SearchEngine {
35  const DEFAULT_SORT = 'relevance';
36 
38  public $prefix = '';
39 
41  public $namespaces = [ NS_MAIN ];
42 
44  protected $limit = 10;
45 
47  protected $offset = 0;
48 
50  protected $searchTerms = [];
51 
53  protected $showSuggestion = true;
54  private $sort = self::DEFAULT_SORT;
55 
57  protected $features = [];
58 
60  const COMPLETION_PROFILE_TYPE = 'completionSearchProfile';
61 
63  const FT_QUERY_INDEP_PROFILE_TYPE = 'fulltextQueryIndepProfile';
64 
66  const CHARS_ALL = 1;
67 
69  const CHARS_NO_SYNTAX = 2;
70 
81  public function searchText( $term ) {
82  return $this->maybePaginate( function () use ( $term ) {
83  return $this->doSearchText( $term );
84  } );
85  }
86 
94  protected function doSearchText( $term ) {
95  return null;
96  }
97 
112  public function searchArchiveTitle( $term ) {
113  return $this->doSearchArchiveTitle( $term );
114  }
115 
123  protected function doSearchArchiveTitle( $term ) {
124  return Status::newGood( [] );
125  }
126 
138  public function searchTitle( $term ) {
139  return $this->maybePaginate( function () use ( $term ) {
140  return $this->doSearchTitle( $term );
141  } );
142  }
143 
151  protected function doSearchTitle( $term ) {
152  return null;
153  }
154 
163  private function maybePaginate( Closure $fn ) {
164  if ( $this instanceof PaginatingSearchEngine ) {
165  return $fn();
166  }
167  $this->limit++;
168  try {
169  $resultSetOrStatus = $fn();
170  } finally {
171  $this->limit--;
172  }
173 
174  $resultSet = null;
175  if ( $resultSetOrStatus instanceof SearchResultSet ) {
176  $resultSet = $resultSetOrStatus;
177  } elseif ( $resultSetOrStatus instanceof Status &&
178  $resultSetOrStatus->getValue() instanceof SearchResultSet
179  ) {
180  $resultSet = $resultSetOrStatus->getValue();
181  }
182  if ( $resultSet ) {
183  $resultSet->shrink( $this->limit );
184  }
185 
186  return $resultSetOrStatus;
187  }
188 
194  public function supports( $feature ) {
195  switch ( $feature ) {
196  case 'search-update':
197  return true;
198  case 'title-suffix-filter':
199  default:
200  return false;
201  }
202  }
203 
210  public function setFeatureData( $feature, $data ) {
211  $this->features[$feature] = $data;
212  }
213 
221  public function getFeatureData( $feature ) {
222  return $this->features[$feature] ?? null;
223  }
224 
233  public function normalizeText( $string ) {
234  // Some languages such as Chinese require word segmentation
235  return MediaWikiServices::getInstance()->getContentLanguage()->segmentByWord( $string );
236  }
237 
247  public function transformSearchTerm( $term ) {
248  return $term;
249  }
250 
256  public function getNearMatcher( Config $config ) {
257  return new SearchNearMatcher( $config,
258  MediaWikiServices::getInstance()->getContentLanguage() );
259  }
260 
265  protected static function defaultNearMatcher() {
266  $services = MediaWikiServices::getInstance();
267  $config = $services->getMainConfig();
268  return $services->newSearchEngine()->getNearMatcher( $config );
269  }
270 
277  public function legalSearchChars( $type = self::CHARS_ALL ) {
278  return "A-Za-z_'.0-9\\x80-\\xFF\\-";
279  }
280 
288  function setLimitOffset( $limit, $offset = 0 ) {
289  $this->limit = intval( $limit );
290  $this->offset = intval( $offset );
291  }
292 
300  if ( $namespaces ) {
301  // Filter namespaces to only keep valid ones
302  $validNs = MediaWikiServices::getInstance()->getSearchEngineConfig()->searchableNamespaces();
303  $namespaces = array_filter( $namespaces, function ( $ns ) use( $validNs ) {
304  return $ns < 0 || isset( $validNs[$ns] );
305  } );
306  } else {
307  $namespaces = [];
308  }
309  $this->namespaces = $namespaces;
310  }
311 
320  $this->showSuggestion = $showSuggestion;
321  }
322 
330  public function getValidSorts() {
331  return [ self::DEFAULT_SORT ];
332  }
333 
342  public function setSort( $sort ) {
343  if ( !in_array( $sort, $this->getValidSorts() ) ) {
344  throw new InvalidArgumentException( "Invalid sort: $sort. " .
345  "Must be one of: " . implode( ', ', $this->getValidSorts() ) );
346  }
347  $this->sort = $sort;
348  }
349 
356  public function getSort() {
357  return $this->sort;
358  }
359 
369  function replacePrefixes( $query ) {
370  return $query;
371  }
372 
388  public static function parseNamespacePrefixes(
389  $query,
390  $withAllKeyword = true,
391  $withPrefixSearchExtractNamespaceHook = false
392  ) {
393  $parsed = $query;
394  if ( strpos( $query, ':' ) === false ) { // nothing to do
395  return false;
396  }
397  $extractedNamespace = null;
398 
399  $allQuery = false;
400  if ( $withAllKeyword ) {
401  $allkeywords = [];
402 
403  $allkeywords[] = wfMessage( 'searchall' )->inContentLanguage()->text() . ":";
404  // force all: so that we have a common syntax for all the wikis
405  if ( !in_array( 'all:', $allkeywords ) ) {
406  $allkeywords[] = 'all:';
407  }
408 
409  foreach ( $allkeywords as $kw ) {
410  if ( strncmp( $query, $kw, strlen( $kw ) ) == 0 ) {
411  $extractedNamespace = null;
412  $parsed = substr( $query, strlen( $kw ) );
413  $allQuery = true;
414  break;
415  }
416  }
417  }
418 
419  if ( !$allQuery && strpos( $query, ':' ) !== false ) {
420  $prefix = str_replace( ' ', '_', substr( $query, 0, strpos( $query, ':' ) ) );
421  $index = MediaWikiServices::getInstance()->getContentLanguage()->getNsIndex( $prefix );
422  if ( $index !== false ) {
423  $extractedNamespace = [ $index ];
424  $parsed = substr( $query, strlen( $prefix ) + 1 );
425  } elseif ( $withPrefixSearchExtractNamespaceHook ) {
426  $hookNamespaces = [ NS_MAIN ];
427  $hookQuery = $query;
428  Hooks::run( 'PrefixSearchExtractNamespace', [ &$hookNamespaces, &$hookQuery ] );
429  if ( $hookQuery !== $query ) {
430  $parsed = $hookQuery;
431  $extractedNamespace = $hookNamespaces;
432  } else {
433  return false;
434  }
435  } else {
436  return false;
437  }
438  }
439 
440  return [ $parsed, $extractedNamespace ];
441  }
442 
447  public static function userHighlightPrefs() {
448  $contextlines = 2; // Hardcode this. Old defaults sucked. :)
449  $contextchars = 75; // same as above.... :P
450  return [ $contextlines, $contextchars ];
451  }
452 
462  function update( $id, $title, $text ) {
463  // no-op
464  }
465 
474  function updateTitle( $id, $title ) {
475  // no-op
476  }
477 
486  function delete( $id, $title ) {
487  // no-op
488  }
489 
500  public function getTextFromContent( Title $t, Content $c = null ) {
501  return $c ? $c->getTextForSearchIndex() : '';
502  }
503 
511  public function textAlreadyUpdatedForIndex() {
512  return false;
513  }
514 
521  protected function normalizeNamespaces( $search ) {
522  $queryAndNs = self::parseNamespacePrefixes( $search, false, true );
523  if ( $queryAndNs !== false ) {
524  $this->setNamespaces( $queryAndNs[1] );
525  return $queryAndNs[0];
526  }
527  return $search;
528  }
529 
537  protected function completionSearchBackendOverfetch( $search ) {
538  $this->limit++;
539  try {
540  return $this->completionSearchBackend( $search );
541  } finally {
542  $this->limit--;
543  }
544  }
545 
553  protected function completionSearchBackend( $search ) {
554  $results = [];
555 
556  $search = trim( $search );
557 
558  if ( !in_array( NS_SPECIAL, $this->namespaces ) && // We do not run hook on Special: search
559  !Hooks::run( 'PrefixSearchBackend',
560  [ $this->namespaces, $search, $this->limit, &$results, $this->offset ]
561  ) ) {
562  // False means hook worked.
563  // FIXME: Yes, the API is weird. That's why it is going to be deprecated.
564 
565  return SearchSuggestionSet::fromStrings( $results );
566  } else {
567  // Hook did not do the job, use default simple search
568  $results = $this->simplePrefixSearch( $search );
569  return SearchSuggestionSet::fromTitles( $results );
570  }
571  }
572 
578  public function completionSearch( $search ) {
579  if ( trim( $search ) === '' ) {
580  return SearchSuggestionSet::emptySuggestionSet(); // Return empty result
581  }
582  $search = $this->normalizeNamespaces( $search );
583  $suggestions = $this->completionSearchBackendOverfetch( $search );
584  return $this->processCompletionResults( $search, $suggestions );
585  }
586 
592  public function completionSearchWithVariants( $search ) {
593  if ( trim( $search ) === '' ) {
594  return SearchSuggestionSet::emptySuggestionSet(); // Return empty result
595  }
596  $search = $this->normalizeNamespaces( $search );
597 
598  $results = $this->completionSearchBackendOverfetch( $search );
599  $fallbackLimit = 1 + $this->limit - $results->getSize();
600  if ( $fallbackLimit > 0 ) {
601  $fallbackSearches = MediaWikiServices::getInstance()->getContentLanguage()->
602  autoConvertToAllVariants( $search );
603  $fallbackSearches = array_diff( array_unique( $fallbackSearches ), [ $search ] );
604 
605  foreach ( $fallbackSearches as $fbs ) {
606  $this->setLimitOffset( $fallbackLimit );
607  $fallbackSearchResult = $this->completionSearch( $fbs );
608  $results->appendAll( $fallbackSearchResult );
609  $fallbackLimit -= $fallbackSearchResult->getSize();
610  if ( $fallbackLimit <= 0 ) {
611  break;
612  }
613  }
614  }
615  return $this->processCompletionResults( $search, $results );
616  }
617 
623  public function extractTitles( SearchSuggestionSet $completionResults ) {
624  return $completionResults->map( function ( SearchSuggestion $sugg ) {
625  return $sugg->getSuggestedTitle();
626  } );
627  }
628 
636  protected function processCompletionResults( $search, SearchSuggestionSet $suggestions ) {
637  // We over-fetched to determine pagination. Shrink back down if we have extra results
638  // and mark if pagination is possible
639  $suggestions->shrink( $this->limit );
640 
641  $search = trim( $search );
642  // preload the titles with LinkBatch
643  $lb = new LinkBatch( $suggestions->map( function ( SearchSuggestion $sugg ) {
644  return $sugg->getSuggestedTitle();
645  } ) );
646  $lb->setCaller( __METHOD__ );
647  $lb->execute();
648 
649  $diff = $suggestions->filter( function ( SearchSuggestion $sugg ) {
650  return $sugg->getSuggestedTitle()->isKnown();
651  } );
652  if ( $diff > 0 ) {
653  MediaWikiServices::getInstance()->getStatsdDataFactory()
654  ->updateCount( 'search.completion.missing', $diff );
655  }
656 
657  $results = $suggestions->map( function ( SearchSuggestion $sugg ) {
658  return $sugg->getSuggestedTitle()->getPrefixedText();
659  } );
660 
661  if ( $this->offset === 0 ) {
662  // Rescore results with an exact title match
663  // NOTE: in some cases like cross-namespace redirects
664  // (frequently used as shortcuts e.g. WP:WP on huwiki) some
665  // backends like Cirrus will return no results. We should still
666  // try an exact title match to workaround this limitation
667  $rescorer = new SearchExactMatchRescorer();
668  $rescoredResults = $rescorer->rescore( $search, $this->namespaces, $results, $this->limit );
669  } else {
670  // No need to rescore if offset is not 0
671  // The exact match must have been returned at position 0
672  // if it existed.
673  $rescoredResults = $results;
674  }
675 
676  if ( count( $rescoredResults ) > 0 ) {
677  $found = array_search( $rescoredResults[0], $results );
678  if ( $found === false ) {
679  // If the first result is not in the previous array it
680  // means that we found a new exact match
681  $exactMatch = SearchSuggestion::fromTitle( 0, Title::newFromText( $rescoredResults[0] ) );
682  $suggestions->prepend( $exactMatch );
683  $suggestions->shrink( $this->limit );
684  } else {
685  // if the first result is not the same we need to rescore
686  if ( $found > 0 ) {
687  $suggestions->rescore( $found );
688  }
689  }
690  }
691 
692  return $suggestions;
693  }
694 
700  public function defaultPrefixSearch( $search ) {
701  if ( trim( $search ) === '' ) {
702  return [];
703  }
704 
705  $search = $this->normalizeNamespaces( $search );
706  return $this->simplePrefixSearch( $search );
707  }
708 
715  protected function simplePrefixSearch( $search ) {
716  // Use default database prefix search
717  $backend = new TitlePrefixSearch;
718  return $backend->defaultSearchBackend( $this->namespaces, $search, $this->limit, $this->offset );
719  }
720 
736  public function getProfiles( $profileType, User $user = null ) {
737  return null;
738  }
739 
748  public function makeSearchFieldMapping( $name, $type ) {
749  return new NullIndexField();
750  }
751 
757  public function getSearchIndexFields() {
759  $fields = [];
760  $seenHandlers = new SplObjectStorage();
761  foreach ( $models as $model ) {
762  try {
764  }
766  // If we can find no handler, ignore it
767  continue;
768  }
769  // Several models can have the same handler, so avoid processing it repeatedly
770  if ( $seenHandlers->contains( $handler ) ) {
771  // We already did this one
772  continue;
773  }
774  $seenHandlers->attach( $handler );
775  $handlerFields = $handler->getFieldsForSearchIndex( $this );
776  foreach ( $handlerFields as $fieldName => $fieldData ) {
777  if ( empty( $fields[$fieldName] ) ) {
778  $fields[$fieldName] = $fieldData;
779  } else {
780  // TODO: do we allow some clashes with the same type or reject all of them?
781  $mergeDef = $fields[$fieldName]->merge( $fieldData );
782  if ( !$mergeDef ) {
783  throw new InvalidArgumentException( "Duplicate field $fieldName for model $model" );
784  }
785  $fields[$fieldName] = $mergeDef;
786  }
787  }
788  }
789  // Hook to allow extensions to produce search mapping fields
790  Hooks::run( 'SearchIndexFields', [ &$fields, $this ] );
791  return $fields;
792  }
793 
799  public function augmentSearchResults( SearchResultSet $resultSet ) {
800  $setAugmentors = [];
801  $rowAugmentors = [];
802  Hooks::run( "SearchResultsAugment", [ &$setAugmentors, &$rowAugmentors ] );
803  if ( !$setAugmentors && !$rowAugmentors ) {
804  // We're done here
805  return;
806  }
807 
808  // Convert row augmentors to set augmentor
809  foreach ( $rowAugmentors as $name => $row ) {
810  if ( isset( $setAugmentors[$name] ) ) {
811  throw new InvalidArgumentException( "Both row and set augmentors are defined for $name" );
812  }
813  $setAugmentors[$name] = new PerRowAugmentor( $row );
814  }
815 
816  foreach ( $setAugmentors as $name => $augmentor ) {
817  $data = $augmentor->augmentAll( $resultSet );
818  if ( $data ) {
819  $resultSet->setAugmentedData( $name, $data );
820  }
821  }
822  }
823 }
getSort()
Get the sort direction of the search results.
the value to return A Title object or null for latest all implement SearchIndexField must implement ResultSetAugmentor & $rowAugmentors
Definition: hooks.txt:2898
string $prefix
updateTitle( $id, $title)
Update a search index record&#39;s title only.
searchTitle( $term)
Perform a title-only search query and return a result set.
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1585
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
Search suggestion.
whereas SearchGetNearMatch runs after $term
Definition: hooks.txt:2875
const NS_MAIN
Definition: Defines.php:64
to move a page</td >< td > &*You are moving the page across namespaces
replacePrefixes( $query)
Parse some common prefixes: all (search everything) or namespace names and set the list of namespaces...
normalizeNamespaces( $search)
Makes search simple string if it was namespaced.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2159
static parseNamespacePrefixes( $query, $withAllKeyword=true, $withPrefixSearchExtractNamespaceHook=false)
Parse some common prefixes: all (search everything) or namespace names.
static getContentModels()
completionSearchBackendOverfetch( $search)
Perform an overfetch of completion search results.
processCompletionResults( $search, SearchSuggestionSet $suggestions)
Process completion search results.
doSearchText( $term)
Perform a full text search query and return a result set.
const NS_SPECIAL
Definition: Defines.php:53
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:23
setAugmentedData( $name, $data)
Sets augmented data for result set.
simplePrefixSearch( $search)
Call out to simple search backend.
getSuggestedTitle()
Title object in the case this suggestion is based on a title.
Null index field - means search engine does not implement this field.
setShowSuggestion( $showSuggestion)
Set whether the searcher should try to build a suggestion.
static fromStrings(array $titles, $hasMoreResults=false)
Builds a new set of suggestion based on a string array.
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:48
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves $handler
Definition: hooks.txt:780
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition: LinkBatch.php:34
update( $id, $title, $text)
Create or update the search index record for the given page.
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
Interface for configuration instances.
Definition: Config.php:28
static getForModelID( $modelId)
Returns the ContentHandler singleton for the given model ID.
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place or wrap services the preferred way to define a new service is the $wgServiceWiringFiles array $services
Definition: hooks.txt:2217
setNamespaces( $namespaces)
Set which namespaces the search should include.
prepend(SearchSuggestion $suggestion)
Add a new suggestion at the top.
searchArchiveTitle( $term)
Perform a title search in the article archive.
getTextFromContent(Title $t, Content $c=null)
Get the raw text for updating the index from a content object Nicer search backends could possibly do...
array string $searchTerms
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
An utility class to rescore search results by looking for an exact match in the db and add the page f...
legalSearchChars( $type=self::CHARS_ALL)
Get chars legal for search.
setLimitOffset( $limit, $offset=0)
Set the maximum number of results to return and how many to skip before returning the first...
getFeatureData( $feature)
Way to retrieve custom data set by setFeatureData or by the engine itself.
getProfiles( $profileType, User $user=null)
Get a list of supported profiles.
textAlreadyUpdatedForIndex()
If an implementation of SearchEngine handles all of its own text processing in getTextFromContent() a...
getValidSorts()
Get the valid sort directions.
filter( $callback)
Filter the suggestions array.
static defaultNearMatcher()
Get near matcher for default SearchEngine.
setSort( $sort)
Set the sort direction of the search results.
makeSearchFieldMapping( $name, $type)
Create a search field definition.
const DEFAULT_SORT
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback function
Definition: injection.txt:30
const COMPLETION_PROFILE_TYPE
Profile type for completionSearch.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
doSearchArchiveTitle( $term)
Perform a title search in the article archive.
bool $showSuggestion
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
extractTitles(SearchSuggestionSet $completionResults)
Extract titles from completion results.
const CHARS_ALL
Integer flag for legalSearchChars: includes all chars allowed in a search query.
setFeatureData( $feature, $data)
Way to pass custom data for engines.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
Performs prefix search, returning Title objects.
rescore( $key)
Move the suggestion at index $key to the first position.
const FT_QUERY_INDEP_PROFILE_TYPE
Profile type for query independent ranking features.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
int [] null $namespaces
static fromTitle( $score, Title $title)
Create suggestion from Title.
Implementation of near match title search.
completionSearchBackend( $search)
Perform a completion search.
completionSearchWithVariants( $search)
Perform a completion search with variants.
Marker class for search engines that can handle their own pagination, by reporting in their SearchRes...
static fromTitles(array $titles, $hasMoreResults=false)
Builds a new set of suggestion based on a title array.
array $features
Feature values.
defaultPrefixSearch( $search)
Simple prefix search for subpages.
augmentSearchResults(SearchResultSet $resultSet)
Augment search results with extra data.
getSearchIndexFields()
Get fields for search index.
maybePaginate(Closure $fn)
Performs an overfetch and shrink operation to determine if the next page is available for search engi...
Search suggestion sets.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
Perform augmentation of each row and return composite result, indexed by ID.
completionSearch( $search)
Perform a completion search.
doSearchTitle( $term)
Perform a title-only search query and return a result set.
transformSearchTerm( $term)
Transform search term in cases when parts of the query came as different GET params (when supported)...
supports( $feature)
defaultSearchBackend( $namespaces, $search, $limit, $offset)
Unless overridden by PrefixSearchBackend hook...
getNearMatcher(Config $config)
Get service class to finding near matches.
searchText( $term)
Perform a full text search query and return a result set.
const CHARS_NO_SYNTAX
Integer flag for legalSearchChars: includes all chars allowed in a search term.
normalizeText( $string)
When overridden in derived class, performs database-specific conversions on text to be used for searc...
map( $callback)
Call array_map on the suggestions array.
static userHighlightPrefs()
Find snippet highlight settings for all users.
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1473
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
shrink( $limit)
Remove any extra elements in the suggestions set.
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