UserGroupManagerFactory.php

Go to the documentation of this file.

<?php
namespace MediaWiki\User;
 
use MediaWiki\Config\ServiceOptions;
use MediaWiki\HookContainer\HookContainer;
use MediaWiki\JobQueue\JobQueueGroupFactory;
use MediaWiki\Permissions\GroupPermissionsLookup;
use MediaWiki\User\TempUser\TempUserConfig;
use Psr\Log\LoggerInterface;
use Wikimedia\Rdbms\ILBFactory;
use Wikimedia\Rdbms\ReadOnlyMode;
 
class UserGroupManagerFactory {
    private ServiceOptions $options;
    private ReadOnlyMode $readOnlyMode;
    private ILBFactory $dbLoadBalancerFactory;
    private UserEditTracker $userEditTracker;
    private GroupPermissionsLookup $groupPermissionLookup;
    private JobQueueGroupFactory $jobQueueGroupFactory;
    private LoggerInterface $logger;
 
    private $clearCacheCallbacks;
 
    private HookContainer $hookContainer;
    private TempUserConfig $tempUserConfig;
 
    public function __construct(
        ServiceOptions $options,
        ReadOnlyMode $readOnlyMode,
        ILBFactory $dbLoadBalancerFactory,
        HookContainer $hookContainer,
        UserEditTracker $userEditTracker,
        GroupPermissionsLookup $groupPermissionsLookup,
        JobQueueGroupFactory $jobQueueGroupFactory,
        LoggerInterface $logger,
        TempUserConfig $tempUserConfig,
        array $clearCacheCallbacks = []
    ) {
        $this->options = $options;
        $this->readOnlyMode = $readOnlyMode;
        $this->dbLoadBalancerFactory = $dbLoadBalancerFactory;
        $this->hookContainer = $hookContainer;
        $this->userEditTracker = $userEditTracker;
        $this->groupPermissionLookup = $groupPermissionsLookup;
        $this->jobQueueGroupFactory = $jobQueueGroupFactory;
        $this->logger = $logger;
        $this->tempUserConfig = $tempUserConfig;
        $this->clearCacheCallbacks = $clearCacheCallbacks;
    }
 
    public function getUserGroupManager( $wikiId = UserIdentity::LOCAL ): UserGroupManager {
        if ( is_string( $wikiId ) && $this->dbLoadBalancerFactory->getLocalDomainID() === $wikiId ) {
            $wikiId = UserIdentity::LOCAL;
        }
 
        // TODO: Once UserRightsProxy is removed, cache the instance per wiki.
        return new UserGroupManager(
            $this->options,
            $this->readOnlyMode,
            $this->dbLoadBalancerFactory,
            $this->hookContainer,
            $this->userEditTracker,
            $this->groupPermissionLookup,
            $this->jobQueueGroupFactory->makeJobQueueGroup( $wikiId ),
            $this->logger,
            $this->tempUserConfig,
            $this->clearCacheCallbacks,
            $wikiId
        );
    }
}