MediaWiki  REL1_31
SearchEngine.php
Go to the documentation of this file.
1 <?php
29 
34 abstract class SearchEngine {
36  public $prefix = '';
37 
39  public $namespaces = [ NS_MAIN ];
40 
42  protected $limit = 10;
43 
45  protected $offset = 0;
46 
48  protected $searchTerms = [];
49 
51  protected $showSuggestion = true;
52  private $sort = 'relevance';
53 
55  protected $features = [];
56 
58  const COMPLETION_PROFILE_TYPE = 'completionSearchProfile';
59 
61  const FT_QUERY_INDEP_PROFILE_TYPE = 'fulltextQueryIndepProfile';
62 
64  const CHARS_ALL = 1;
65 
67  const CHARS_NO_SYNTAX = 2;
68 
77  function searchText( $term ) {
78  return null;
79  }
80 
92  function searchArchiveTitle( $term ) {
93  return Status::newGood( [] );
94  }
95 
104  function searchTitle( $term ) {
105  return null;
106  }
107 
113  public function supports( $feature ) {
114  switch ( $feature ) {
115  case 'search-update':
116  return true;
117  case 'title-suffix-filter':
118  default:
119  return false;
120  }
121  }
122 
129  public function setFeatureData( $feature, $data ) {
130  $this->features[$feature] = $data;
131  }
132 
140  public function getFeatureData( $feature ) {
141  if ( isset( $this->features[$feature] ) ) {
142  return $this->features[$feature];
143  }
144  return null;
145  }
146 
155  public function normalizeText( $string ) {
157 
158  // Some languages such as Chinese require word segmentation
159  return $wgContLang->segmentByWord( $string );
160  }
161 
169  public function transformSearchTerm( $term ) {
170  return $term;
171  }
172 
178  public function getNearMatcher( Config $config ) {
180  return new SearchNearMatcher( $config, $wgContLang );
181  }
182 
187  protected static function defaultNearMatcher() {
188  $config = MediaWikiServices::getInstance()->getMainConfig();
189  return MediaWikiServices::getInstance()->newSearchEngine()->getNearMatcher( $config );
190  }
191 
199  public static function getNearMatch( $searchterm ) {
200  return static::defaultNearMatcher()->getNearMatch( $searchterm );
201  }
202 
210  public static function getNearMatchResultSet( $searchterm ) {
211  return static::defaultNearMatcher()->getNearMatchResultSet( $searchterm );
212  }
213 
221  public static function legalSearchChars( $type = self::CHARS_ALL ) {
222  return "A-Za-z_'.0-9\\x80-\\xFF\\-";
223  }
224 
232  function setLimitOffset( $limit, $offset = 0 ) {
233  $this->limit = intval( $limit );
234  $this->offset = intval( $offset );
235  }
236 
244  if ( $namespaces ) {
245  // Filter namespaces to only keep valid ones
246  $validNs = $this->searchableNamespaces();
247  $namespaces = array_filter( $namespaces, function ( $ns ) use( $validNs ) {
248  return $ns < 0 || isset( $validNs[$ns] );
249  } );
250  } else {
251  $namespaces = [];
252  }
253  $this->namespaces = $namespaces;
254  }
255 
264  $this->showSuggestion = $showSuggestion;
265  }
266 
274  public function getValidSorts() {
275  return [ 'relevance' ];
276  }
277 
286  public function setSort( $sort ) {
287  if ( !in_array( $sort, $this->getValidSorts() ) ) {
288  throw new InvalidArgumentException( "Invalid sort: $sort. " .
289  "Must be one of: " . implode( ', ', $this->getValidSorts() ) );
290  }
291  $this->sort = $sort;
292  }
293 
300  public function getSort() {
301  return $this->sort;
302  }
303 
312  function replacePrefixes( $query ) {
313  $queryAndNs = self::parseNamespacePrefixes( $query );
314  if ( $queryAndNs === false ) {
315  return $query;
316  }
317  $this->namespaces = $queryAndNs[1];
318  return $queryAndNs[0];
319  }
320 
330  public static function parseNamespacePrefixes( $query ) {
332 
333  $parsed = $query;
334  if ( strpos( $query, ':' ) === false ) { // nothing to do
335  return false;
336  }
337  $extractedNamespace = null;
338 
339  $allkeyword = wfMessage( 'searchall' )->inContentLanguage()->text() . ":";
340  if ( strncmp( $query, $allkeyword, strlen( $allkeyword ) ) == 0 ) {
341  $extractedNamespace = null;
342  $parsed = substr( $query, strlen( $allkeyword ) );
343  } elseif ( strpos( $query, ':' ) !== false ) {
344  // TODO: should we unify with PrefixSearch::extractNamespace ?
345  $prefix = str_replace( ' ', '_', substr( $query, 0, strpos( $query, ':' ) ) );
346  $index = $wgContLang->getNsIndex( $prefix );
347  if ( $index !== false ) {
348  $extractedNamespace = [ $index ];
349  $parsed = substr( $query, strlen( $prefix ) + 1 );
350  } else {
351  return false;
352  }
353  }
354 
355  if ( trim( $parsed ) == '' ) {
356  $parsed = $query; // prefix was the whole query
357  }
358 
359  return [ $parsed, $extractedNamespace ];
360  }
361 
366  public static function userHighlightPrefs() {
367  $contextlines = 2; // Hardcode this. Old defaults sucked. :)
368  $contextchars = 75; // same as above.... :P
369  return [ $contextlines, $contextchars ];
370  }
371 
381  function update( $id, $title, $text ) {
382  // no-op
383  }
384 
393  function updateTitle( $id, $title ) {
394  // no-op
395  }
396 
405  function delete( $id, $title ) {
406  // no-op
407  }
408 
419  public function getTextFromContent( Title $t, Content $c = null ) {
420  return $c ? $c->getTextForSearchIndex() : '';
421  }
422 
430  public function textAlreadyUpdatedForIndex() {
431  return false;
432  }
433 
440  protected function normalizeNamespaces( $search ) {
441  // Find a Title which is not an interwiki and is in NS_MAIN
442  $title = Title::newFromText( $search );
443  $ns = $this->namespaces;
444  if ( $title && !$title->isExternal() ) {
445  $ns = [ $title->getNamespace() ];
446  if ( $title->getNamespace() !== NS_MAIN ) {
447  $search = substr( $search, strpos( $search, ':' ) + 1 );
448  }
449  if ( $ns[0] == NS_MAIN ) {
450  $ns = $this->namespaces; // no explicit prefix, use default namespaces
451  Hooks::run( 'PrefixSearchExtractNamespace', [ &$ns, &$search ] );
452  }
453  } else {
454  $title = Title::newFromText( $search . 'Dummy' );
455  if ( $title && $title->getText() == 'Dummy'
456  && $title->getNamespace() != NS_MAIN
457  && !$title->isExternal()
458  ) {
459  $ns = [ $title->getNamespace() ];
460  $search = '';
461  } else {
462  Hooks::run( 'PrefixSearchExtractNamespace', [ &$ns, &$search ] );
463  }
464  }
465 
466  $ns = array_map( function ( $space ) {
467  return $space == NS_MEDIA ? NS_FILE : $space;
468  }, $ns );
469 
470  $this->setNamespaces( $ns );
471  return $search;
472  }
473 
481  protected function completionSearchBackend( $search ) {
482  $results = [];
483 
484  $search = trim( $search );
485 
486  if ( !in_array( NS_SPECIAL, $this->namespaces ) && // We do not run hook on Special: search
487  !Hooks::run( 'PrefixSearchBackend',
488  [ $this->namespaces, $search, $this->limit, &$results, $this->offset ]
489  ) ) {
490  // False means hook worked.
491  // FIXME: Yes, the API is weird. That's why it is going to be deprecated.
492 
493  return SearchSuggestionSet::fromStrings( $results );
494  } else {
495  // Hook did not do the job, use default simple search
496  $results = $this->simplePrefixSearch( $search );
497  return SearchSuggestionSet::fromTitles( $results );
498  }
499  }
500 
506  public function completionSearch( $search ) {
507  if ( trim( $search ) === '' ) {
508  return SearchSuggestionSet::emptySuggestionSet(); // Return empty result
509  }
510  $search = $this->normalizeNamespaces( $search );
511  return $this->processCompletionResults( $search, $this->completionSearchBackend( $search ) );
512  }
513 
519  public function completionSearchWithVariants( $search ) {
520  if ( trim( $search ) === '' ) {
521  return SearchSuggestionSet::emptySuggestionSet(); // Return empty result
522  }
523  $search = $this->normalizeNamespaces( $search );
524 
525  $results = $this->completionSearchBackend( $search );
526  $fallbackLimit = $this->limit - $results->getSize();
527  if ( $fallbackLimit > 0 ) {
529 
530  $fallbackSearches = $wgContLang->autoConvertToAllVariants( $search );
531  $fallbackSearches = array_diff( array_unique( $fallbackSearches ), [ $search ] );
532 
533  foreach ( $fallbackSearches as $fbs ) {
534  $this->setLimitOffset( $fallbackLimit );
535  $fallbackSearchResult = $this->completionSearch( $fbs );
536  $results->appendAll( $fallbackSearchResult );
537  $fallbackLimit -= $fallbackSearchResult->getSize();
538  if ( $fallbackLimit <= 0 ) {
539  break;
540  }
541  }
542  }
543  return $this->processCompletionResults( $search, $results );
544  }
545 
551  public function extractTitles( SearchSuggestionSet $completionResults ) {
552  return $completionResults->map( function ( SearchSuggestion $sugg ) {
553  return $sugg->getSuggestedTitle();
554  } );
555  }
556 
564  protected function processCompletionResults( $search, SearchSuggestionSet $suggestions ) {
565  $search = trim( $search );
566  // preload the titles with LinkBatch
567  $titles = $suggestions->map( function ( SearchSuggestion $sugg ) {
568  return $sugg->getSuggestedTitle();
569  } );
570  $lb = new LinkBatch( $titles );
571  $lb->setCaller( __METHOD__ );
572  $lb->execute();
573 
574  $results = $suggestions->map( function ( SearchSuggestion $sugg ) {
575  return $sugg->getSuggestedTitle()->getPrefixedText();
576  } );
577 
578  if ( $this->offset === 0 ) {
579  // Rescore results with an exact title match
580  // NOTE: in some cases like cross-namespace redirects
581  // (frequently used as shortcuts e.g. WP:WP on huwiki) some
582  // backends like Cirrus will return no results. We should still
583  // try an exact title match to workaround this limitation
584  $rescorer = new SearchExactMatchRescorer();
585  $rescoredResults = $rescorer->rescore( $search, $this->namespaces, $results, $this->limit );
586  } else {
587  // No need to rescore if offset is not 0
588  // The exact match must have been returned at position 0
589  // if it existed.
590  $rescoredResults = $results;
591  }
592 
593  if ( count( $rescoredResults ) > 0 ) {
594  $found = array_search( $rescoredResults[0], $results );
595  if ( $found === false ) {
596  // If the first result is not in the previous array it
597  // means that we found a new exact match
598  $exactMatch = SearchSuggestion::fromTitle( 0, Title::newFromText( $rescoredResults[0] ) );
599  $suggestions->prepend( $exactMatch );
600  $suggestions->shrink( $this->limit );
601  } else {
602  // if the first result is not the same we need to rescore
603  if ( $found > 0 ) {
604  $suggestions->rescore( $found );
605  }
606  }
607  }
608 
609  return $suggestions;
610  }
611 
617  public function defaultPrefixSearch( $search ) {
618  if ( trim( $search ) === '' ) {
619  return [];
620  }
621 
622  $search = $this->normalizeNamespaces( $search );
623  return $this->simplePrefixSearch( $search );
624  }
625 
632  protected function simplePrefixSearch( $search ) {
633  // Use default database prefix search
634  $backend = new TitlePrefixSearch;
635  return $backend->defaultSearchBackend( $this->namespaces, $search, $this->limit, $this->offset );
636  }
637 
643  public static function searchableNamespaces() {
644  return MediaWikiServices::getInstance()->getSearchEngineConfig()->searchableNamespaces();
645  }
646 
654  public static function userNamespaces( $user ) {
655  return MediaWikiServices::getInstance()->getSearchEngineConfig()->userNamespaces( $user );
656  }
657 
663  public static function defaultNamespaces() {
664  return MediaWikiServices::getInstance()->getSearchEngineConfig()->defaultNamespaces();
665  }
666 
674  public static function namespacesAsText( $namespaces ) {
675  return MediaWikiServices::getInstance()->getSearchEngineConfig()->namespacesAsText( $namespaces );
676  }
677 
685  public static function create( $type = null ) {
686  return MediaWikiServices::getInstance()->getSearchEngineFactory()->create( $type );
687  }
688 
695  public static function getSearchTypes() {
696  return MediaWikiServices::getInstance()->getSearchEngineConfig()->getSearchTypes();
697  }
698 
714  public function getProfiles( $profileType, User $user = null ) {
715  return null;
716  }
717 
726  public function makeSearchFieldMapping( $name, $type ) {
727  return new NullIndexField();
728  }
729 
735  public function getSearchIndexFields() {
737  $fields = [];
738  $seenHandlers = new SplObjectStorage();
739  foreach ( $models as $model ) {
740  try {
742  }
744  // If we can find no handler, ignore it
745  continue;
746  }
747  // Several models can have the same handler, so avoid processing it repeatedly
748  if ( $seenHandlers->contains( $handler ) ) {
749  // We already did this one
750  continue;
751  }
752  $seenHandlers->attach( $handler );
753  $handlerFields = $handler->getFieldsForSearchIndex( $this );
754  foreach ( $handlerFields as $fieldName => $fieldData ) {
755  if ( empty( $fields[$fieldName] ) ) {
756  $fields[$fieldName] = $fieldData;
757  } else {
758  // TODO: do we allow some clashes with the same type or reject all of them?
759  $mergeDef = $fields[$fieldName]->merge( $fieldData );
760  if ( !$mergeDef ) {
761  throw new InvalidArgumentException( "Duplicate field $fieldName for model $model" );
762  }
763  $fields[$fieldName] = $mergeDef;
764  }
765  }
766  }
767  // Hook to allow extensions to produce search mapping fields
768  Hooks::run( 'SearchIndexFields', [ &$fields, $this ] );
769  return $fields;
770  }
771 
777  public function augmentSearchResults( SearchResultSet $resultSet ) {
778  $setAugmentors = [];
779  $rowAugmentors = [];
780  Hooks::run( "SearchResultsAugment", [ &$setAugmentors, &$rowAugmentors ] );
781 
782  if ( !$setAugmentors && !$rowAugmentors ) {
783  // We're done here
784  return;
785  }
786 
787  // Convert row augmentors to set augmentor
788  foreach ( $rowAugmentors as $name => $row ) {
789  if ( isset( $setAugmentors[$name] ) ) {
790  throw new InvalidArgumentException( "Both row and set augmentors are defined for $name" );
791  }
792  $setAugmentors[$name] = new PerRowAugmentor( $row );
793  }
794 
795  foreach ( $setAugmentors as $name => $augmentor ) {
796  $data = $augmentor->augmentAll( $resultSet );
797  if ( $data ) {
798  $resultSet->setAugmentedData( $name, $data );
799  }
800  }
801  }
802 }
803 
811  // no-op
812 }
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:221
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:247
SearchEngine\$showSuggestion
bool $showSuggestion
Definition: SearchEngine.php:51
SearchEngine\getSearchIndexFields
getSearchIndexFields()
Get fields for search index.
Definition: SearchEngine.php:735
SearchEngine\getProfiles
getProfiles( $profileType, User $user=null)
Get a list of supported profiles.
Definition: SearchEngine.php:714
ContentHandler\getForModelID
static getForModelID( $modelId)
Returns the ContentHandler singleton for the given model ID.
Definition: ContentHandler.php:293
SearchEngine\augmentSearchResults
augmentSearchResults(SearchResultSet $resultSet)
Augment search results with extra data.
Definition: SearchEngine.php:777
$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 probably a stub 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:903
SearchSuggestionSet\map
map( $callback)
Call array_map on the suggestions array.
Definition: SearchSuggestionSet.php:72
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:273
SearchEngine\supports
supports( $feature)
Definition: SearchEngine.php:113
SearchEngine\setFeatureData
setFeatureData( $feature, $data)
Way to pass custom data for engines.
Definition: SearchEngine.php:129
SearchEngine\$limit
int $limit
Definition: SearchEngine.php:42
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
SearchEngine\getValidSorts
getValidSorts()
Get the valid sort directions.
Definition: SearchEngine.php:274
SearchEngine\$sort
$sort
Definition: SearchEngine.php:52
SearchEngine\completionSearchWithVariants
completionSearchWithVariants( $search)
Perform a completion search with variants.
Definition: SearchEngine.php:519
LinkBatch
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition: LinkBatch.php:34
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 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
array
the array() calling protocol came about after MediaWiki 1.4rc1.
TitlePrefixSearch
Performs prefix search, returning Title objects.
Definition: PrefixSearch.php:375
SearchEngine\searchableNamespaces
static searchableNamespaces()
Make a list of searchable namespaces and their canonical names.
Definition: SearchEngine.php:643
SearchEngine\normalizeText
normalizeText( $string)
When overridden in derived class, performs database-specific conversions on text to be used for searc...
Definition: SearchEngine.php:155
SearchEngine\getSort
getSort()
Get the sort direction of the search results.
Definition: SearchEngine.php:300
$rowAugmentors
the value to return A Title object or null for latest all implement SearchIndexField must implement ResultSetAugmentor & $rowAugmentors
Definition: hooks.txt:2882
SearchEngine\$namespaces
int[] null $namespaces
Definition: SearchEngine.php:39
SearchEngine\searchTitle
searchTitle( $term)
Perform a title-only search query and return a result set.
Definition: SearchEngine.php:104
SearchEngine\userHighlightPrefs
static userHighlightPrefs()
Find snippet highlight settings for all users.
Definition: SearchEngine.php:366
NS_FILE
const NS_FILE
Definition: Defines.php:80
SearchEngine\FT_QUERY_INDEP_PROFILE_TYPE
const FT_QUERY_INDEP_PROFILE_TYPE
@const string profile type for query independent ranking features
Definition: SearchEngine.php:61
SearchEngine\completionSearchBackend
completionSearchBackend( $search)
Perform a completion search.
Definition: SearchEngine.php:481
SearchSuggestionSet\prepend
prepend(SearchSuggestion $suggestion)
Add a new suggestion at the top.
Definition: SearchSuggestionSet.php:122
SearchEngine\defaultNamespaces
static defaultNamespaces()
An array of namespaces indexes to be searched by default.
Definition: SearchEngine.php:663
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:37
SearchEngine\replacePrefixes
replacePrefixes( $query)
Parse some common prefixes: all (search everything) or namespace names and set the list of namespaces...
Definition: SearchEngine.php:312
SearchSuggestion\fromTitle
static fromTitle( $score, Title $title)
Create suggestion from Title.
Definition: SearchSuggestion.php:166
SearchEngine\defaultPrefixSearch
defaultPrefixSearch( $search)
Simple prefix search for subpages.
Definition: SearchEngine.php:617
SearchEngine\COMPLETION_PROFILE_TYPE
const COMPLETION_PROFILE_TYPE
@const string profile type for completionSearch
Definition: SearchEngine.php:58
NS_MAIN
const NS_MAIN
Definition: Defines.php:74
SearchEngine\textAlreadyUpdatedForIndex
textAlreadyUpdatedForIndex()
If an implementation of SearchEngine handles all of its own text processing in getTextFromContent() a...
Definition: SearchEngine.php:430
Config
Interface for configuration instances.
Definition: Config.php:28
NS_SPECIAL
const NS_SPECIAL
Definition: Defines.php:63
SearchEngine\setSort
setSort( $sort)
Set the sort direction of the search results.
Definition: SearchEngine.php:286
$term
For QUnit the mediawiki tests qunit testrunner dependency will be added to any module whereas SearchGetNearMatch runs after $term
Definition: hooks.txt:2845
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
$titles
linkcache txt The LinkCache class maintains a list of article titles and the information about whether or not the article exists in the database This is used to mark up links when displaying a page If the same link appears more than once on any page then it only has to be looked up once In most cases link lookups are done in batches with the LinkBatch class or the equivalent in so the link cache is mostly useful for short snippets of parsed and for links in the navigation areas of the skin The link cache was formerly used to track links used in a document for the purposes of updating the link tables This application is now deprecated To create a you can use the following $titles
Definition: linkcache.txt:17
SearchNearMatcher
Implementation of near match title search.
Definition: SearchNearMatcher.php:7
SearchEngine\$offset
int $offset
Definition: SearchEngine.php:45
ContentHandler\getContentModels
static getContentModels()
Definition: ContentHandler.php:368
SearchEngine\CHARS_NO_SYNTAX
const CHARS_NO_SYNTAX
@const int flag for legalSearchChars: includes all chars allowed in a search term
Definition: SearchEngine.php:67
SearchEngine\getNearMatcher
getNearMatcher(Config $config)
Get service class to finding near matches.
Definition: SearchEngine.php:178
SearchEngine\searchText
searchText( $term)
Perform a full text search query and return a result set.
Definition: SearchEngine.php:77
SearchSuggestion
Search suggestion.
Definition: SearchSuggestion.php:25
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
SearchResultSet
Definition: SearchResultSet.php:27
SearchEngine\$prefix
string $prefix
Definition: SearchEngine.php:36
SearchEngine\updateTitle
updateTitle( $id, $title)
Update a search index record's title only.
Definition: SearchEngine.php:393
SearchEngine\setNamespaces
setNamespaces( $namespaces)
Set which namespaces the search should include.
Definition: SearchEngine.php:243
SearchEngine\update
update( $id, $title, $text)
Create or update the search index record for the given page.
Definition: SearchEngine.php:381
SearchResultSet\setAugmentedData
setAugmentedData( $name, $data)
Sets augmented data for result set.
Definition: SearchResultSet.php:250
SearchEngine\getNearMatchResultSet
static getNearMatchResultSet( $searchterm)
Do a near match (see SearchEngine::getNearMatch) and wrap it into a SearchResultSet.
Definition: SearchEngine.php:210
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:419
NS_MEDIA
const NS_MEDIA
Definition: Defines.php:62
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:167
SearchSuggestionSet\fromStrings
static fromStrings(array $titles)
Builds a new set of suggestion based on a string array.
Definition: SearchSuggestionSet.php:198
SearchEngine\transformSearchTerm
transformSearchTerm( $term)
Transform search term in cases when parts of the query came as different GET params (when supported),...
Definition: SearchEngine.php:169
SearchSuggestionSet\fromTitles
static fromTitles(array $titles)
Builds a new set of suggestion based on a title array.
Definition: SearchSuggestionSet.php:182
SearchEngine\normalizeNamespaces
normalizeNamespaces( $search)
Makes search simple string if it was namespaced.
Definition: SearchEngine.php:440
SearchEngine\parseNamespacePrefixes
static parseNamespacePrefixes( $query)
Parse some common prefixes: all (search everything) or namespace names.
Definition: SearchEngine.php:330
SearchSuggestionSet\rescore
rescore( $key)
Move the suggestion at index $key to the first position.
Definition: SearchSuggestionSet.php:111
SearchEngine\setShowSuggestion
setShowSuggestion( $showSuggestion)
Set whether the searcher should try to build a suggestion.
Definition: SearchEngine.php:263
SearchSuggestionSet
Search suggestion sets.
Definition: SearchSuggestionSet.php:26
SearchSuggestionSet\emptySuggestionSet
static emptySuggestionSet()
Definition: SearchSuggestionSet.php:209
SearchEngine
Contain a class for special pages.
Definition: SearchEngine.php:34
SearchEngineDummy
Dummy class to be used when non-supported Database engine is present.
Definition: SearchEngine.php:810
SearchEngine\defaultNearMatcher
static defaultNearMatcher()
Get near matcher for default SearchEngine.
Definition: SearchEngine.php:187
Content
Base interface for content objects.
Definition: Content.php:34
SearchEngine\completionSearch
completionSearch( $search)
Perform a completion search.
Definition: SearchEngine.php:506
SearchSuggestion\getSuggestedTitle
getSuggestedTitle()
Title object in the case this suggestion is based on a title.
Definition: SearchSuggestion.php:95
PrefixSearch\defaultSearchBackend
defaultSearchBackend( $namespaces, $search, $limit, $offset)
Unless overridden by PrefixSearchBackend hook...
Definition: PrefixSearch.php:293
SearchEngine\makeSearchFieldMapping
makeSearchFieldMapping( $name, $type)
Create a search field definition.
Definition: SearchEngine.php:726
SearchEngine\simplePrefixSearch
simplePrefixSearch( $search)
Call out to simple search backend.
Definition: SearchEngine.php:632
Title
Represents a title within MediaWiki.
Definition: Title.php:39
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
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:199
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:22
SearchEngine\extractTitles
extractTitles(SearchSuggestionSet $completionResults)
Extract titles from completion results.
Definition: SearchEngine.php:551
SearchEngine\CHARS_ALL
const CHARS_ALL
@const int flag for legalSearchChars: includes all chars allowed in a search query
Definition: SearchEngine.php:64
MWUnknownContentModelException
Exception thrown when an unregistered content model is requested.
Definition: MWUnknownContentModelException.php:10
$t
$t
Definition: testCompression.php:69
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:25
$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:1620
SearchEngine\$features
array $features
Feature values.
Definition: SearchEngine.php:55
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:53
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
SearchEngine\searchArchiveTitle
searchArchiveTitle( $term)
Perform a title search in the article archive.
Definition: SearchEngine.php:92
SearchEngine\create
static create( $type=null)
Load up the appropriate search engine class for the currently active database backend,...
Definition: SearchEngine.php:685
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:232
SearchEngine\getFeatureData
getFeatureData( $feature)
Way to retrieve custom data set by setFeatureData or by the engine itself.
Definition: SearchEngine.php:140
SearchEngine\getSearchTypes
static getSearchTypes()
Return the search engines we support.
Definition: SearchEngine.php:695
SearchEngine\namespacesAsText
static namespacesAsText( $namespaces)
Get a list of namespace names useful for showing in tooltips and preferences.
Definition: SearchEngine.php:674
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2171
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:654
SearchEngine\$searchTerms
array string $searchTerms
Definition: SearchEngine.php:48
$wgContLang
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the content language as $wgContLang
Definition: design.txt:57
SearchEngine\processCompletionResults
processCompletionResults( $search, SearchSuggestionSet $suggestions)
Process completion search results.
Definition: SearchEngine.php:564
$type
$type
Definition: testCompression.php:48