MediaWiki  1.29.1
Go to the documentation of this file.
1 <?php
15  private $config;
21  private $language;
23  public function __construct( Config $config, Language $lang ) {
24  $this->config = $config;
25  $this->language = $lang;
26  }
32  public function getConfig() {
33  return $this->config;
34  }
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  }
48  Hooks::run( 'SearchableNamespaces', [ &$arr ] );
49  return $arr;
50  }
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  }
67  return $arr;
68  }
75  public function defaultNamespaces() {
76  return array_keys( $this->config->get( 'NamespacesToBeSearchedDefault' ), true );
77  }
85  public function getSearchTypes() {
86  $alternatives = $this->config->get( 'SearchTypeAlternatives' ) ?: [];
87  array_unshift( $alternatives, $this->config->get( 'SearchType' ) );
89  return $alternatives;
90  }
97  public function getSearchType() {
98  return $this->config->get( 'SearchType' );
99  }
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 }
Config $config
Config object from which the settings will be derived.
Definition: SearchEngineConfig.php:15
if(!isset( $args[0])) $lang
Definition: testCompression.php:33
namespace and then decline to actually register it & $namespaces
Definition: hooks.txt:934
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
Definition: hooks.txt:246
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:304
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
const NS_MAIN
Definition: Defines.php:62
Interface for configuration instances.
Definition: Config.php:28
userNamespaces( $user)
Extract default namespaces to search from the given user's settings, returning a list of index number...
Definition: SearchEngineConfig.php:59
and that you know you can do these things To protect your we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights These restrictions translate to certain responsibilities for you if you distribute copies of the or if you modify it For if you distribute copies of such a whether gratis or for a you must give the recipients all the rights that you have You must make sure that receive or can get the source code And you must show them these terms so they know their rights We protect your rights with two distribute and or modify the software for each author s protection and we want to make certain that everyone understands that there is no warranty for this free software If the software is modified by someone else and passed we want its recipients to know that what they have is not the so that any problems introduced by others will not reflect on the original authors reputations any free program is threatened constantly by software patents We wish to avoid the danger that redistributors of a free program will individually obtain patent in effect making the program proprietary To prevent we have made it clear that any patent must be licensed for everyone s free use or not licensed at all The precise terms and conditions for distribution and modification follow GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR DISTRIBUTION AND MODIFICATION This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License The refers to any such program or and a work based on the Program means either the Program or any derivative work under copyright a work containing the Program or a portion of either verbatim or with modifications and or translated into another language(Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying
Return the search engine configured in $wgSearchType, etc.
Definition: SearchEngineConfig.php:97
__construct(Config $config, Language $lang)
Definition: SearchEngineConfig.php:23
An array of namespaces indexes to be searched by default.
Definition: SearchEngineConfig.php:75
Make a list of searchable namespaces and their canonical names.
Definition: SearchEngineConfig.php:40
namespacesAsText( $namespaces)
Get a list of namespace names useful for showing in tooltips and preferences.
Definition: SearchEngineConfig.php:108
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
Return the search engines we support.
Definition: SearchEngineConfig.php:85
Language $language
Current language.
Definition: SearchEngineConfig.php:21
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:1956
Configuration handling class for SearchEngine.
Definition: SearchEngineConfig.php:9
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 "&lt
Retrieve original config.
Definition: SearchEngineConfig.php:32
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
Internationalisation code.
Definition: Language.php:35