DatabaseBlockStoreFactory.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Block;
 
use MediaWiki\CommentStore\CommentStore;
use MediaWiki\Config\ServiceOptions;
use MediaWiki\HookContainer\HookContainer;
use MediaWiki\User\ActorStoreFactory;
use MediaWiki\User\TempUser\TempUserConfig;
use MediaWiki\User\UserFactory;
use Psr\Log\LoggerInterface;
use Wikimedia\Rdbms\LBFactory;
use Wikimedia\Rdbms\ReadOnlyMode;
 
class DatabaseBlockStoreFactory {
    public const CONSTRUCTOR_OPTIONS = DatabaseBlockStore::CONSTRUCTOR_OPTIONS;
 
    private ServiceOptions $options;
    private LoggerInterface $logger;
    private ActorStoreFactory $actorStoreFactory;
    private BlockRestrictionStoreFactory $blockRestrictionStoreFactory;
    private CommentStore $commentStore;
    private HookContainer $hookContainer;
    private LBFactory $loadBalancerFactory;
    private ReadOnlyMode $readOnlyMode;
    private UserFactory $userFactory;
    private TempUserConfig $tempUserConfig;
    private BlockUtilsFactory $blockUtilsFactory;
    private AutoblockExemptionList $autoblockExemptionList;
 
    private array $storeCache = [];
 
    public function __construct(
        ServiceOptions $options,
        LoggerInterface $logger,
        ActorStoreFactory $actorStoreFactory,
        BlockRestrictionStoreFactory $blockRestrictionStoreFactory,
        CommentStore $commentStore,
        HookContainer $hookContainer,
        LBFactory $loadBalancerFactory,
        ReadOnlyMode $readOnlyMode,
        UserFactory $userFactory,
        TempUserConfig $tempUserConfig,
        BlockUtilsFactory $blockUtilsFactory,
        AutoblockExemptionList $autoblockExemptionList
    ) {
        $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->readOnlyMode = $readOnlyMode;
        $this->userFactory = $userFactory;
        $this->tempUserConfig = $tempUserConfig;
        $this->blockUtilsFactory = $blockUtilsFactory;
        $this->autoblockExemptionList = $autoblockExemptionList;
    }
 
    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] ) ) {
            $this->storeCache[$storeCacheKey] = new DatabaseBlockStore(
                $this->options,
                $this->logger,
                $this->actorStoreFactory,
                $this->blockRestrictionStoreFactory->getBlockRestrictionStore( $wikiId ),
                $this->commentStore,
                $this->hookContainer,
                $this->loadBalancerFactory,
                $this->readOnlyMode,
                $this->userFactory,
                $this->tempUserConfig,
                $this->blockUtilsFactory->getBlockUtils( $wikiId ),
                $this->autoblockExemptionList,
                $wikiId
            );
        }
        return $this->storeCache[$storeCacheKey];
    }
}