1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
<?php
/**
* Copyright 2014
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\Config;
use InvalidArgumentException;
use UnexpectedValueException;
use Wikimedia\Assert\Assert;
use Wikimedia\Services\SalvageableService;
/**
* Factory class to create Config objects
*
* @since 1.23
*/
class ConfigFactory implements SalvageableService {
/**
* Map of config name => callback
* @var array
*/
protected $factoryFunctions = [];
/**
* Config objects that have already been created
* name => Config object
* @var array
*/
protected $configs = [];
/**
* Re-uses existing Cache objects from $other. Cache objects are only re-used if the
* registered factory function for both is the same. Cache config is not copied,
* and only instances of caches defined on this instance with the same config
* are copied.
*
* @see SalvageableService::salvage()
*
* @param SalvageableService $other The object to salvage state from. $other must have the
* exact same type as $this.
*/
public function salvage( SalvageableService $other ) {
Assert::parameterType( self::class, $other, '$other' );
/** @var self $other */
'@phan-var self $other';
foreach ( $other->factoryFunctions as $name => $otherFunc ) {
if ( !isset( $this->factoryFunctions[$name] ) ) {
continue;
}
// if the callback function is the same, salvage the Cache object
// XXX: Closures are never equal!
if ( isset( $other->configs[$name] )
&& $this->factoryFunctions[$name] == $otherFunc
) {
$this->configs[$name] = $other->configs[$name];
unset( $other->configs[$name] );
}
}
// disable $other
$other->factoryFunctions = [];
$other->configs = [];
}
/**
* @return string[]
*/
public function getConfigNames() {
return array_keys( $this->factoryFunctions );
}
/**
* Register a new config factory function.
* Will override if it's already registered.
* Use "*" for $name to provide a fallback config for all unknown names.
* @param string $name
* @param callable|Config $callback A factory callback that takes this ConfigFactory
* as an argument and returns a Config instance, or an existing Config instance.
* @throws InvalidArgumentException If an invalid callback is provided
*/
public function register( $name, $callback ) {
if ( !is_callable( $callback ) && !( $callback instanceof Config ) ) {
if ( is_array( $callback ) ) {
$callback = '[ ' . implode( ', ', $callback ) . ' ]';
} elseif ( is_object( $callback ) ) {
$callback = 'instanceof ' . get_class( $callback );
}
throw new InvalidArgumentException( 'Invalid callback \'' . $callback . '\' provided' );
}
unset( $this->configs[$name] );
$this->factoryFunctions[$name] = $callback;
}
/**
* Create a given Config using the registered callback for $name.
* If an object was already created, the same Config object is returned.
* @param string $name Name of the extension/component you want a Config object for
* 'main' is used for core
* @throws ConfigException If a factory function isn't registered for $name
* @throws UnexpectedValueException If the factory function returns a non-Config object
* @return Config
*/
public function makeConfig( $name ) {
if ( !isset( $this->configs[$name] ) ) {
$key = $name;
if ( !isset( $this->factoryFunctions[$key] ) ) {
$key = '*';
}
if ( !isset( $this->factoryFunctions[$key] ) ) {
throw new ConfigException( "No registered builder available for $name." );
}
if ( $this->factoryFunctions[$key] instanceof Config ) {
$conf = $this->factoryFunctions[$key];
} else {
$conf = call_user_func( $this->factoryFunctions[$key], $this );
}
if ( $conf instanceof Config ) {
$this->configs[$name] = $conf;
} else {
throw new UnexpectedValueException( "The builder for $name returned a non-Config object." );
}
}
return $this->configs[$name];
}
}
/** @deprecated class alias since 1.41 */
class_alias( ConfigFactory::class, 'ConfigFactory' );
|
