MediaWiki  1.34.0
SearchEngineConfig.php
Go to the documentation of this file.
1 <?php
2 
10 
15  private $config;
16 
21  private $language;
22 
23  public function __construct( Config $config, Language $lang ) {
24  $this->config = $config;
25  $this->language = $lang;
26  }
27 
32  public function getConfig() {
33  return $this->config;
34  }
35 
40  public function searchableNamespaces() {
41  $arr = [];
42  foreach ( $this->language->getNamespaces() as $ns => $name ) {
43  if ( $ns >= NS_MAIN ) {
44  $arr[$ns] = $name;
45  }
46  }
47 
48  Hooks::run( 'SearchableNamespaces', [ &$arr ] );
49  return $arr;
50  }
51 
59  public function userNamespaces( $user ) {
60  $arr = [];
61  foreach ( $this->searchableNamespaces() as $ns => $name ) {
62  if ( $user->getOption( 'searchNs' . $ns ) ) {
63  $arr[] = $ns;
64  }
65  }
66 
67  return $arr;
68  }
69 
75  public function defaultNamespaces() {
76  return array_keys( $this->config->get( 'NamespacesToBeSearchedDefault' ), true );
77  }
78 
85  public function getSearchTypes() {
86  $alternatives = $this->config->get( 'SearchTypeAlternatives' ) ?: [];
87  array_unshift( $alternatives, $this->config->get( 'SearchType' ) );
88 
89  return $alternatives;
90  }
91 
97  public function getSearchType() {
98  return $this->config->get( 'SearchType' );
99  }
100 
108  public function namespacesAsText( $namespaces ) {
109  $formatted = array_map( [ $this->language, 'getFormattedNsText' ], $namespaces );
110  foreach ( $formatted as $key => $ns ) {
111  if ( empty( $ns ) ) {
112  $formatted[$key] = wfMessage( 'blanknamespace' )->text();
113  }
114  }
115  return $formatted;
116  }
117 }
SearchEngineConfig\$config
Config $config
Config object from which the settings will be derived.
Definition: SearchEngineConfig.php:15
$lang
if(!isset( $args[0])) $lang
Definition: testCompression.php:33
true
return true
Definition: router.php:92
wfMessage
wfMessage( $key,... $params)
This is the function for getting translated interface messages.
Definition: GlobalFunctions.php:1264
NS_MAIN
const NS_MAIN
Definition: Defines.php:60
Config
Interface for configuration instances.
Definition: Config.php:28
SearchEngineConfig\userNamespaces
userNamespaces( $user)
Extract default namespaces to search from the given user's settings, returning a list of index number...
Definition: SearchEngineConfig.php:59
SearchEngineConfig\getSearchType
getSearchType()
Return the search engine configured in $wgSearchType, etc.
Definition: SearchEngineConfig.php:97
SearchEngineConfig\__construct
__construct(Config $config, Language $lang)
Definition: SearchEngineConfig.php:23
SearchEngineConfig\defaultNamespaces
defaultNamespaces()
An array of namespaces indexes to be searched by default.
Definition: SearchEngineConfig.php:75
SearchEngineConfig\searchableNamespaces
searchableNamespaces()
Make a list of searchable namespaces and their canonical names.
Definition: SearchEngineConfig.php:40
SearchEngineConfig\namespacesAsText
namespacesAsText( $namespaces)
Get a list of namespace names useful for showing in tooltips and preferences.
Definition: SearchEngineConfig.php:108
SearchEngineConfig\getSearchTypes
getSearchTypes()
Return the search engines we support.
Definition: SearchEngineConfig.php:85
SearchEngineConfig\$language
Language $language
Current language.
Definition: SearchEngineConfig.php:21
SearchEngineConfig
Configuration handling class for SearchEngine.
Definition: SearchEngineConfig.php:9
SearchEngineConfig\getConfig
getConfig()
Retrieve original config.
Definition: SearchEngineConfig.php:32
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
Language
Internationalisation code.
Definition: Language.php:37