From c1f9b1f7b1b77776192048005dcc66dcf3df2bfb Mon Sep 17 00:00:00 2001 From: Pierre Schmitz Date: Sat, 27 Dec 2014 15:41:37 +0100 Subject: Update to MediaWiki 1.24.1 --- includes/config/Config.php | 47 +++++++++++++++ includes/config/ConfigException.php | 29 ++++++++++ includes/config/ConfigFactory.php | 112 ++++++++++++++++++++++++++++++++++++ includes/config/GlobalVarConfig.php | 108 ++++++++++++++++++++++++++++++++++ includes/config/HashConfig.php | 75 ++++++++++++++++++++++++ includes/config/MultiConfig.php | 72 +++++++++++++++++++++++ includes/config/MutableConfig.php | 38 ++++++++++++ 7 files changed, 481 insertions(+) create mode 100644 includes/config/Config.php create mode 100644 includes/config/ConfigException.php create mode 100644 includes/config/ConfigFactory.php create mode 100644 includes/config/GlobalVarConfig.php create mode 100644 includes/config/HashConfig.php create mode 100644 includes/config/MultiConfig.php create mode 100644 includes/config/MutableConfig.php (limited to 'includes/config') diff --git a/includes/config/Config.php b/includes/config/Config.php new file mode 100644 index 00000000..38f589dc --- /dev/null +++ b/includes/config/Config.php @@ -0,0 +1,47 @@ + callback + * @var array + */ + protected $factoryFunctions = array(); + + /** + * Config objects that have already been created + * name => Config object + * @var array + */ + protected $configs = array(); + + /** + * @var ConfigFactory + */ + private static $self; + + public static function getDefaultInstance() { + if ( !self::$self ) { + self::$self = new self; + global $wgConfigRegistry; + foreach ( $wgConfigRegistry as $name => $callback ) { + self::$self->register( $name, $callback ); + } + } + return self::$self; + } + + /** + * Destroy the default instance + * Should only be called inside unit tests + * @throws MWException + * @codeCoverageIgnore + */ + public static function destroyDefaultInstance() { + if ( !defined( 'MW_PHPUNIT_TEST' ) ) { + throw new MWException( __METHOD__ . ' was called outside of unit tests' ); + } + + self::$self = null; + } + + /** + * Register a new config factory function + * Will override if it's already registered + * @param string $name + * @param callable $callback That takes this ConfigFactory as an argument + * @throws InvalidArgumentException If an invalid callback is provided + */ + public function register( $name, $callback ) { + if ( !is_callable( $callback ) ) { + throw new InvalidArgumentException( 'Invalid callback provided' ); + } + $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] ) ) { + if ( !isset( $this->factoryFunctions[$name] ) ) { + throw new ConfigException( "No registered builder available for $name." ); + } + $conf = call_user_func( $this->factoryFunctions[$name], $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]; + } +} diff --git a/includes/config/GlobalVarConfig.php b/includes/config/GlobalVarConfig.php new file mode 100644 index 00000000..39d6e8e1 --- /dev/null +++ b/includes/config/GlobalVarConfig.php @@ -0,0 +1,108 @@ +prefix = $prefix; + } + + /** + * @see Config::get + */ + public function get( $name ) { + if ( !$this->has( $name ) ) { + throw new ConfigException( __METHOD__ . ": undefined option: '$name'" ); + } + return $this->getWithPrefix( $this->prefix, $name ); + } + + /** + * @see Config::has + */ + public function has( $name ) { + return $this->hasWithPrefix( $this->prefix, $name ); + } + + /** + * @see MutableConfig::set + * @deprecated since 1.24 + */ + public function set( $name, $value ) { + wfDeprecated( __METHOD__, '1.24' ); + $this->setWithPrefix( $this->prefix, $name, $value ); + } + + /** + * Get a variable with a given prefix, if not the defaults. + * + * @param string $prefix Prefix to use on the variable, if one. + * @param string $name Variable name without prefix + * @return mixed + */ + protected function getWithPrefix( $prefix, $name ) { + return $GLOBALS[$prefix . $name]; + } + + /** + * Check if a variable with a given prefix is set + * + * @param string $prefix Prefix to use on the variable + * @param string $name Variable name without prefix + * @return bool + */ + protected function hasWithPrefix( $prefix, $name ) { + $var = $prefix . $name; + return array_key_exists( $var, $GLOBALS ); + } + + /** + * Get a variable with a given prefix, if not the defaults. + * + * @param string $prefix Prefix to use on the variable + * @param string $name Variable name without prefix + * @param mixed $value Value to set + * @deprecated since 1.24 + */ + protected function setWithPrefix( $prefix, $name, $value ) { + $GLOBALS[$prefix . $name] = $value; + } +} diff --git a/includes/config/HashConfig.php b/includes/config/HashConfig.php new file mode 100644 index 00000000..a09a0a43 --- /dev/null +++ b/includes/config/HashConfig.php @@ -0,0 +1,75 @@ +settings = $settings; + } + + /** + * @see Config::get + */ + public function get( $name ) { + if ( !$this->has( $name ) ) { + throw new ConfigException( __METHOD__ . ": undefined option: '$name'" ); + } + + return $this->settings[$name]; + } + + /** + * @see Config::has + */ + public function has( $name ) { + return array_key_exists( $name, $this->settings ); + } + + /** + * @see Config::set + */ + public function set( $name, $value ) { + $this->settings[$name] = $value; + } +} diff --git a/includes/config/MultiConfig.php b/includes/config/MultiConfig.php new file mode 100644 index 00000000..cbb65aa6 --- /dev/null +++ b/includes/config/MultiConfig.php @@ -0,0 +1,72 @@ +configs = $configs; + } + + /** + * @see Config::get + */ + public function get( $name ) { + foreach ( $this->configs as $config ) { + if ( $config->has( $name ) ) { + return $config->get( $name ); + } + } + + throw new ConfigException( __METHOD__ . ": undefined option: '$name'" ); + } + + /** + * @see Config::has + */ + public function has( $name ) { + foreach ( $this->configs as $config ) { + if ( $config->has( $name ) ) { + return true; + } + } + + return false; + } +} diff --git a/includes/config/MutableConfig.php b/includes/config/MutableConfig.php new file mode 100644 index 00000000..e765e3bc --- /dev/null +++ b/includes/config/MutableConfig.php @@ -0,0 +1,38 @@ +