Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 21
0.00% covered (danger)
0.00%
0 / 2
CRAP
0.00% covered (danger)
0.00%
0 / 1
EmptyUserGroup
0.00% covered (danger)
0.00%
0 / 18
0.00% covered (danger)
0.00%
0 / 2
42
0.00% covered (danger)
0.00%
0 / 1
 __construct
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
2
 execute
0.00% covered (danger)
0.00%
0 / 14
0.00% covered (danger)
0.00%
0 / 1
30
1<?php
2
3/**
4 * Removes all users from a given user group.
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 * http://www.gnu.org/copyleft/gpl.html
20 *
21 * @file
22 * @ingroup Maintenance
23 */
24
25use MediaWiki\User\User;
26
27require_once __DIR__ . '/Maintenance.php';
28
29class EmptyUserGroup extends Maintenance {
30    public function __construct() {
31        parent::__construct();
32        $this->addDescription( 'Remove all users from a given user group' );
33        $this->addArg( 'group', 'Group to be removed', true );
34        $this->setBatchSize( 100 );
35    }
36
37    public function execute() {
38        $group = $this->getArg( 0 );
39        $userGroupManager = $this->getServiceContainer()->getUserGroupManager();
40
41        $totalCount = 0;
42        $this->output( "Removing users from $group...\n" );
43        while ( true ) {
44            $users = User::findUsersByGroup( $group, $this->getBatchSize() );
45            if ( iterator_count( $users ) === 0 ) {
46                break;
47            }
48
49            foreach ( $users as $user ) {
50                $totalCount += (int)$userGroupManager->removeUserFromGroup( $user, $group );
51            }
52            $this->waitForReplication();
53        }
54        if ( $totalCount ) {
55            $this->output( "  ...done! Removed $totalCount users in total.\n" );
56        } else {
57            $this->output( "  ...nothing to do, group was empty.\n" );
58        }
59    }
60}
61
62$maintClass = EmptyUserGroup::class;
63require_once RUN_MAINTENANCE_IF_MAIN;