BlockUtilsFactory.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Block;
 
use MediaWiki\Config\ServiceOptions;
use MediaWiki\User\ActorStoreFactory;
use MediaWiki\User\UserNameUtils;
use Wikimedia\Rdbms\LBFactory;
 
class BlockUtilsFactory {
    public const CONSTRUCTOR_OPTIONS = BlockUtils::CONSTRUCTOR_OPTIONS;
 
    private ServiceOptions $options;
    private ActorStoreFactory $actorStoreFactory;
    private UserNameUtils $userNameUtils;
    private LBFactory $loadBalancerFactory;
 
    private array $storeCache = [];
 
    public function __construct(
        ServiceOptions $options,
        ActorStoreFactory $actorStoreFactory,
        UserNameUtils $userNameUtils,
        LBFactory $loadBalancerFactory
    ) {
        $options->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS );
 
        $this->options = $options;
        $this->actorStoreFactory = $actorStoreFactory;
        $this->userNameUtils = $userNameUtils;
        $this->loadBalancerFactory = $loadBalancerFactory;
    }
 
    public function getBlockUtils( $wikiId = Block::LOCAL ): BlockUtils {
        if ( is_string( $wikiId ) && $this->loadBalancerFactory->getLocalDomainID() === $wikiId ) {
            $wikiId = Block::LOCAL;
        }
 
        $storeCacheKey = $wikiId === Block::LOCAL ? 'LOCAL' : 'crosswikistore-' . $wikiId;
        if ( !isset( $this->storeCache[$storeCacheKey] ) ) {
            $this->storeCache[$storeCacheKey] = new BlockUtils(
                $this->options,
                $this->actorStoreFactory->getUserIdentityLookup( $wikiId ),
                $this->userNameUtils,
                $wikiId
            );
        }
        return $this->storeCache[$storeCacheKey];
    }
}