Go to the documentation of this file.
114 switch ( $feature ) {
115 case 'search-update':
117 case 'title-suffix-filter':
130 $this->features[$feature] = $data;
141 if ( isset( $this->features[$feature] ) ) {
142 return $this->features[$feature];
188 $config = MediaWikiServices::getInstance()->getMainConfig();
189 return MediaWikiServices::getInstance()->newSearchEngine()->getNearMatcher( $config );
200 return static::defaultNearMatcher()->getNearMatch( $searchterm );
211 return static::defaultNearMatcher()->getNearMatchResultSet( $searchterm );
222 return "A-Za-z_'.0-9\\x80-\\xFF\\-";
233 $this->limit = intval(
$limit );
234 $this->offset = intval(
$offset );
248 return $ns < 0 || isset( $validNs[$ns] );
275 return [
'relevance' ];
288 throw new InvalidArgumentException(
"Invalid sort: $sort. " .
289 "Must be one of: " . implode(
', ', $this->
getValidSorts() ) );
314 if ( $queryAndNs ===
false ) {
318 return $queryAndNs[0];
334 if ( strpos(
$query,
':' ) ===
false ) {
337 $extractedNamespace =
null;
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 ) {
347 if ( $index !==
false ) {
348 $extractedNamespace = [ $index ];
355 if ( trim( $parsed ) ==
'' ) {
359 return [ $parsed, $extractedNamespace ];
369 return [ $contextlines, $contextchars ];
431 return $c ? $c->getTextForSearchIndex() :
'';
456 $ns = [
$title->getNamespace() ];
457 $search =
$title->getText();
460 Hooks::run(
'PrefixSearchExtractNamespace', [ &$ns, &$search ] );
468 $ns = [
$title->getNamespace() ];
471 Hooks::run(
'PrefixSearchExtractNamespace', [ &$ns, &$search ] );
475 $ns = array_map(
function ( $space ) {
493 $search = trim( $search );
497 [ $this->
namespaces, $search, $this->limit, &$results, $this->offset ]
516 if ( trim( $search ) ===
'' ) {
529 if ( trim( $search ) ===
'' ) {
535 $fallbackLimit = $this->limit - $results->getSize();
536 if ( $fallbackLimit > 0 ) {
539 $fallbackSearches =
$wgContLang->autoConvertToAllVariants( $search );
540 $fallbackSearches = array_diff( array_unique( $fallbackSearches ), [ $search ] );
542 foreach ( $fallbackSearches
as $fbs ) {
545 $results->appendAll( $fallbackSearchResult );
546 $fallbackLimit -=
count( $fallbackSearchResult );
547 if ( $fallbackLimit <= 0 ) {
574 $search = trim( $search );
580 $lb->setCaller( __METHOD__ );
587 if ( $this->offset === 0 ) {
594 $rescoredResults = $rescorer->rescore( $search, $this->
namespaces, $results, $this->limit );
599 $rescoredResults = $results;
602 if (
count( $rescoredResults ) > 0 ) {
603 $found = array_search( $rescoredResults[0], $results );
604 if ( $found ===
false ) {
608 $suggestions->
prepend( $exactMatch );
609 $suggestions->
shrink( $this->limit );
613 $suggestions->
rescore( $found );
627 if ( trim( $search ) ===
'' ) {
653 return MediaWikiServices::getInstance()->getSearchEngineConfig()->searchableNamespaces();
664 return MediaWikiServices::getInstance()->getSearchEngineConfig()->userNamespaces(
$user );
673 return MediaWikiServices::getInstance()->getSearchEngineConfig()->defaultNamespaces();
684 return MediaWikiServices::getInstance()->getSearchEngineConfig()->namespacesAsText(
$namespaces );
695 return MediaWikiServices::getInstance()->getSearchEngineFactory()->create(
$type );
705 return MediaWikiServices::getInstance()->getSearchEngineConfig()->getSearchTypes();
747 $seenHandlers =
new SplObjectStorage();
748 foreach ( $models
as $model ) {
757 if ( $seenHandlers->contains(
$handler ) ) {
762 $handlerFields =
$handler->getFieldsForSearchIndex( $this );
763 foreach ( $handlerFields
as $fieldName => $fieldData ) {
764 if ( empty( $fields[$fieldName] ) ) {
765 $fields[$fieldName] = $fieldData;
768 $mergeDef = $fields[$fieldName]->merge( $fieldData );
770 throw new InvalidArgumentException(
"Duplicate field $fieldName for model $model" );
772 $fields[$fieldName] = $mergeDef;
777 Hooks::run(
'SearchIndexFields', [ &$fields, $this ] );
798 if ( isset( $setAugmentors[
$name] ) ) {
799 throw new InvalidArgumentException(
"Both row and set augmentors are defined for $name" );
804 foreach ( $setAugmentors
as $name => $augmentor ) {
805 $data = $augmentor->augmentAll( $resultSet );
static legalSearchChars( $type=self::CHARS_ALL)
Get chars legal for search NOTE: usage as static is deprecated and preserved only as BC measure.
getSearchIndexFields()
Get fields for search index.
getProfiles( $profileType, User $user=null)
Get a list of supported profiles.
static getForModelID( $modelId)
Returns the ContentHandler singleton for the given model ID.
augmentSearchResults(SearchResultSet $resultSet)
Augment search results with extra data.
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
the value to return A Title object or null for latest all implement SearchIndexField must implement ResultSetAugmentor & $rowAugmentors
map( $callback)
Call array_map on the suggestions array.
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
setFeatureData( $feature, $data)
Way to pass custom data for engines.
getValidSorts()
Get the valid sort directions.
completionSearchWithVariants( $search)
Perform a completion search with variants.
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Performs prefix search, returning Title objects.
static searchableNamespaces()
Make a list of searchable namespaces and their canonical names.
normalizeText( $string)
When overridden in derived class, performs database-specific conversions on text to be used for searc...
getSort()
Get the sort direction of the search results.
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
searchTitle( $term)
Perform a title-only search query and return a result set.
static userHighlightPrefs()
Find snippet highlight settings for all users.
const FT_QUERY_INDEP_PROFILE_TYPE
@const string profile type for query independent ranking features
completionSearchBackend( $search)
Perform a completion search.
external whereas SearchGetNearMatch runs after $term
prepend(SearchSuggestion $suggestion)
Add a new suggestion at the top.
Allows to change the fields on the form that will be generated $name
static defaultNamespaces()
An array of namespaces indexes to be searched by default.
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
replacePrefixes( $query)
Parse some common prefixes: all (search everything) or namespace names and set the list of namespaces...
static fromTitle( $score, Title $title)
Create suggestion from Title.
defaultPrefixSearch( $search)
Simple prefix search for subpages.
const COMPLETION_PROFILE_TYPE
@const string profile type for completionSearch
textAlreadyUpdatedForIndex()
If an implementation of SearchEngine handles all of its own text processing in getTextFromContent() a...
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
setSort( $sort)
Set the sort direction of the search results.
An utility class to rescore search results by looking for an exact match in the db and add the page f...
to move a page</td >< td > &*You are moving the page across namespaces
namespace and then decline to actually register it file or subcat img or subcat $title
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
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
Implementation of near match title search.
static getContentModels()
const CHARS_NO_SYNTAX
@const int flag for legalSearchChars: includes all chars allowed in a search term
getNearMatcher(Config $config)
Get service class to finding near matches.
static getOpenSearchTemplate()
Get OpenSearch suggestion template.
searchText( $term)
Perform a full text search query and return a result set.
when a variable name is used in a it is silently declared as a new masking the global
updateTitle( $id, $title)
Update a search index record's title only.
setNamespaces( $namespaces)
Set which namespaces the search should include.
update( $id, $title, $text)
Create or update the search index record for the given page.
setAugmentedData( $name, $data)
Sets augmented data for result set.
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
static getNearMatchResultSet( $searchterm)
Do a near match (see SearchEngine::getNearMatch) and wrap it into a SearchResultSet.
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.
shrink( $limit)
Remove any extra elements in the suggestions set.
static fromStrings(array $titles)
Builds a new set of suggestion based on a string array.
transformSearchTerm( $term)
Transform search term in cases when parts of the query came as different GET params (when supported),...
static fromTitles(array $titles)
Builds a new set of suggestion based on a title array.
normalizeNamespaces( $search)
Makes search simple string if it was namespaced.
static parseNamespacePrefixes( $query)
Parse some common prefixes: all (search everything) or namespace names.
static getOpenSearchTemplate( $type)
Fetch the template for a type.
rescore( $key)
Move the suggestion at index $key to the first position.
setShowSuggestion( $showSuggestion)
Set whether the searcher should try to build a suggestion.
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
static emptySuggestionSet()
Contain a class for special pages.
Dummy class to be used when non-supported Database engine is present.
static defaultNearMatcher()
Get near matcher for default SearchEngine.
Base interface for content objects.
completionSearch( $search)
Perform a completion search.
getSuggestedTitle()
Title object in the case this suggestion is based on a title.
defaultSearchBackend( $namespaces, $search, $limit, $offset)
Unless overridden by PrefixSearchBackend hook...
makeSearchFieldMapping( $name, $type)
Create a search field definition.
simplePrefixSearch( $search)
Call out to simple search backend.
Represents a title within MediaWiki.
static getNearMatch( $searchterm)
If an exact title match can be found, or a very slightly close match, return the title.
Null index field - means search engine does not implement this field.
Perform augmentation of each row and return composite result, indexed by ID.
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
extractTitles(SearchSuggestionSet $completionResults)
Extract titles from completion results.
const CHARS_ALL
@const int flag for legalSearchChars: includes all chars allowed in a search query
Exception thrown when an unregistered content model is requested.
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 "<
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
array $features
Feature values.
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
searchArchiveTitle( $term)
Perform a title search in the article archive.
static create( $type=null)
Load up the appropriate search engine class for the currently active database backend,...
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.
static getSearchTypes()
Return the search engines we support.
the array() calling protocol came about after MediaWiki 1.4rc1.
static namespacesAsText( $namespaces)
Get a list of namespace names useful for showing in tooltips and preferences.
static userNamespaces( $user)
Extract default namespaces to search from the given user's settings, returning a list of index number...
array string $searchTerms
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
processCompletionResults( $search, SearchSuggestionSet $suggestions)
Process completion search results.