- Generated on Tue Sep 27 2022 22:11:32 for MediaWiki by
1.9.1
|
MediaWiki
master
|
Configuration handling class for SearchEngine. More...
Public Member Functions | |
| __construct (Config $config, Language $lang, HookContainer $hookContainer, array $mappings, UserOptionsLookup $userOptionsLookup) | |
| defaultNamespaces () | |
| An array of namespaces indexes to be searched by default. More... | |
| getConfig () | |
| Retrieve original config. More... | |
| getSearchMappings () | |
| Returns the mappings between canonical search name and underlying PHP class. More... | |
| getSearchType () | |
| Return the search engine configured in $wgSearchType, etc. More... | |
| getSearchTypes () | |
| Return the search engines we support. More... | |
| namespacesAsText ( $namespaces) | |
| Get a list of namespace names useful for showing in tooltips and preferences. More... | |
| searchableNamespaces () | |
| Make a list of searchable namespaces and their localized names. More... | |
| userNamespaces ( $user) | |
| Extract default namespaces to search from the given user's settings, returning a list of index numbers. More... | |
Configuration handling class for SearchEngine.
Provides added service over plain configuration.
Definition at line 15 of file SearchEngineConfig.php.
| SearchEngineConfig::__construct | ( | Config | $config, |
| Language | $lang, | ||
| HookContainer | $hookContainer, | ||
| array | $mappings, | ||
| UserOptionsLookup | $userOptionsLookup | ||
| ) |
| Config | $config | |
| Language | $lang | |
| HookContainer | $hookContainer | |
| array | $mappings | |
| UserOptionsLookup | $userOptionsLookup |
Definition at line 56 of file SearchEngineConfig.php.
References $lang.
| SearchEngineConfig::defaultNamespaces | ( | ) |
An array of namespaces indexes to be searched by default.
Definition at line 118 of file SearchEngineConfig.php.
| SearchEngineConfig::getConfig | ( | ) |
| 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:
Definition at line 165 of file SearchEngineConfig.php.
| SearchEngineConfig::getSearchType | ( | ) |
Return the search engine configured in $wgSearchType, etc.
Definition at line 141 of file SearchEngineConfig.php.
| SearchEngineConfig::getSearchTypes | ( | ) |
Return the search engines we support.
If only $wgSearchType is set, it'll be an array of just that one item.
Definition at line 129 of file SearchEngineConfig.php.
| SearchEngineConfig::namespacesAsText | ( | $namespaces | ) |
Get a list of namespace names useful for showing in tooltips and preferences.
| int[] | $namespaces |
Definition at line 176 of file SearchEngineConfig.php.
References wfMessage().
| SearchEngineConfig::searchableNamespaces | ( | ) |
Make a list of searchable namespaces and their localized names.
Definition at line 83 of file SearchEngineConfig.php.
References NS_MAIN.
Referenced by userNamespaces().
| SearchEngineConfig::userNamespaces | ( | $user | ) |
Extract default namespaces to search from the given user's settings, returning a list of index numbers.
| UserIdentity | $user |
Definition at line 102 of file SearchEngineConfig.php.
References searchableNamespaces().
1.9.1