MediaWiki  1.27.2
ServiceWiring.php
Go to the documentation of this file.
1 <?php
41 
42 return [
43  'SiteStore' => function( MediaWikiServices $services ) {
44  $loadBalancer = wfGetLB(); // TODO: use LB from MediaWikiServices
45  $rawSiteStore = new DBSiteStore( $loadBalancer );
46 
47  // TODO: replace wfGetCache with a CacheFactory service.
48  // TODO: replace wfIsHHVM with a capabilities service.
50 
51  return new CachingSiteStore( $rawSiteStore, $cache );
52  },
53 
54  'SiteLookup' => function( MediaWikiServices $services ) {
55  // Use the default SiteStore as the SiteLookup implementation for now
56  return $services->getSiteStore();
57  },
58 
59  'ConfigFactory' => function( MediaWikiServices $services ) {
60  // Use the bootstrap config to initialize the ConfigFactory.
61  $registry = $services->getBootstrapConfig()->get( 'ConfigRegistry' );
62  $factory = new ConfigFactory();
63 
64  foreach ( $registry as $name => $callback ) {
65  $factory->register( $name, $callback );
66  }
67  return $factory;
68  },
69 
70  'MainConfig' => function( MediaWikiServices $services ) {
71  // Use the 'main' config from the ConfigFactory service.
72  return $services->getConfigFactory()->makeConfig( 'main' );
73  },
74 
75  'StatsdDataFactory' => function( MediaWikiServices $services ) {
76  return new BufferingStatsdDataFactory(
77  rtrim( $services->getMainConfig()->get( 'StatsdMetricPrefix' ), '.' )
78  );
79  },
80 
81  'EventRelayerGroup' => function( MediaWikiServices $services ) {
82  return new EventRelayerGroup( $services->getMainConfig()->get( 'EventRelayerConfig' ) );
83  },
84 
85  'SearchEngineFactory' => function( MediaWikiServices $services ) {
86  return new SearchEngineFactory( $services->getSearchEngineConfig() );
87  },
88 
89  'SearchEngineConfig' => function( MediaWikiServices $services ) {
91  return new SearchEngineConfig( $services->getMainConfig(), $wgContLang );
92  },
93 
94  'SkinFactory' => function( MediaWikiServices $services ) {
95  return new SkinFactory();
96  },
97 
99  // NOTE: When adding a service here, don't forget to add a getter function
100  // in the MediaWikiServices class. The convenience getter should just call
101  // $this->getService( 'FooBarService' ).
103 
104 ];
A factory for application metric data.
wfIsHHVM()
Check if we are running under HHVM.
const CACHE_ACCEL
Definition: Defines.php:105
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
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 MediaWikiServices
Definition: injection.txt:23
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
$factory
wfGetLB($wiki=false)
Get a load balancer object.
wfGetCache($cacheType)
Get a specific cache object.
$cache
Definition: mcc.php:33
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
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 CACHE_ANYTHING
Definition: Defines.php:101
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition: design.txt:56
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place or wrap existing services the preferred way to define a new service is the $wgServiceWiringFiles array $services
Definition: hooks.txt:1996
MediaWikiServices is the service locator for the application scope of MediaWiki.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:310