includes/config/ConfigFactory.php

   1 <?php
   2
   3 /**
   4  * Copyright 2014
   5  *
   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.
  10  *
  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.
  15  *
  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
  20  *
  21  * @file
  22  */
  23
  24 /**
  25  * Factory class to create Config objects
  26  *
  27  * @since 1.23
  28  */
  29 class ConfigFactory {
  30
  31         /**
  32          * Map of config name => callback
  33          * @var array
  34          */
  35         protected $factoryFunctions = [];
  36
  37         /**
  38          * Config objects that have already been created
  39          * name => Config object
  40          * @var array
  41          */
  42         protected $configs = [];
  43
  44         /**
  45          * @deprecated since 1.27, use MediaWikiServices::getConfigFactory() instead.
  46          *
  47          * @return ConfigFactory
  48          */
  49         public static function getDefaultInstance() {
  50                 return \MediaWiki\MediaWikiServices::getInstance()->getConfigFactory();
  51         }
  52
  53         /**
  54          * Register a new config factory function
  55          * Will override if it's already registered
  56          * @param string $name
  57          * @param callable $callback That takes this ConfigFactory as an argument
  58          * @throws InvalidArgumentException If an invalid callback is provided
  59          */
  60         public function register( $name, $callback ) {
  61                 if ( !is_callable( $callback ) ) {
  62                         throw new InvalidArgumentException( 'Invalid callback provided' );
  63                 }
  64                 $this->factoryFunctions[$name] = $callback;
  65         }
  66
  67         /**
  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
  74          * @return Config
  75          */
  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." );
  80                         }
  81                         $conf = call_user_func( $this->factoryFunctions[$name], $this );
  82                         if ( $conf instanceof Config ) {
  83                                 $this->configs[$name] = $conf;
  84                         } else {
  85                                 throw new UnexpectedValueException( "The builder for $name returned a non-Config object." );
  86                         }
  87                 }
  88
  89                 return $this->configs[$name];
  90         }
  91 }