LockManagerGroup.php

Go to the documentation of this file.

<?php
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\MediaWikiServices;
use Wikimedia\Rdbms\LBFactory;
 
class LockManagerGroup {
    protected $domain;
 
    protected $lbFactory;
 
    protected $managers = [];
 
    public function __construct( $domain, array $lockManagerConfigs, LBFactory $lbFactory ) {
        $this->domain = $domain;
        $this->lbFactory = $lbFactory;
 
        foreach ( $lockManagerConfigs as $config ) {
            $config['domain'] = $this->domain;
            if ( !isset( $config['name'] ) ) {
                throw new Exception( "Cannot register a lock manager with no name." );
            }
            $name = $config['name'];
            if ( !isset( $config['class'] ) ) {
                throw new Exception( "Cannot register lock manager `{$name}` with no class." );
            }
            $class = $config['class'];
            unset( $config['class'] ); // lock manager won't need this
            $this->managers[$name] = [
                'class' => $class,
                'config' => $config,
                'instance' => null
            ];
        }
    }
 
    public static function singleton( $domain = false ) {
        return MediaWikiServices::getInstance()->getLockManagerGroupFactory()
            ->getLockManagerGroup( $domain );
    }
 
    public static function destroySingletons() {
        MediaWikiServices::getInstance()->resetServiceForTesting( 'LockManagerGroupFactory' );
    }
 
    public function get( $name ) {
        if ( !isset( $this->managers[$name] ) ) {
            throw new Exception( "No lock manager defined with the name `$name`." );
        }
        // Lazy-load the actual lock manager instance
        if ( !isset( $this->managers[$name]['instance'] ) ) {
            $class = $this->managers[$name]['class'];
            '@phan-var string $class';
            $config = $this->managers[$name]['config'];
            $config['logger'] = LoggerFactory::getInstance( 'LockManager' );
 
            $this->managers[$name]['instance'] = new $class( $config );
        }
 
        return $this->managers[$name]['instance'];
    }
 
    public function config( $name ) {
        if ( !isset( $this->managers[$name] ) ) {
            throw new Exception( "No lock manager defined with the name `$name`." );
        }
        $class = $this->managers[$name]['class'];
 
        return [ 'class' => $class ] + $this->managers[$name]['config'];
    }
 
    public function getDefault() {
        wfDeprecated( __METHOD__, '1.35' );
 
        return isset( $this->managers['default'] )
            ? $this->get( 'default' )
            : new NullLockManager( [] );
    }
 
    public function getAny() {
        wfDeprecated( __METHOD__, '1.35' );
 
        return isset( $this->managers['default'] )
            ? $this->get( 'default' )
            : $this->get( 'fsLockManager' );
    }
}