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 
243  public function getNearMatcher( Config $config ) {
244  return new SearchNearMatcher( $config,
245  MediaWikiServices::getInstance()->getContentLanguage() );
246  }
247 
252  protected static function defaultNearMatcher() {
253  $services = MediaWikiServices::getInstance();
254  $config = $services->getMainConfig();
255  return $services->newSearchEngine()->getNearMatcher( $config );
256  }
257 
264  public function legalSearchChars( $type = self::CHARS_ALL ) {
265  return "A-Za-z_'.0-9\\x80-\\xFF\\-";
266  }
267 
275  function setLimitOffset( $limit, $offset = 0 ) {
276  $this->limit = intval( $limit );
277  $this->offset = intval( $offset );
278  }
279 
287  if ( $namespaces ) {
288  // Filter namespaces to only keep valid ones
289  $validNs = MediaWikiServices::getInstance()->getSearchEngineConfig()->searchableNamespaces();
290  $namespaces = array_filter( $namespaces, function ( $ns ) use( $validNs ) {
291  return $ns < 0 || isset( $validNs[$ns] );
292  } );
293  } else {
294  $namespaces = [];
295  }
296  $this->namespaces = $namespaces;
297  }
298 
307  $this->showSuggestion = $showSuggestion;
308  }
309 
317  public function getValidSorts() {
318  return [ self::DEFAULT_SORT ];
319  }
320 
329  public function setSort( $sort ) {
330  if ( !in_array( $sort, $this->getValidSorts() ) ) {
331  throw new InvalidArgumentException( "Invalid sort: $sort. " .
332  "Must be one of: " . implode( ', ', $this->getValidSorts() ) );
333  }
334  $this->sort = $sort;
335  }
336 
343  public function getSort() {
344  return $this->sort;
345  }
346 
356  function replacePrefixes( $query ) {
357  return $query;
358  }
359 
375  public static function parseNamespacePrefixes(
376  $query,
377  $withAllKeyword = true,
378  $withPrefixSearchExtractNamespaceHook = false
379  ) {
380  $parsed = $query;
381  if ( strpos( $query, ':' ) === false ) { // nothing to do
382  return false;
383  }
384  $extractedNamespace = null;
385 
386  $allQuery = false;
387  if ( $withAllKeyword ) {
388  $allkeywords = [];
389 
390  $allkeywords[] = wfMessage( 'searchall' )->inContentLanguage()->text() . ":";
391  // force all: so that we have a common syntax for all the wikis
392  if ( !in_array( 'all:', $allkeywords ) ) {
393  $allkeywords[] = 'all:';
394  }
395 
396  foreach ( $allkeywords as $kw ) {
397  if ( strncmp( $query, $kw, strlen( $kw ) ) == 0 ) {
398  $extractedNamespace = null;
399  $parsed = substr( $query, strlen( $kw ) );
400  $allQuery = true;
401  break;
402  }
403  }
404  }
405 
406  if ( !$allQuery && strpos( $query, ':' ) !== false ) {
407  $prefix = str_replace( ' ', '_', substr( $query, 0, strpos( $query, ':' ) ) );
408  $index = MediaWikiServices::getInstance()->getContentLanguage()->getNsIndex( $prefix );
409  if ( $index !== false ) {
410  $extractedNamespace = [ $index ];
411  $parsed = substr( $query, strlen( $prefix ) + 1 );
412  } elseif ( $withPrefixSearchExtractNamespaceHook ) {
413  $hookNamespaces = [ NS_MAIN ];
414  $hookQuery = $query;
415  Hooks::run( 'PrefixSearchExtractNamespace', [ &$hookNamespaces, &$hookQuery ] );
416  if ( $hookQuery !== $query ) {
417  $parsed = $hookQuery;
418  $extractedNamespace = $hookNamespaces;
419  } else {
420  return false;
421  }
422  } else {
423  return false;
424  }
425  }
426 
427  return [ $parsed, $extractedNamespace ];
428  }
429 
434  public static function userHighlightPrefs() {
435  $contextlines = 2; // Hardcode this. Old defaults sucked. :)
436  $contextchars = 75; // same as above.... :P
437  return [ $contextlines, $contextchars ];
438  }
439 
449  function update( $id, $title, $text ) {
450  // no-op
451  }
452 
461  function updateTitle( $id, $title ) {
462  // no-op
463  }
464 
473  function delete( $id, $title ) {
474  // no-op
475  }
476 
487  public function getTextFromContent( Title $t, Content $c = null ) {
488  return $c ? $c->getTextForSearchIndex() : '';
489  }
490 
498  public function textAlreadyUpdatedForIndex() {
499  return false;
500  }
501 
508  protected function normalizeNamespaces( $search ) {
509  $queryAndNs = self::parseNamespacePrefixes( $search, false, true );
510  if ( $queryAndNs !== false ) {
511  $this->setNamespaces( $queryAndNs[1] );
512  return $queryAndNs[0];
513  }
514  return $search;
515  }
516 
524  protected function completionSearchBackendOverfetch( $search ) {
525  $this->limit++;
526  try {
527  return $this->completionSearchBackend( $search );
528  } finally {
529  $this->limit--;
530  }
531  }
532 
540  protected function completionSearchBackend( $search ) {
541  $results = [];
542 
543  $search = trim( $search );
544 
545  if ( !in_array( NS_SPECIAL, $this->namespaces ) && // We do not run hook on Special: search
546  !Hooks::run( 'PrefixSearchBackend',
547  [ $this->namespaces, $search, $this->limit, &$results, $this->offset ]
548  ) ) {
549  // False means hook worked.
550  // FIXME: Yes, the API is weird. That's why it is going to be deprecated.
551 
552  return SearchSuggestionSet::fromStrings( $results );
553  } else {
554  // Hook did not do the job, use default simple search
555  $results = $this->simplePrefixSearch( $search );
556  return SearchSuggestionSet::fromTitles( $results );
557  }
558  }
559 
565  public function completionSearch( $search ) {
566  if ( trim( $search ) === '' ) {
567  return SearchSuggestionSet::emptySuggestionSet(); // Return empty result
568  }
569  $search = $this->normalizeNamespaces( $search );
570  $suggestions = $this->completionSearchBackendOverfetch( $search );
571  return $this->processCompletionResults( $search, $suggestions );
572  }
573 
579  public function completionSearchWithVariants( $search ) {
580  if ( trim( $search ) === '' ) {
581  return SearchSuggestionSet::emptySuggestionSet(); // Return empty result
582  }
583  $search = $this->normalizeNamespaces( $search );
584 
585  $results = $this->completionSearchBackendOverfetch( $search );
586  $fallbackLimit = 1 + $this->limit - $results->getSize();
587  if ( $fallbackLimit > 0 ) {
588  $fallbackSearches = MediaWikiServices::getInstance()->getContentLanguage()->
589  autoConvertToAllVariants( $search );
590  $fallbackSearches = array_diff( array_unique( $fallbackSearches ), [ $search ] );
591 
592  foreach ( $fallbackSearches as $fbs ) {
593  $this->setLimitOffset( $fallbackLimit );
594  $fallbackSearchResult = $this->completionSearch( $fbs );
595  $results->appendAll( $fallbackSearchResult );
596  $fallbackLimit -= $fallbackSearchResult->getSize();
597  if ( $fallbackLimit <= 0 ) {
598  break;
599  }
600  }
601  }
602  return $this->processCompletionResults( $search, $results );
603  }
604 
610  public function extractTitles( SearchSuggestionSet $completionResults ) {
611  return $completionResults->map( function ( SearchSuggestion $sugg ) {
612  return $sugg->getSuggestedTitle();
613  } );
614  }
615 
623  protected function processCompletionResults( $search, SearchSuggestionSet $suggestions ) {
624  // We over-fetched to determine pagination. Shrink back down if we have extra results
625  // and mark if pagination is possible
626  $suggestions->shrink( $this->limit );
627 
628  $search = trim( $search );
629  // preload the titles with LinkBatch
630  $lb = new LinkBatch( $suggestions->map( function ( SearchSuggestion $sugg ) {
631  return $sugg->getSuggestedTitle();
632  } ) );
633  $lb->setCaller( __METHOD__ );
634  $lb->execute();
635 
636  $diff = $suggestions->filter( function ( SearchSuggestion $sugg ) {
637  return $sugg->getSuggestedTitle()->isKnown();
638  } );
639  if ( $diff > 0 ) {
640  MediaWikiServices::getInstance()->getStatsdDataFactory()
641  ->updateCount( 'search.completion.missing', $diff );
642  }
643 
644  $results = $suggestions->map( function ( SearchSuggestion $sugg ) {
645  return $sugg->getSuggestedTitle()->getPrefixedText();
646  } );
647 
648  if ( $this->offset === 0 ) {
649  // Rescore results with an exact title match
650  // NOTE: in some cases like cross-namespace redirects
651  // (frequently used as shortcuts e.g. WP:WP on huwiki) some
652  // backends like Cirrus will return no results. We should still
653  // try an exact title match to workaround this limitation
654  $rescorer = new SearchExactMatchRescorer();
655  $rescoredResults = $rescorer->rescore( $search, $this->namespaces, $results, $this->limit );
656  } else {
657  // No need to rescore if offset is not 0
658  // The exact match must have been returned at position 0
659  // if it existed.
660  $rescoredResults = $results;
661  }
662 
663  if ( count( $rescoredResults ) > 0 ) {
664  $found = array_search( $rescoredResults[0], $results );
665  if ( $found === false ) {
666  // If the first result is not in the previous array it
667  // means that we found a new exact match
668  $exactMatch = SearchSuggestion::fromTitle( 0, Title::newFromText( $rescoredResults[0] ) );
669  $suggestions->prepend( $exactMatch );
670  $suggestions->shrink( $this->limit );
671  } else {
672  // if the first result is not the same we need to rescore
673  if ( $found > 0 ) {
674  $suggestions->rescore( $found );
675  }
676  }
677  }
678 
679  return $suggestions;
680  }
681 
687  public function defaultPrefixSearch( $search ) {
688  if ( trim( $search ) === '' ) {
689  return [];
690  }
691 
692  $search = $this->normalizeNamespaces( $search );
693  return $this->simplePrefixSearch( $search );
694  }
695 
702  protected function simplePrefixSearch( $search ) {
703  // Use default database prefix search
704  $backend = new TitlePrefixSearch;
705  return $backend->defaultSearchBackend( $this->namespaces, $search, $this->limit, $this->offset );
706  }
707 
723  public function getProfiles( $profileType, User $user = null ) {
724  return null;
725  }
726 
735  public function makeSearchFieldMapping( $name, $type ) {
736  return new NullIndexField();
737  }
738 
744  public function getSearchIndexFields() {
746  $fields = [];
747  $seenHandlers = new SplObjectStorage();
748  foreach ( $models as $model ) {
749  try {
751  }
753  // If we can find no handler, ignore it
754  continue;
755  }
756  // Several models can have the same handler, so avoid processing it repeatedly
757  if ( $seenHandlers->contains( $handler ) ) {
758  // We already did this one
759  continue;
760  }
761  $seenHandlers->attach( $handler );
762  $handlerFields = $handler->getFieldsForSearchIndex( $this );
763  foreach ( $handlerFields as $fieldName => $fieldData ) {
764  if ( empty( $fields[$fieldName] ) ) {
765  $fields[$fieldName] = $fieldData;
766  } else {
767  // TODO: do we allow some clashes with the same type or reject all of them?
768  $mergeDef = $fields[$fieldName]->merge( $fieldData );
769  if ( !$mergeDef ) {
770  throw new InvalidArgumentException( "Duplicate field $fieldName for model $model" );
771  }
772  $fields[$fieldName] = $mergeDef;
773  }
774  }
775  }
776  // Hook to allow extensions to produce search mapping fields
777  Hooks::run( 'SearchIndexFields', [ &$fields, $this ] );
778  return $fields;
779  }
780 
786  public function augmentSearchResults( SearchResultSet $resultSet ) {
787  $setAugmentors = [];
788  $rowAugmentors = [];
789  Hooks::run( "SearchResultsAugment", [ &$setAugmentors, &$rowAugmentors ] );
790  if ( !$setAugmentors && !$rowAugmentors ) {
791  // We're done here
792  return;
793  }
794 
795  // Convert row augmentors to set augmentor
796  foreach ( $rowAugmentors as $name => $row ) {
797  if ( isset( $setAugmentors[$name] ) ) {
798  throw new InvalidArgumentException( "Both row and set augmentors are defined for $name" );
799  }
800  $setAugmentors[$name] = new PerRowAugmentor( $row );
801  }
802 
803  foreach ( $setAugmentors as $name => $augmentor ) {
804  $data = $augmentor->augmentAll( $resultSet );
805  if ( $data ) {
806  $resultSet->setAugmentedData( $name, $data );
807  }
808  }
809  }
810 }
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
Search suggestion.
whereas SearchGetNearMatch runs after $term
Definition: hooks.txt:2875
const NS_MAIN
Definition: Defines.php:60
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:49
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:51
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...
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.
string [] $searchTerms
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.
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