DatabaseBlockStoreFactory.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Block;
 
use ConfiguredReadOnlyMode;
use MediaWiki\CommentStore\CommentStore;
use MediaWiki\Config\ServiceOptions;
use MediaWiki\HookContainer\HookContainer;
use MediaWiki\User\ActorStoreFactory;
use MediaWiki\User\UserFactory;
use Psr\Log\LoggerInterface;
use ReadOnlyMode;
use Wikimedia\Rdbms\LBFactory;
 
class DatabaseBlockStoreFactory {
    public const CONSTRUCTOR_OPTIONS = DatabaseBlockStore::CONSTRUCTOR_OPTIONS;
 
    private $options;
 
    private $logger;
 
    private $actorStoreFactory;
 
    private $blockRestrictionStoreFactory;
 
    private $commentStore;
 
    private $hookContainer;
 
    private $loadBalancerFactory;
 
    private $configuredReadOnlyMode;
 
    private $userFactory;
 
    private $storeCache = [];
 
    public function __construct(
        ServiceOptions $options,
        LoggerInterface $logger,
        ActorStoreFactory $actorStoreFactory,
        BlockRestrictionStoreFactory $blockRestrictionStoreFactory,
        CommentStore $commentStore,
        HookContainer $hookContainer,
        LBFactory $loadBalancerFactory,
        ConfiguredReadOnlyMode $configuredReadOnlyMode,
        UserFactory $userFactory
    ) {
        $options->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS );
 
        $this->options = $options;
        $this->logger = $logger;
        $this->actorStoreFactory = $actorStoreFactory;
        $this->blockRestrictionStoreFactory = $blockRestrictionStoreFactory;
        $this->commentStore = $commentStore;
        $this->hookContainer = $hookContainer;
        $this->loadBalancerFactory = $loadBalancerFactory;
        $this->configuredReadOnlyMode = $configuredReadOnlyMode;
        $this->userFactory = $userFactory;
    }
 
    public function getDatabaseBlockStore( $wikiId = DatabaseBlock::LOCAL ): DatabaseBlockStore {
        if ( is_string( $wikiId ) && $this->loadBalancerFactory->getLocalDomainID() === $wikiId ) {
            $wikiId = DatabaseBlock::LOCAL;
        }
 
        $storeCacheKey = $wikiId === DatabaseBlock::LOCAL ? 'LOCAL' : 'crosswikistore-' . $wikiId;
        if ( !isset( $this->storeCache[$storeCacheKey] ) ) {
            $loadBalancer = $this->loadBalancerFactory->getMainLB( $wikiId );
            $this->storeCache[$storeCacheKey] = new DatabaseBlockStore(
                $this->options,
                $this->logger,
                $this->actorStoreFactory,
                $this->blockRestrictionStoreFactory->getBlockRestrictionStore( $wikiId ),
                $this->commentStore,
                $this->hookContainer,
                $loadBalancer,
                new ReadOnlyMode( $this->configuredReadOnlyMode, $loadBalancer ),
                $this->userFactory,
                $wikiId
            );
        }
        return $this->storeCache[$storeCacheKey];
    }
}