SpecialListUsers.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Specials;
 
use MediaWiki\Block\HideUserUtils;
use MediaWiki\Cache\LinkBatchFactory;
use MediaWiki\Html\Html;
use MediaWiki\Pager\UsersPager;
use MediaWiki\SpecialPage\IncludableSpecialPage;
use MediaWiki\User\UserGroupManager;
use MediaWiki\User\UserIdentityLookup;
use Wikimedia\Rdbms\IConnectionProvider;
 
class SpecialListUsers extends IncludableSpecialPage {
 
    private LinkBatchFactory $linkBatchFactory;
    private IConnectionProvider $dbProvider;
    private UserGroupManager $userGroupManager;
    private UserIdentityLookup $userIdentityLookup;
    private HideUserUtils $hideUserUtils;
 
    public function __construct(
        LinkBatchFactory $linkBatchFactory,
        IConnectionProvider $dbProvider,
        UserGroupManager $userGroupManager,
        UserIdentityLookup $userIdentityLookup,
        HideUserUtils $hideUserUtils
    ) {
        parent::__construct( 'Listusers' );
        $this->linkBatchFactory = $linkBatchFactory;
        $this->dbProvider = $dbProvider;
        $this->userGroupManager = $userGroupManager;
        $this->userIdentityLookup = $userIdentityLookup;
        $this->hideUserUtils = $hideUserUtils;
    }
 
    public function execute( $par ) {
        $this->setHeaders();
        $this->outputHeader();
 
        $up = new UsersPager(
            $this->getContext(),
            $this->getHookContainer(),
            $this->linkBatchFactory,
            $this->dbProvider,
            $this->userGroupManager,
            $this->userIdentityLookup,
            $this->hideUserUtils,
            $par,
            $this->including()
        );
 
        # getBody() first to check, if empty
        $usersbody = $up->getBody();
 
        $s = '';
        if ( !$this->including() ) {
            $s = $up->getPageHeader();
        }
 
        if ( $usersbody ) {
            $s .= $up->getNavigationBar();
            $s .= Html::rawElement( 'ul', [], $usersbody );
            $s .= $up->getNavigationBar();
        } else {
            $s .= $this->msg( 'listusers-noresult' )->parseAsBlock();
        }
 
        $out = $this->getOutput();
        $out->addHTML( $s );
        $out->addModuleStyles( 'mediawiki.interface.helpers.styles' );
    }
 
    public function getSubpagesForPrefixSearch() {
        return $this->userGroupManager->listAllGroups();
    }
 
    protected function getGroupName() {
        return 'users';
    }
}
 
class_alias( SpecialListUsers::class, 'SpecialListUsers' );