aboutsummaryrefslogtreecommitdiffstats
path: root/includes/Settings/Config/GlobalConfigBuilder.php
blob: 2ab83d5c2569614151a1b88e1b839c6c3675602a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
<?php

namespace MediaWiki\Settings\Config;

use MediaWiki\Config\Config;
use MediaWiki\Config\GlobalVarConfig;
use function array_key_exists;

class GlobalConfigBuilder extends ConfigBuilderBase {

	public const DEFAULT_PREFIX = 'wg';

	/** @var string */
	private $prefix;

	/**
	 * @param string $prefix
	 */
	public function __construct( string $prefix = self::DEFAULT_PREFIX ) {
		$this->prefix = $prefix;
	}

	protected function has( string $key ): bool {
		$var = $this->getVarName( $key );
		// (T317951) Don't call array_key_exists unless we have to, as it's slow
		// on PHP 8.1+ for $GLOBALS. When the key is set but is explicitly set
		// to null, we still need to fall back to array_key_exists, but that's
		// rarer.
		return isset( $GLOBALS[$var] ) || array_key_exists( $var, $GLOBALS );
	}

	public function get( string $key ) {
		$var = $this->getVarName( $key );
		return $GLOBALS[ $var ] ?? null;
	}

	protected function update( string $key, $value ) {
		$var = $this->getVarName( $key );
		$GLOBALS[ $var ] = $value;
	}

	public function setMulti( array $values, array $mergeStrategies = [] ): ConfigBuilder {
		// NOTE: It is tempting to do $GLOBALS = array_merge( $GLOBALS, $values ).
		//       But that no longer works in PHP 8.1!
		//       See https://wiki.php.net/rfc/restrict_globals_usage

		foreach ( $values as $key => $newValue ) {
			$var = $this->prefix . $key; // inline getVarName() to avoid function call

			// Optimization: Inlined logic from set() for performance
			if ( isset( $GLOBALS[$var] ) && array_key_exists( $key, $mergeStrategies ) ) {
				$mergeStrategy = $mergeStrategies[$key];
				if ( $mergeStrategy && is_array( $newValue ) ) {
					$oldValue = $GLOBALS[$var];
					if ( $oldValue && is_array( $oldValue ) ) {
						$newValue = $mergeStrategy->merge( $oldValue, $newValue );
					}
				}
			}

			$GLOBALS[$var] = $newValue;
		}
		return $this;
	}

	private function getVarName( string $key ): string {
		return $this->prefix . $key;
	}

	public function build(): Config {
		return new GlobalVarConfig( $this->prefix );
	}
}