Configuration handling class for SearchEngine. More...

Public Member Functions
	__construct (ServiceOptions $options, Language $language, HookContainer $hookContainer, array $engineMappings, UserOptionsLookup $userOptionsLookup)

	defaultNamespaces ()
	An array of namespaces indexes to be searched by default.

	getConfig ()
	Retrieve original config.

	getSearchMappings ()
	Returns the mappings between canonical search name and underlying PHP class.

	getSearchType ()
	Return the search engine configured in $wgSearchType, etc.

	getSearchTypes ()
	Return the search engines we support.

	namespacesAsText ( $namespaces)
	Get a list of namespace names useful for showing in tooltips and preferences.

	searchableNamespaces ()
	List searchable namespaces and their localized names (with underscores, without considering language variants).

	userNamespaces ( $user)
	Extract default namespaces to search from the given user's settings, returning a list of index numbers.

Public Attributes
const	CONSTRUCTOR_OPTIONS

Detailed Description

Configuration handling class for SearchEngine.

Provides added service over plain configuration.

Since: 1.27

Definition at line 18 of file SearchEngineConfig.php.

Constructor & Destructor Documentation

◆ __construct()

SearchEngineConfig::__construct	(	ServiceOptions	$options,
		Language	$language,
		HookContainer	$hookContainer,
		array	$engineMappings,
		UserOptionsLookup	$userOptionsLookup )

Definition at line 48 of file SearchEngineConfig.php.

References MediaWiki\Config\ServiceOptions\assertRequiredOptions().

Member Function Documentation

◆ defaultNamespaces()

SearchEngineConfig::defaultNamespaces ( )

An array of namespaces indexes to be searched by default.

Returns: int[] Namespace IDs

Definition at line 117 of file SearchEngineConfig.php.

◆ getConfig()

SearchEngineConfig::getConfig ( )

Retrieve original config.

Deprecated: since 1.43, use ServiceOptions instead with DI.

Returns: Config

Definition at line 68 of file SearchEngineConfig.php.

References wfDeprecated().

◆ getSearchMappings()

SearchEngineConfig::getSearchMappings ( )

Returns the mappings between canonical search name and underlying PHP class.

Key is the canonical name (used in $wgSearchType and $wgSearchTypeAlternatives). Value is a specification for ObjectFactory.

For example to be able to use 'foobarsearch' in $wgSearchType and $wgSearchTypeAlternatives but the PHP class for 'foobarsearch' is 'MediaWiki\Extension\FoobarSearch\FoobarSearch' set:

extension.json Example:: "SearchMappings": {

"foobarsearch": { "class": "MediaWiki\\\\Extension\\\\FoobarSearch\\\\FoobarSearch" }

}

Since: 1.35

Returns: array

Definition at line 164 of file SearchEngineConfig.php.

◆ getSearchType()

SearchEngineConfig::getSearchType ( )

Return the search engine configured in $wgSearchType, etc.

Returns: string|null

Definition at line 140 of file SearchEngineConfig.php.

◆ getSearchTypes()

SearchEngineConfig::getSearchTypes ( )

Return the search engines we support.

If only $wgSearchType is set, it'll be an array of just that one item.

Returns: array

Definition at line 128 of file SearchEngineConfig.php.

◆ namespacesAsText()

SearchEngineConfig::namespacesAsText ( $namespaces )

Get a list of namespace names useful for showing in tooltips and preferences.

Parameters

int[] $namespaces

Returns: string[] List of names

Definition at line 175 of file SearchEngineConfig.php.

References wfMessage().

◆ searchableNamespaces()

SearchEngineConfig::searchableNamespaces ( )

List searchable namespaces and their localized names (with underscores, without considering language variants).

NOTE: This is not suitable for UI text, as language variants of namespace names defined via system messages are ignored. Use {

See also: LanguageConverter::convertNamespace} instead.

Returns: array<int,string> Numeric namespace id => localized name (without language variants)

Definition at line 82 of file SearchEngineConfig.php.

References NS_MAIN.

Referenced by userNamespaces().

◆ userNamespaces()

SearchEngineConfig::userNamespaces ( $user )

Extract default namespaces to search from the given user's settings, returning a list of index numbers.

Parameters

UserIdentity $user

Returns: int[]

Definition at line 101 of file SearchEngineConfig.php.

References searchableNamespaces().

Member Data Documentation

◆ CONSTRUCTOR_OPTIONS

const SearchEngineConfig::CONSTRUCTOR_OPTIONS

Initial value:

= [
        MainConfigNames::NamespacesToBeSearchedDefault,
        MainConfigNames::SearchTypeAlternatives,
        MainConfigNames::SearchType,
    ]

Access: internal: For use by ServiceWiring.php ONLY

Definition at line 21 of file SearchEngineConfig.php.

The documentation for this class was generated from the following file:

includes/Search/SearchEngineConfig.php

Public Member Functions

Public Attributes