MediaWiki  master
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 }
searchableNamespaces()
Make a list of searchable namespaces and their canonical names.
const NS_MAIN
Definition: Defines.php:64
userNamespaces( $user)
Extract default namespaces to search from the given user&#39;s settings, returning a list of index number...
getSearchType()
Return the search engine configured in $wgSearchType, etc.
if(!isset( $args[0])) $lang
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
Definition: hooks.txt:1982
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 use $formDescriptor instead 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
Interface for configuration instances.
Definition: Config.php:28
__construct(Config $config, Language $lang)
Language $language
Current language.
namespace and then decline to actually register it & $namespaces
Definition: hooks.txt:925
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:9
getSearchTypes()
Return the search engines we support.
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
Definition: injection.txt:35
namespacesAsText( $namespaces)
Get a list of namespace names useful for showing in tooltips and preferences.
Config $config
Config object from which the settings will be derived.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1473
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
getConfig()
Retrieve original config.