includes/specialpage/UnlistedSpecialPage.php

   1 <?php
   2 /**
   3  * Shortcut to construct a special page which is unlisted by default.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup SpecialPage
  22  */
  23
  24 namespace MediaWiki\SpecialPage;
  25
  26 /**
  27  * Shortcut to construct a special page which is unlisted by default.
  28  *
  29  * @stable to extend
  30  *
  31  * @ingroup SpecialPage
  32  */
  33 class UnlistedSpecialPage extends SpecialPage {
  34
  35         /**
  36          * @stable to call
  37          *
  38          * @param string $name
  39          * @param string $restriction
  40          * @param bool $function
  41          * @param string $file
  42          */
  43         public function __construct( $name, $restriction = '', $function = false, $file = 'default' ) {
  44                 parent::__construct( $name, $restriction, false, $function, $file );
  45         }
  46
  47         public function isListed() {
  48                 return false;
  49         }
  50 }
  51
  52 /** @deprecated class alias since 1.41 */
  53 class_alias( UnlistedSpecialPage::class, 'UnlistedSpecialPage' );