SettingsBuilder: remove @unstable markers.
The @unstable markers were intended for the 1.38 release. The interface can be conisdered stable in 1.39. Change-Id: Ie2fdd5bfe2622aa8845883019c1666dfb3073719
This commit is contained in:
parent
a2b423177c
commit
ce8c3ddfe5
6 changed files with 22 additions and 18 deletions
|
|
@ -6,6 +6,11 @@ use Config;
|
|||
use HashConfig;
|
||||
use MediaWiki\Config\IterableConfig;
|
||||
|
||||
/**
|
||||
* ConfigBuilder implemented around arrays, will create an IterableConfig.
|
||||
*
|
||||
* @since 1.39
|
||||
*/
|
||||
class ArrayConfigBuilder extends ConfigBuilderBase {
|
||||
|
||||
/** @var array */
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ use MediaWiki\Settings\SettingsBuilderException;
|
|||
/**
|
||||
* Builder for Config objects.
|
||||
*
|
||||
* @unstable
|
||||
* @since 1.39
|
||||
*/
|
||||
interface ConfigBuilder {
|
||||
|
||||
|
|
|
|||
|
|
@ -5,6 +5,11 @@ namespace MediaWiki\Settings\Config;
|
|||
use Config;
|
||||
use GlobalVarConfig;
|
||||
|
||||
/**
|
||||
* ConfigBuilder implemented on top of global variables.
|
||||
*
|
||||
* @since 1.39
|
||||
*/
|
||||
class GlobalConfigBuilder extends ConfigBuilderBase {
|
||||
|
||||
/** @var string */
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ namespace MediaWiki\Settings\Config;
|
|||
/**
|
||||
* Null implementation of PhpIniSink, useful for testing and benchmarking.
|
||||
*
|
||||
* @unstable
|
||||
* @since 1.39
|
||||
*/
|
||||
class NullIniSink extends PhpIniSink {
|
||||
|
||||
|
|
|
|||
|
|
@ -5,12 +5,17 @@ namespace MediaWiki\Settings\Config;
|
|||
use Wikimedia\NormalizedException\NormalizedExceptionTrait;
|
||||
|
||||
/**
|
||||
* @unstable
|
||||
* Settings sink for values to pass to ini_set.
|
||||
*
|
||||
* @since 1.39
|
||||
*/
|
||||
class PhpIniSink {
|
||||
use NormalizedExceptionTrait;
|
||||
|
||||
/**
|
||||
* Sets a php runtime configuration value using ini_set().
|
||||
* A PHP notice is triggered if setting the value fails.
|
||||
*
|
||||
* @param string $option
|
||||
* @param string $value
|
||||
* @return void
|
||||
|
|
|
|||
|
|
@ -99,8 +99,6 @@ class SettingsBuilder {
|
|||
/**
|
||||
* Load settings from a {@link SettingsSource}.
|
||||
*
|
||||
* @unstable
|
||||
*
|
||||
* @param SettingsSource $source
|
||||
* @return $this
|
||||
*/
|
||||
|
|
@ -116,8 +114,6 @@ class SettingsBuilder {
|
|||
/**
|
||||
* Load settings from an array.
|
||||
*
|
||||
* @unstable
|
||||
*
|
||||
* @param array $newSettings
|
||||
*
|
||||
* @return $this
|
||||
|
|
@ -129,8 +125,6 @@ class SettingsBuilder {
|
|||
/**
|
||||
* Load settings from a file.
|
||||
*
|
||||
* @unstable
|
||||
*
|
||||
* @param string $path
|
||||
* @return $this
|
||||
*/
|
||||
|
|
@ -142,8 +136,6 @@ class SettingsBuilder {
|
|||
* Checks whether the given file exists relative to the settings builder's
|
||||
* base directory.
|
||||
*
|
||||
* @unstable
|
||||
*
|
||||
* @param string $path
|
||||
* @return bool
|
||||
*/
|
||||
|
|
@ -214,8 +206,6 @@ class SettingsBuilder {
|
|||
/**
|
||||
* Apply any settings loaded so far to the runtime environment.
|
||||
*
|
||||
* @unstable
|
||||
*
|
||||
* @note This usually makes all configuration available in global variables.
|
||||
* This may however not be the case in the future.
|
||||
*
|
||||
|
|
@ -380,7 +370,7 @@ class SettingsBuilder {
|
|||
* Depending on the variable's specification, the new value may
|
||||
* be merged with the previous value, or may replace it.
|
||||
* This is a shorthand for putConfigValues( [ $key => $value ] ).
|
||||
* @unstable
|
||||
*
|
||||
* @see overrideConfigValue
|
||||
*
|
||||
* @param string $key the name of the config setting
|
||||
|
|
@ -397,7 +387,7 @@ class SettingsBuilder {
|
|||
* Depending on the variables' specification, the new values may
|
||||
* be merged with the previous values, or they may replace them.
|
||||
* This is a shorthand for loadArray( [ 'config' => $values ] ).
|
||||
* @unstable
|
||||
*
|
||||
* @see overrideConfigValues
|
||||
*
|
||||
* @param array $values An associative array mapping names to values.
|
||||
|
|
@ -412,7 +402,7 @@ class SettingsBuilder {
|
|||
* Override the value of a config variable.
|
||||
* This ignores any merge strategies and discards any previous value.
|
||||
* This is a shorthand for overrideConfigValues( [ $key => $value ] ).
|
||||
* @unstable
|
||||
*
|
||||
* @see putConfigValue
|
||||
*
|
||||
* @param string $key the name of the config setting
|
||||
|
|
@ -428,7 +418,7 @@ class SettingsBuilder {
|
|||
* Override the value of multiple config variables.
|
||||
* This ignores any merge strategies and discards any previous value.
|
||||
* This is a shorthand for loadArray( [ 'config-overrides' => $values ] ).
|
||||
* @unstable
|
||||
*
|
||||
* @see putConfigValues
|
||||
*
|
||||
* @param array $values An associative array mapping names to values.
|
||||
|
|
@ -444,7 +434,6 @@ class SettingsBuilder {
|
|||
*
|
||||
* @note This will implicitly call apply()
|
||||
*
|
||||
* @unstable
|
||||
* @return Config
|
||||
*/
|
||||
public function getConfig(): Config {
|
||||
|
|
|
|||
Loading…
Reference in a new issue