includes/specials/SpecialListUsers.php

   1 <?php
   2 /**
   3  * Implements Special:Listusers
   4  *
   5  * Copyright © 2004 Brion Vibber, lcrocker, Tim Starling,
   6  * Domas Mituzas, Antoine Musso, Jens Frank, Zhengzhu,
   7  * 2006 Rob Church <robchur@gmail.com>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  *
  24  * @file
  25  * @ingroup SpecialPage
  26  */
  27
  28 /**
  29  * @ingroup SpecialPage
  30  */
  31 class SpecialListUsers extends IncludableSpecialPage {
  32
  33         public function __construct() {
  34                 parent::__construct( 'Listusers' );
  35         }
  36
  37         /**
  38          * @param string|null $par (optional) A group to list users from
  39          */
  40         public function execute( $par ) {
  41                 $this->setHeaders();
  42                 $this->outputHeader();
  43
  44                 $up = new UsersPager( $this->getContext(), $par, $this->including() );
  45
  46                 # getBody() first to check, if empty
  47                 $usersbody = $up->getBody();
  48
  49                 $s = '';
  50                 if ( !$this->including() ) {
  51                         $s = $up->getPageHeader();
  52                 }
  53
  54                 if ( $usersbody ) {
  55                         $s .= $up->getNavigationBar();
  56                         $s .= Html::rawElement( 'ul', [], $usersbody );
  57                         $s .= $up->getNavigationBar();
  58                 } else {
  59                         $s .= $this->msg( 'listusers-noresult' )->parseAsBlock();
  60                 }
  61
  62                 $out = $this->getOutput();
  63                 $out->addHTML( $s );
  64                 $out->addModuleStyles( 'mediawiki.interface.helpers.styles' );
  65         }
  66
  67         /**
  68          * Return an array of subpages that this special page will accept.
  69          *
  70          * @return string[] subpages
  71          */
  72         public function getSubpagesForPrefixSearch() {
  73                 return User::getAllGroups();
  74         }
  75
  76         protected function getGroupName() {
  77                 return 'users';
  78         }
  79 }