LocalSettingsLoader.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Settings;
 
use MediaWiki\Settings\Source\SettingsFileUtils;
 
class LocalSettingsLoader {
 
    private SettingsBuilder $settingsBuilder;
 
    private string $baseDir;
 
    public function __construct( SettingsBuilder $settingsBuilder, string $baseDir ) {
        $this->settingsBuilder = $settingsBuilder;
        $this->baseDir = $baseDir;
    }
 
    public function loadLocalSettingsFile( string $file ) {
        // If $file is not a PHP file, just load it as a data file.
        if ( !str_ends_with( $file, '.php' ) ) {
            $this->settingsBuilder->loadFile( $file );
            return;
        }
 
        // Make config settings available in local scope.
        $config = $this->settingsBuilder->getConfig();
        foreach ( $this->settingsBuilder->getDefinedConfigKeys() as $key ) {
            $var = "wg$key"; // NOTE: broken for extensions that use prefixes other than "wg"!
            $$var = $config->get( $key ); // XXX: slow?! Can we get the entire array in one go?
        }
 
        // make available some non-config globals available
        // phpcs:ignore MediaWiki.VariableAnalysis.UnusedGlobalVariables.UnusedGlobal$wgCommandLineMode, MediaWiki.Usage.DeprecatedGlobalVariables
        global $wgCommandLineMode;
 
        // make additional variables available
        // phpcs:ignore MediaWiki.VariableAnalysis.MisleadingGlobalNames.Misleading$wgSettings
        $wgSettings = $this->settingsBuilder;
        $IP = $this->baseDir;
 
        // pull in the actual settings file
        $file = SettingsFileUtils::resolveRelativeLocation( $file, $this->baseDir );
        $settings = require $file;
 
        // Capture config variables.
        $overrides = [];
        foreach ( get_defined_vars() as $name => $value ) {
            if ( str_starts_with( $name, 'wg' ) ) {
                $key = substr( $name, 2 );
                $overrides[$key] = $value;
            }
        }
 
        $this->settingsBuilder->overrideConfigValues( $overrides );
 
        // If the file returned a settings array, use it.
        // This is especially useful for generated PHP files.
        if ( is_array( $settings ) ) {
            $this->settingsBuilder->loadArray( $settings );
        }
    }
}