MediaWiki REL1_27
LockManagerGroup.php
Go to the documentation of this file.
1<?php
33 protected static $instances = [];
34
35 protected $domain; // string; domain (usually wiki ID)
36
38 protected $managers = [];
39
43 protected function __construct( $domain ) {
44 $this->domain = $domain;
45 }
46
51 public static function singleton( $domain = false ) {
52 $domain = ( $domain === false ) ? wfWikiID() : $domain;
53 if ( !isset( self::$instances[$domain] ) ) {
54 self::$instances[$domain] = new self( $domain );
55 self::$instances[$domain]->initFromGlobals();
56 }
57
58 return self::$instances[$domain];
59 }
60
64 public static function destroySingletons() {
65 self::$instances = [];
66 }
67
71 protected function initFromGlobals() {
73
74 $this->register( $wgLockManagers );
75 }
76
83 protected function register( array $configs ) {
84 foreach ( $configs as $config ) {
85 $config['domain'] = $this->domain;
86 if ( !isset( $config['name'] ) ) {
87 throw new Exception( "Cannot register a lock manager with no name." );
88 }
89 $name = $config['name'];
90 if ( !isset( $config['class'] ) ) {
91 throw new Exception( "Cannot register lock manager `{$name}` with no class." );
92 }
93 $class = $config['class'];
94 unset( $config['class'] ); // lock manager won't need this
95 $this->managers[$name] = [
96 'class' => $class,
97 'config' => $config,
98 'instance' => null
99 ];
100 }
101 }
102
110 public function get( $name ) {
111 if ( !isset( $this->managers[$name] ) ) {
112 throw new Exception( "No lock manager defined with the name `$name`." );
113 }
114 // Lazy-load the actual lock manager instance
115 if ( !isset( $this->managers[$name]['instance'] ) ) {
116 $class = $this->managers[$name]['class'];
117 $config = $this->managers[$name]['config'];
118 $this->managers[$name]['instance'] = new $class( $config );
119 }
120
121 return $this->managers[$name]['instance'];
122 }
123
131 public function config( $name ) {
132 if ( !isset( $this->managers[$name] ) ) {
133 throw new Exception( "No lock manager defined with the name `$name`." );
134 }
135 $class = $this->managers[$name]['class'];
136
137 return [ 'class' => $class ] + $this->managers[$name]['config'];
138 }
139
146 public function getDefault() {
147 return isset( $this->managers['default'] )
148 ? $this->get( 'default' )
149 : new NullLockManager( [] );
150 }
151
160 public function getAny() {
161 return isset( $this->managers['default'] )
162 ? $this->get( 'default' )
163 : $this->get( 'fsLockManager' );
164 }
165}
$wgLockManagers
Array of configuration arrays for each lock manager.
wfWikiID()
Get an ASCII string identifying this wiki This is used as a prefix in memcached keys.
Class to handle file lock manager registration.
getDefault()
Get the default lock manager configured for the site.
static array $instances
(domain => LockManager)
config( $name)
Get the config array for a lock manager object with a given name.
initFromGlobals()
Register lock managers from the global variables.
getAny()
Get the default lock manager configured for the site or at least some other effective configured lock...
static singleton( $domain=false)
static destroySingletons()
Destroy the singleton instances.
array $managers
Array of (name => ('class' => ..., 'config' => ..., 'instance' => ...))
Simple version of LockManager that does nothing.
when a variable name is used in a it is silently declared as a new local masking the global
Definition design.txt:95
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
the array() calling protocol came about after MediaWiki 1.4rc1.
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:314
processing should stop and the error should be shown to the user * false
Definition hooks.txt:189
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:37