MediaWiki  1.33.0
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;
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 
278  public static function getNearMatch( $searchterm ) {
279  wfDeprecated( __METHOD__, '1.27' );
280 
281  return static::defaultNearMatcher()->getNearMatch( $searchterm );
282  }
283 
291  public static function legalSearchChars( $type = self::CHARS_ALL ) {
292  return "A-Za-z_'.0-9\\x80-\\xFF\\-";
293  }
294 
302  function setLimitOffset( $limit, $offset = 0 ) {
303  $this->limit = intval( $limit );
304  $this->offset = intval( $offset );
305  }
306 
314  if ( $namespaces ) {
315  // Filter namespaces to only keep valid ones
316  $validNs = MediaWikiServices::getInstance()->getSearchEngineConfig()->searchableNamespaces();
317  $namespaces = array_filter( $namespaces, function ( $ns ) use( $validNs ) {
318  return $ns < 0 || isset( $validNs[$ns] );
319  } );
320  } else {
321  $namespaces = [];
322  }
323  $this->namespaces = $namespaces;
324  }
325 
334  $this->showSuggestion = $showSuggestion;
335  }
336 
344  public function getValidSorts() {
345  return [ self::DEFAULT_SORT ];
346  }
347 
356  public function setSort( $sort ) {
357  if ( !in_array( $sort, $this->getValidSorts() ) ) {
358  throw new InvalidArgumentException( "Invalid sort: $sort. " .
359  "Must be one of: " . implode( ', ', $this->getValidSorts() ) );
360  }
361  $this->sort = $sort;
362  }
363 
370  public function getSort() {
371  return $this->sort;
372  }
373 
383  function replacePrefixes( $query ) {
384  return $query;
385  }
386 
402  public static function parseNamespacePrefixes(
403  $query,
404  $withAllKeyword = true,
405  $withPrefixSearchExtractNamespaceHook = false
406  ) {
407  $parsed = $query;
408  if ( strpos( $query, ':' ) === false ) { // nothing to do
409  return false;
410  }
411  $extractedNamespace = null;
412 
413  $allQuery = false;
414  if ( $withAllKeyword ) {
415  $allkeywords = [];
416 
417  $allkeywords[] = wfMessage( 'searchall' )->inContentLanguage()->text() . ":";
418  // force all: so that we have a common syntax for all the wikis
419  if ( !in_array( 'all:', $allkeywords ) ) {
420  $allkeywords[] = 'all:';
421  }
422 
423  foreach ( $allkeywords as $kw ) {
424  if ( strncmp( $query, $kw, strlen( $kw ) ) == 0 ) {
425  $extractedNamespace = null;
426  $parsed = substr( $query, strlen( $kw ) );
427  $allQuery = true;
428  break;
429  }
430  }
431  }
432 
433  if ( !$allQuery && strpos( $query, ':' ) !== false ) {
434  $prefix = str_replace( ' ', '_', substr( $query, 0, strpos( $query, ':' ) ) );
435  $index = MediaWikiServices::getInstance()->getContentLanguage()->getNsIndex( $prefix );
436  if ( $index !== false ) {
437  $extractedNamespace = [ $index ];
438  $parsed = substr( $query, strlen( $prefix ) + 1 );
439  } elseif ( $withPrefixSearchExtractNamespaceHook ) {
440  $hookNamespaces = [ NS_MAIN ];
441  $hookQuery = $query;
442  Hooks::run( 'PrefixSearchExtractNamespace', [ &$hookNamespaces, &$hookQuery ] );
443  if ( $hookQuery !== $query ) {
444  $parsed = $hookQuery;
445  $extractedNamespace = $hookNamespaces;
446  } else {
447  return false;
448  }
449  } else {
450  return false;
451  }
452  }
453 
454  return [ $parsed, $extractedNamespace ];
455  }
456 
461  public static function userHighlightPrefs() {
462  $contextlines = 2; // Hardcode this. Old defaults sucked. :)
463  $contextchars = 75; // same as above.... :P
464  return [ $contextlines, $contextchars ];
465  }
466 
476  function update( $id, $title, $text ) {
477  // no-op
478  }
479 
488  function updateTitle( $id, $title ) {
489  // no-op
490  }
491 
500  function delete( $id, $title ) {
501  // no-op
502  }
503 
514  public function getTextFromContent( Title $t, Content $c = null ) {
515  return $c ? $c->getTextForSearchIndex() : '';
516  }
517 
525  public function textAlreadyUpdatedForIndex() {
526  return false;
527  }
528 
535  protected function normalizeNamespaces( $search ) {
536  $queryAndNs = self::parseNamespacePrefixes( $search, false, true );
537  if ( $queryAndNs !== false ) {
538  $this->setNamespaces( $queryAndNs[1] );
539  return $queryAndNs[0];
540  }
541  return $search;
542  }
543 
551  protected function completionSearchBackendOverfetch( $search ) {
552  $this->limit++;
553  try {
554  return $this->completionSearchBackend( $search );
555  } finally {
556  $this->limit--;
557  }
558  }
559 
567  protected function completionSearchBackend( $search ) {
568  $results = [];
569 
570  $search = trim( $search );
571 
572  if ( !in_array( NS_SPECIAL, $this->namespaces ) && // We do not run hook on Special: search
573  !Hooks::run( 'PrefixSearchBackend',
574  [ $this->namespaces, $search, $this->limit, &$results, $this->offset ]
575  ) ) {
576  // False means hook worked.
577  // FIXME: Yes, the API is weird. That's why it is going to be deprecated.
578 
579  return SearchSuggestionSet::fromStrings( $results );
580  } else {
581  // Hook did not do the job, use default simple search
582  $results = $this->simplePrefixSearch( $search );
583  return SearchSuggestionSet::fromTitles( $results );
584  }
585  }
586 
592  public function completionSearch( $search ) {
593  if ( trim( $search ) === '' ) {
594  return SearchSuggestionSet::emptySuggestionSet(); // Return empty result
595  }
596  $search = $this->normalizeNamespaces( $search );
597  $suggestions = $this->completionSearchBackendOverfetch( $search );
598  return $this->processCompletionResults( $search, $suggestions );
599  }
600 
606  public function completionSearchWithVariants( $search ) {
607  if ( trim( $search ) === '' ) {
608  return SearchSuggestionSet::emptySuggestionSet(); // Return empty result
609  }
610  $search = $this->normalizeNamespaces( $search );
611 
612  $results = $this->completionSearchBackendOverfetch( $search );
613  $fallbackLimit = 1 + $this->limit - $results->getSize();
614  if ( $fallbackLimit > 0 ) {
615  $fallbackSearches = MediaWikiServices::getInstance()->getContentLanguage()->
616  autoConvertToAllVariants( $search );
617  $fallbackSearches = array_diff( array_unique( $fallbackSearches ), [ $search ] );
618 
619  foreach ( $fallbackSearches as $fbs ) {
620  $this->setLimitOffset( $fallbackLimit );
621  $fallbackSearchResult = $this->completionSearch( $fbs );
622  $results->appendAll( $fallbackSearchResult );
623  $fallbackLimit -= $fallbackSearchResult->getSize();
624  if ( $fallbackLimit <= 0 ) {
625  break;
626  }
627  }
628  }
629  return $this->processCompletionResults( $search, $results );
630  }
631 
637  public function extractTitles( SearchSuggestionSet $completionResults ) {
638  return $completionResults->map( function ( SearchSuggestion $sugg ) {
639  return $sugg->getSuggestedTitle();
640  } );
641  }
642 
650  protected function processCompletionResults( $search, SearchSuggestionSet $suggestions ) {
651  // We over-fetched to determine pagination. Shrink back down if we have extra results
652  // and mark if pagination is possible
653  $suggestions->shrink( $this->limit );
654 
655  $search = trim( $search );
656  // preload the titles with LinkBatch
657  $lb = new LinkBatch( $suggestions->map( function ( SearchSuggestion $sugg ) {
658  return $sugg->getSuggestedTitle();
659  } ) );
660  $lb->setCaller( __METHOD__ );
661  $lb->execute();
662 
663  $diff = $suggestions->filter( function ( SearchSuggestion $sugg ) {
664  return $sugg->getSuggestedTitle()->isKnown();
665  } );
666  if ( $diff > 0 ) {
667  MediaWikiServices::getInstance()->getStatsdDataFactory()
668  ->updateCount( 'search.completion.missing', $diff );
669  }
670 
671  $results = $suggestions->map( function ( SearchSuggestion $sugg ) {
672  return $sugg->getSuggestedTitle()->getPrefixedText();
673  } );
674 
675  if ( $this->offset === 0 ) {
676  // Rescore results with an exact title match
677  // NOTE: in some cases like cross-namespace redirects
678  // (frequently used as shortcuts e.g. WP:WP on huwiki) some
679  // backends like Cirrus will return no results. We should still
680  // try an exact title match to workaround this limitation
681  $rescorer = new SearchExactMatchRescorer();
682  $rescoredResults = $rescorer->rescore( $search, $this->namespaces, $results, $this->limit );
683  } else {
684  // No need to rescore if offset is not 0
685  // The exact match must have been returned at position 0
686  // if it existed.
687  $rescoredResults = $results;
688  }
689 
690  if ( count( $rescoredResults ) > 0 ) {
691  $found = array_search( $rescoredResults[0], $results );
692  if ( $found === false ) {
693  // If the first result is not in the previous array it
694  // means that we found a new exact match
695  $exactMatch = SearchSuggestion::fromTitle( 0, Title::newFromText( $rescoredResults[0] ) );
696  $suggestions->prepend( $exactMatch );
697  $suggestions->shrink( $this->limit );
698  } else {
699  // if the first result is not the same we need to rescore
700  if ( $found > 0 ) {
701  $suggestions->rescore( $found );
702  }
703  }
704  }
705 
706  return $suggestions;
707  }
708 
714  public function defaultPrefixSearch( $search ) {
715  if ( trim( $search ) === '' ) {
716  return [];
717  }
718 
719  $search = $this->normalizeNamespaces( $search );
720  return $this->simplePrefixSearch( $search );
721  }
722 
729  protected function simplePrefixSearch( $search ) {
730  // Use default database prefix search
731  $backend = new TitlePrefixSearch;
732  return $backend->defaultSearchBackend( $this->namespaces, $search, $this->limit, $this->offset );
733  }
734 
740  public static function searchableNamespaces() {
741  wfDeprecated( __METHOD__, '1.27' );
742 
743  return MediaWikiServices::getInstance()->getSearchEngineConfig()->searchableNamespaces();
744  }
745 
753  public static function userNamespaces( $user ) {
754  wfDeprecated( __METHOD__, '1.27' );
755 
756  return MediaWikiServices::getInstance()->getSearchEngineConfig()->userNamespaces( $user );
757  }
758 
764  public static function defaultNamespaces() {
765  wfDeprecated( __METHOD__, '1.27' );
766 
767  return MediaWikiServices::getInstance()->getSearchEngineConfig()->defaultNamespaces();
768  }
769 
777  public static function namespacesAsText( $namespaces ) {
778  wfDeprecated( __METHOD__, '1.27' );
779 
780  return MediaWikiServices::getInstance()->getSearchEngineConfig()->namespacesAsText( $namespaces );
781  }
782 
790  public static function create( $type = null ) {
791  wfDeprecated( __METHOD__, '1.27' );
792 
793  return MediaWikiServices::getInstance()->getSearchEngineFactory()->create( $type );
794  }
795 
802  public static function getSearchTypes() {
803  wfDeprecated( __METHOD__, '1.27' );
804 
805  return MediaWikiServices::getInstance()->getSearchEngineConfig()->getSearchTypes();
806  }
807 
823  public function getProfiles( $profileType, User $user = null ) {
824  return null;
825  }
826 
835  public function makeSearchFieldMapping( $name, $type ) {
836  return new NullIndexField();
837  }
838 
844  public function getSearchIndexFields() {
846  $fields = [];
847  $seenHandlers = new SplObjectStorage();
848  foreach ( $models as $model ) {
849  try {
851  }
853  // If we can find no handler, ignore it
854  continue;
855  }
856  // Several models can have the same handler, so avoid processing it repeatedly
857  if ( $seenHandlers->contains( $handler ) ) {
858  // We already did this one
859  continue;
860  }
861  $seenHandlers->attach( $handler );
862  $handlerFields = $handler->getFieldsForSearchIndex( $this );
863  foreach ( $handlerFields as $fieldName => $fieldData ) {
864  if ( empty( $fields[$fieldName] ) ) {
865  $fields[$fieldName] = $fieldData;
866  } else {
867  // TODO: do we allow some clashes with the same type or reject all of them?
868  $mergeDef = $fields[$fieldName]->merge( $fieldData );
869  if ( !$mergeDef ) {
870  throw new InvalidArgumentException( "Duplicate field $fieldName for model $model" );
871  }
872  $fields[$fieldName] = $mergeDef;
873  }
874  }
875  }
876  // Hook to allow extensions to produce search mapping fields
877  Hooks::run( 'SearchIndexFields', [ &$fields, $this ] );
878  return $fields;
879  }
880 
886  public function augmentSearchResults( SearchResultSet $resultSet ) {
887  $setAugmentors = [];
888  $rowAugmentors = [];
889  Hooks::run( "SearchResultsAugment", [ &$setAugmentors, &$rowAugmentors ] );
890  if ( !$setAugmentors && !$rowAugmentors ) {
891  // We're done here
892  return;
893  }
894 
895  // Convert row augmentors to set augmentor
896  foreach ( $rowAugmentors as $name => $row ) {
897  if ( isset( $setAugmentors[$name] ) ) {
898  throw new InvalidArgumentException( "Both row and set augmentors are defined for $name" );
899  }
900  $setAugmentors[$name] = new PerRowAugmentor( $row );
901  }
902 
903  foreach ( $setAugmentors as $name => $augmentor ) {
904  $data = $augmentor->augmentAll( $resultSet );
905  if ( $data ) {
906  $resultSet->setAugmentedData( $name, $data );
907  }
908  }
909  }
910 }
SearchEngine\legalSearchChars
static legalSearchChars( $type=self::CHARS_ALL)
Get chars legal for search NOTE: usage as static is deprecated and preserved only as BC measure.
Definition: SearchEngine.php:291
SearchEngine\$showSuggestion
bool $showSuggestion
Definition: SearchEngine.php:53
SearchSuggestionSet\fromStrings
static fromStrings(array $titles, $hasMoreResults=false)
Builds a new set of suggestion based on a string array.
Definition: SearchSuggestionSet.php:227
SearchEngine\getSearchIndexFields
getSearchIndexFields()
Get fields for search index.
Definition: SearchEngine.php:844
SearchEngine\getProfiles
getProfiles( $profileType, User $user=null)
Get a list of supported profiles.
Definition: SearchEngine.php:823
ContentHandler\getForModelID
static getForModelID( $modelId)
Returns the ContentHandler singleton for the given model ID.
Definition: ContentHandler.php:252
SearchEngine\augmentSearchResults
augmentSearchResults(SearchResultSet $resultSet)
Augment search results with extra data.
Definition: SearchEngine.php:886
$user
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1476
$rowAugmentors
the value to return A Title object or null for latest all implement SearchIndexField must implement ResultSetAugmentor & $rowAugmentors
Definition: hooks.txt:2901
SearchSuggestionSet\map
map( $callback)
Call array_map on the suggestions array.
Definition: SearchSuggestionSet.php:86
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:306
SearchEngine\supports
supports( $feature)
Definition: SearchEngine.php:194
SearchEngine\setFeatureData
setFeatureData( $feature, $data)
Way to pass custom data for engines.
Definition: SearchEngine.php:210
SearchEngine\$limit
int $limit
Definition: SearchEngine.php:44
SearchEngine\getValidSorts
getValidSorts()
Get the valid sort directions.
Definition: SearchEngine.php:344
SearchEngine\$sort
$sort
Definition: SearchEngine.php:54
SearchEngine\completionSearchWithVariants
completionSearchWithVariants( $search)
Perform a completion search with variants.
Definition: SearchEngine.php:606
LinkBatch
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition: LinkBatch.php:34
TitlePrefixSearch
Performs prefix search, returning Title objects.
Definition: TitlePrefixSearch.php:28
captcha-old.count
count
Definition: captcha-old.py:249
SearchEngine\searchableNamespaces
static searchableNamespaces()
Make a list of searchable namespaces and their canonical names.
Definition: SearchEngine.php:740
SearchEngine\normalizeText
normalizeText( $string)
When overridden in derived class, performs database-specific conversions on text to be used for searc...
Definition: SearchEngine.php:233
SearchEngine\getSort
getSort()
Get the sort direction of the search results.
Definition: SearchEngine.php:370
SearchEngine\$namespaces
int[] null $namespaces
Definition: SearchEngine.php:41
SearchEngine\searchTitle
searchTitle( $term)
Perform a title-only search query and return a result set.
Definition: SearchEngine.php:138
SearchEngine\userHighlightPrefs
static userHighlightPrefs()
Find snippet highlight settings for all users.
Definition: SearchEngine.php:461
SearchEngine\FT_QUERY_INDEP_PROFILE_TYPE
const FT_QUERY_INDEP_PROFILE_TYPE
@const string profile type for query independent ranking features
Definition: SearchEngine.php:63
SearchEngine\completionSearchBackend
completionSearchBackend( $search)
Perform a completion search.
Definition: SearchEngine.php:567
function
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
SearchSuggestionSet\prepend
prepend(SearchSuggestion $suggestion)
Add a new suggestion at the top.
Definition: SearchSuggestionSet.php:148
SearchEngine\parseNamespacePrefixes
static parseNamespacePrefixes( $query, $withAllKeyword=true, $withPrefixSearchExtractNamespaceHook=false)
Parse some common prefixes: all (search everything) or namespace names.
Definition: SearchEngine.php:402
SearchEngine\doSearchTitle
doSearchTitle( $term)
Perform a title-only search query and return a result set.
Definition: SearchEngine.php:151
SearchEngine\completionSearchBackendOverfetch
completionSearchBackendOverfetch( $search)
Perform an overfetch of completion search results.
Definition: SearchEngine.php:551
SearchEngine\defaultNamespaces
static defaultNamespaces()
An array of namespaces indexes to be searched by default.
Definition: SearchEngine.php:764
php
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
SearchEngine\replacePrefixes
replacePrefixes( $query)
Parse some common prefixes: all (search everything) or namespace names and set the list of namespaces...
Definition: SearchEngine.php:383
SearchSuggestion\fromTitle
static fromTitle( $score, Title $title)
Create suggestion from Title.
Definition: SearchSuggestion.php:166
SearchEngine\DEFAULT_SORT
const DEFAULT_SORT
Definition: SearchEngine.php:35
SearchEngine\defaultPrefixSearch
defaultPrefixSearch( $search)
Simple prefix search for subpages.
Definition: SearchEngine.php:714
SearchEngine\COMPLETION_PROFILE_TYPE
const COMPLETION_PROFILE_TYPE
@const string profile type for completionSearch
Definition: SearchEngine.php:60
Status
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: Status.php:40
NS_MAIN
const NS_MAIN
Definition: Defines.php:64
StatusValue\getValue
getValue()
Definition: StatusValue.php:137
SearchEngine\textAlreadyUpdatedForIndex
textAlreadyUpdatedForIndex()
If an implementation of SearchEngine handles all of its own text processing in getTextFromContent() a...
Definition: SearchEngine.php:525
SearchSuggestionSet\fromTitles
static fromTitles(array $titles, $hasMoreResults=false)
Builds a new set of suggestion based on a title array.
Definition: SearchSuggestionSet.php:210
$query
null for the 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:1588
Config
Interface for configuration instances.
Definition: Config.php:28
NS_SPECIAL
const NS_SPECIAL
Definition: Defines.php:53
$data
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
Definition: generatePhpCharToUpperMappings.php:13
SearchEngine\setSort
setSort( $sort)
Set the sort direction of the search results.
Definition: SearchEngine.php:356
SearchExactMatchRescorer
An utility class to rescore search results by looking for an exact match in the db and add the page f...
Definition: SearchExactMatchRescorer.php:31
namespaces
to move a page</td >< td > &*You are moving the page across namespaces
Definition: All_system_messages.txt:2670
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
wfDeprecated
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
Definition: GlobalFunctions.php:1078
SearchNearMatcher
Implementation of near match title search.
Definition: SearchNearMatcher.php:7
SearchEngine\$offset
int $offset
Definition: SearchEngine.php:47
ContentHandler\getContentModels
static getContentModels()
Definition: ContentHandler.php:327
$handler
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
SearchEngine\CHARS_NO_SYNTAX
const CHARS_NO_SYNTAX
@const int flag for legalSearchChars: includes all chars allowed in a search term
Definition: SearchEngine.php:69
SearchEngine\getNearMatcher
getNearMatcher(Config $config)
Get service class to finding near matches.
Definition: SearchEngine.php:256
SearchEngine\searchText
searchText( $term)
Perform a full text search query and return a result set.
Definition: SearchEngine.php:81
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
SearchSuggestion
Search suggestion.
Definition: SearchSuggestion.php:25
PaginatingSearchEngine
Marker class for search engines that can handle their own pagination, by reporting in their SearchRes...
Definition: PaginatingSearchEngine.php:11
SearchResultSet
Definition: SearchResultSet.php:27
array
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
SearchEngine\$prefix
string $prefix
Definition: SearchEngine.php:38
SearchEngine\updateTitle
updateTitle( $id, $title)
Update a search index record's title only.
Definition: SearchEngine.php:488
SearchEngine\setNamespaces
setNamespaces( $namespaces)
Set which namespaces the search should include.
Definition: SearchEngine.php:313
$term
whereas SearchGetNearMatch runs after $term
Definition: hooks.txt:2878
SearchSuggestionSet\filter
filter( $callback)
Filter the suggestions array.
Definition: SearchSuggestionSet.php:96
SearchEngine\maybePaginate
maybePaginate(Closure $fn)
Performs an overfetch and shrink operation to determine if the next page is available for search engi...
Definition: SearchEngine.php:163
SearchEngine\update
update( $id, $title, $text)
Create or update the search index record for the given page.
Definition: SearchEngine.php:476
SearchResultSet\setAugmentedData
setAugmentedData( $name, $data)
Sets augmented data for result set.
Definition: SearchResultSet.php:325
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2162
SearchEngine\getTextFromContent
getTextFromContent(Title $t, Content $c=null)
Get the raw text for updating the index from a content object Nicer search backends could possibly do...
Definition: SearchEngine.php:514
StatusValue\newGood
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
SearchSuggestionSet\shrink
shrink( $limit)
Remove any extra elements in the suggestions set.
Definition: SearchSuggestionSet.php:193
SearchEngine\transformSearchTerm
transformSearchTerm( $term)
Transform search term in cases when parts of the query came as different GET params (when supported),...
Definition: SearchEngine.php:247
SearchEngine\normalizeNamespaces
normalizeNamespaces( $search)
Makes search simple string if it was namespaced.
Definition: SearchEngine.php:535
SearchSuggestionSet\rescore
rescore( $key)
Move the suggestion at index $key to the first position.
Definition: SearchSuggestionSet.php:137
SearchEngine\setShowSuggestion
setShowSuggestion( $showSuggestion)
Set whether the searcher should try to build a suggestion.
Definition: SearchEngine.php:333
SearchEngine\doSearchArchiveTitle
doSearchArchiveTitle( $term)
Perform a title search in the article archive.
Definition: SearchEngine.php:123
SearchSuggestionSet
Search suggestion sets.
Definition: SearchSuggestionSet.php:26
SearchSuggestionSet\emptySuggestionSet
static emptySuggestionSet()
Definition: SearchSuggestionSet.php:238
SearchEngine
Contain a class for special pages.
Definition: SearchEngine.php:34
SearchEngine\defaultNearMatcher
static defaultNearMatcher()
Get near matcher for default SearchEngine.
Definition: SearchEngine.php:265
Content
Base interface for content objects.
Definition: Content.php:34
SearchEngine\completionSearch
completionSearch( $search)
Perform a completion search.
Definition: SearchEngine.php:592
SearchSuggestion\getSuggestedTitle
getSuggestedTitle()
Title object in the case this suggestion is based on a title.
Definition: SearchSuggestion.php:95
SearchEngine\doSearchText
doSearchText( $term)
Perform a full text search query and return a result set.
Definition: SearchEngine.php:94
PrefixSearch\defaultSearchBackend
defaultSearchBackend( $namespaces, $search, $limit, $offset)
Unless overridden by PrefixSearchBackend hook...
Definition: PrefixSearch.php:254
SearchEngine\makeSearchFieldMapping
makeSearchFieldMapping( $name, $type)
Create a search field definition.
Definition: SearchEngine.php:835
SearchEngine\simplePrefixSearch
simplePrefixSearch( $search)
Call out to simple search backend.
Definition: SearchEngine.php:729
Title
Represents a title within MediaWiki.
Definition: Title.php:40
SearchEngine\getNearMatch
static getNearMatch( $searchterm)
If an exact title match can be found, or a very slightly close match, return the title.
Definition: SearchEngine.php:278
NullIndexField
Null index field - means search engine does not implement this field.
Definition: NullIndexField.php:6
PerRowAugmentor
Perform augmentation of each row and return composite result, indexed by ID.
Definition: PerRowAugmentor.php:7
as
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
SearchEngine\extractTitles
extractTitles(SearchSuggestionSet $completionResults)
Extract titles from completion results.
Definition: SearchEngine.php:637
SearchEngine\CHARS_ALL
const CHARS_ALL
@const int flag for legalSearchChars: includes all chars allowed in a search query
Definition: SearchEngine.php:66
MWUnknownContentModelException
Exception thrown when an unregistered content model is requested.
Definition: MWUnknownContentModelException.php:10
$t
$t
Definition: testCompression.php:69
$services
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:2220
MediaWikiServices
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
wfMessage
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
SearchEngine\$features
array $features
Feature values.
Definition: SearchEngine.php:57
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:48
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
SearchEngine\searchArchiveTitle
searchArchiveTitle( $term)
Perform a title search in the article archive.
Definition: SearchEngine.php:112
SearchEngine\create
static create( $type=null)
Load up the appropriate search engine class for the currently active database backend,...
Definition: SearchEngine.php:790
SearchEngine\setLimitOffset
setLimitOffset( $limit, $offset=0)
Set the maximum number of results to return and how many to skip before returning the first.
Definition: SearchEngine.php:302
SearchEngine\getFeatureData
getFeatureData( $feature)
Way to retrieve custom data set by setFeatureData or by the engine itself.
Definition: SearchEngine.php:221
SearchEngine\getSearchTypes
static getSearchTypes()
Return the search engines we support.
Definition: SearchEngine.php:802
SearchEngine\namespacesAsText
static namespacesAsText( $namespaces)
Get a list of namespace names useful for showing in tooltips and preferences.
Definition: SearchEngine.php:777
SearchEngine\userNamespaces
static userNamespaces( $user)
Extract default namespaces to search from the given user's settings, returning a list of index number...
Definition: SearchEngine.php:753
SearchEngine\$searchTerms
array string $searchTerms
Definition: SearchEngine.php:50
SearchEngine\processCompletionResults
processCompletionResults( $search, SearchSuggestionSet $suggestions)
Process completion search results.
Definition: SearchEngine.php:650
$type
$type
Definition: testCompression.php:48