ConfigRepository.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Config;
 
use Wikimedia\Assert\Assert;
use Wikimedia\Services\SalvageableService;
 
class ConfigRepository implements SalvageableService {
    private $configFactory;
 
    private $configItems = [
        'private' => [],
        'public' => [],
    ];
 
    public function __construct( \ConfigFactory $configFactory ) {
        $this->configFactory = $configFactory;
    }
 
    public function has( $name, $alsoPrivate = false ) {
        return isset( $this->configItems['public'][$name] ) ||
            ( $alsoPrivate && isset( $this->configItems['private'][$name] ) );
    }
 
    public function get( $name ) {
        if ( !$this->has( $name, true ) ) {
            throw new \ConfigException( 'The configuration option ' . $name . ' does not exist.' );
        }
 
        return $this->configItems['public'][$name] ?? $this->configItems['private'][$name];
    }
 
    public function getAll() {
        return array_merge( $this->configItems['private'], $this->configItems['public'] );
    }
 
    public function getPublic() {
        return $this->configItems['public'];
    }
 
    public function getValueOf( $name ) {
        $config = $this->get( $name );
        if ( !isset( $config['configregistry'] ) ) {
            return $config['value'];
        }
 
        return $this->configFactory->makeConfig( $config['configregistry'] )->get( $name );
    }
 
    public function getDescriptionOf( $name ) {
        $config = $this->get( $name );
        if ( isset( $config['descriptionmsg'] ) ) {
            return wfMessage( $config['descriptionmsg'] )->escaped();
        }
        if ( isset( $config['description'] ) ) {
            return htmlspecialchars( $config['description'] );
        }
        return '';
    }
 
    public function add( $name, array $config ) {
        if ( $this->has( $name ) ) {
            throw new \ConfigException( 'A configuration with the name ' . $name .
                'does already exist. It is provided by: ' .
                $this->get( $name )['providedby'] );
        }
        if ( isset( $config['public'] ) && $config['public'] ) {
            $this->configItems['public'][$name] = $config;
        } else {
            $this->configItems['private'][$name] = $config;
        }
    }
 
    public function isEmpty( $includePrivate = false ) {
        if ( $includePrivate ) {
            return empty( $this->configItems['private'] ) &&
                empty( $this->configItems[ 'public'] );
        }
        return empty( $this->configItems['public'] );
    }
 
    public function salvage( SalvageableService $other ) {
        Assert::parameterType( self::class, $other, '$other' );
 
        foreach ( $other->configItems['public'] as $name => $otherConfig ) {
            if ( isset( $this->configItems['public'][$name] ) ) {
                continue;
            }
 
            $this->add( $name, $otherConfig );
        }
        foreach ( $other->configItems['private'] as $name => $otherConfig ) {
            if ( isset( $this->configItems['private'][$name] ) ) {
                continue;
            }
 
            $this->add( $name, $otherConfig );
        }
 
        // disable $other
        $other->configItems = [];
    }
}