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
25 * Factory class to create Config objects
32 * Map of config name => callback
35 protected $factoryFunctions = [];
38 * Config objects that have already been created
39 * name => Config object
42 protected $configs = [];
45 * @deprecated since 1.27, use MediaWikiServices::getConfigFactory() instead.
47 * @return ConfigFactory
49 public static function getDefaultInstance() {
50 return \MediaWiki\MediaWikiServices
::getInstance()->getConfigFactory();
54 * Register a new config factory function
55 * Will override if it's already registered
57 * @param callable $callback That takes this ConfigFactory as an argument
58 * @throws InvalidArgumentException If an invalid callback is provided
60 public function register( $name, $callback ) {
61 if ( !is_callable( $callback ) ) {
62 throw new InvalidArgumentException( 'Invalid callback provided' );
64 $this->factoryFunctions
[$name] = $callback;
68 * Create a given Config using the registered callback for $name.
69 * If an object was already created, the same Config object is returned.
70 * @param string $name Name of the extension/component you want a Config object for
71 * 'main' is used for core
72 * @throws ConfigException If a factory function isn't registered for $name
73 * @throws UnexpectedValueException If the factory function returns a non-Config object
76 public function makeConfig( $name ) {
77 if ( !isset( $this->configs
[$name] ) ) {
78 if ( !isset( $this->factoryFunctions
[$name] ) ) {
79 throw new ConfigException( "No registered builder available for $name." );
81 $conf = call_user_func( $this->factoryFunctions
[$name], $this );
82 if ( $conf instanceof Config
) {
83 $this->configs
[$name] = $conf;
85 throw new UnexpectedValueException( "The builder for $name returned a non-Config object." );
89 return $this->configs
[$name];