ConfigFactory.php

Go to the documentation of this file.

<?php
 
use MediaWiki\MediaWikiServices;
use Wikimedia\Assert\Assert;
use Wikimedia\Services\SalvageableService;
 
class ConfigFactory implements SalvageableService {
 
    protected $factoryFunctions = [];
 
    protected $configs = [];
 
    public static function getDefaultInstance() {
        return MediaWikiServices::getInstance()->getConfigFactory();
    }
 
    public function salvage( SalvageableService $other ) {
        Assert::parameterType( self::class, $other, '$other' );
 
        '@phan-var self $other';
        foreach ( $other->factoryFunctions as $name => $otherFunc ) {
            if ( !isset( $this->factoryFunctions[$name] ) ) {
                continue;
            }
 
            // if the callback function is the same, salvage the Cache object
            // XXX: Closures are never equal!
            if ( isset( $other->configs[$name] )
                && $this->factoryFunctions[$name] == $otherFunc
            ) {
                $this->configs[$name] = $other->configs[$name];
                unset( $other->configs[$name] );
            }
        }
 
        // disable $other
        $other->factoryFunctions = [];
        $other->configs = [];
    }
 
    public function getConfigNames() {
        return array_keys( $this->factoryFunctions );
    }
 
    public function register( $name, $callback ) {
        if ( !is_callable( $callback ) && !( $callback instanceof Config ) ) {
            if ( is_array( $callback ) ) {
                $callback = '[ ' . implode( ', ', $callback ) . ' ]';
            } elseif ( is_object( $callback ) ) {
                $callback = 'instanceof ' . get_class( $callback );
            }
            throw new InvalidArgumentException( 'Invalid callback \'' . $callback . '\' provided' );
        }
 
        unset( $this->configs[$name] );
        $this->factoryFunctions[$name] = $callback;
    }
 
    public function makeConfig( $name ) {
        if ( !isset( $this->configs[$name] ) ) {
            $key = $name;
            if ( !isset( $this->factoryFunctions[$key] ) ) {
                $key = '*';
            }
            if ( !isset( $this->factoryFunctions[$key] ) ) {
                throw new ConfigException( "No registered builder available for $name." );
            }
 
            if ( $this->factoryFunctions[$key] instanceof Config ) {
                $conf = $this->factoryFunctions[$key];
            } else {
                $conf = call_user_func( $this->factoryFunctions[$key], $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];
    }
 
}