6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 * http://www.gnu.org/copyleft/gpl.html
23 use Wikimedia\Assert\Assert
;
24 use Wikimedia\Services\SalvageableService
;
27 * Factory class to create Config objects
31 class ConfigFactory
implements SalvageableService
{
34 * Map of config name => callback
37 protected $factoryFunctions = [];
40 * Config objects that have already been created
41 * name => Config object
44 protected $configs = [];
47 * @deprecated since 1.27, use MediaWikiServices::getInstance()->getConfigFactory() instead.
49 * @return ConfigFactory
51 public static function getDefaultInstance() {
52 return \MediaWiki\MediaWikiServices
::getInstance()->getConfigFactory();
56 * Re-uses existing Cache objects from $other. Cache objects are only re-used if the
57 * registered factory function for both is the same. Cache config is not copied,
58 * and only instances of caches defined on this instance with the same config
61 * @see SalvageableService::salvage()
63 * @param SalvageableService $other The object to salvage state from. $other must have the
64 * exact same type as $this.
66 public function salvage( SalvageableService
$other ) {
67 Assert
::parameterType( self
::class, $other, '$other' );
69 /** @var ConfigFactory $other */
70 foreach ( $other->factoryFunctions
as $name => $otherFunc ) {
71 if ( !isset( $this->factoryFunctions
[$name] ) ) {
75 // if the callback function is the same, salvage the Cache object
76 // XXX: Closures are never equal!
77 if ( isset( $other->configs
[$name] )
78 && $this->factoryFunctions
[$name] == $otherFunc
80 $this->configs
[$name] = $other->configs
[$name];
81 unset( $other->configs
[$name] );
86 $other->factoryFunctions
= [];
93 public function getConfigNames() {
94 return array_keys( $this->factoryFunctions
);
98 * Register a new config factory function.
99 * Will override if it's already registered.
100 * Use "*" for $name to provide a fallback config for all unknown names.
101 * @param string $name
102 * @param callable|Config $callback A factory callback that takes this ConfigFactory
103 * as an argument and returns a Config instance, or an existing Config instance.
104 * @throws InvalidArgumentException If an invalid callback is provided
106 public function register( $name, $callback ) {
107 if ( !is_callable( $callback ) && !( $callback instanceof Config
) ) {
108 if ( is_array( $callback ) ) {
109 $callback = '[ ' . implode( ', ', $callback ) . ' ]';
110 } elseif ( is_object( $callback ) ) {
111 $callback = 'instanceof ' . get_class( $callback );
113 throw new InvalidArgumentException( 'Invalid callback \'' . $callback . '\' provided' );
116 unset( $this->configs
[$name] );
117 $this->factoryFunctions
[$name] = $callback;
121 * Create a given Config using the registered callback for $name.
122 * If an object was already created, the same Config object is returned.
123 * @param string $name Name of the extension/component you want a Config object for
124 * 'main' is used for core
125 * @throws ConfigException If a factory function isn't registered for $name
126 * @throws UnexpectedValueException If the factory function returns a non-Config object
129 public function makeConfig( $name ) {
130 if ( !isset( $this->configs
[$name] ) ) {
132 if ( !isset( $this->factoryFunctions
[$key] ) ) {
135 if ( !isset( $this->factoryFunctions
[$key] ) ) {
136 throw new ConfigException( "No registered builder available for $name." );
139 if ( $this->factoryFunctions
[$key] instanceof Config
) {
140 $conf = $this->factoryFunctions
[$key];
142 $conf = call_user_func( $this->factoryFunctions
[$key], $this );
145 if ( $conf instanceof Config
) {
146 $this->configs
[$name] = $conf;
148 throw new UnexpectedValueException( "The builder for $name returned a non-Config object." );
152 return $this->configs
[$name];