includes/specialpage/SpecialRedirectToSpecial.php

   1 <?php
   2 /**
   3  * Shortcuts to construct a special page alias.
   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 use MediaWiki\Title\Title;
  27
  28 /**
  29  * @stable to extend
  30  *
  31  * @ingroup SpecialPage
  32  */
  33 abstract class SpecialRedirectToSpecial extends RedirectSpecialPage {
  34         /** @var string Name of redirect target */
  35         protected $redirName;
  36
  37         /** @var string|false Name of subpage of redirect target */
  38         protected $redirSubpage;
  39
  40         /**
  41          * @stable to call
  42          *
  43          * @param string $name
  44          * @param string $redirName
  45          * @param string|false $redirSubpage
  46          * @param array $allowedRedirectParams
  47          * @param array $addedRedirectParams
  48          */
  49         public function __construct(
  50                 $name, $redirName, $redirSubpage = false,
  51                 $allowedRedirectParams = [], $addedRedirectParams = []
  52         ) {
  53                 parent::__construct( $name );
  54                 $this->redirName = $redirName;
  55                 $this->redirSubpage = $redirSubpage;
  56                 $this->mAllowedRedirectParams = $allowedRedirectParams;
  57                 $this->mAddedRedirectParams = $addedRedirectParams;
  58         }
  59
  60         /**
  61          * @param string|null $subpage
  62          * @return Title|bool
  63          */
  64         public function getRedirect( $subpage ) {
  65                 if ( $this->redirSubpage === false ) {
  66                         return SpecialPage::getTitleFor( $this->redirName, $subpage );
  67                 }
  68
  69                 return SpecialPage::getTitleFor( $this->redirName, $this->redirSubpage );
  70         }
  71 }
  72
  73 /** @deprecated class alias since 1.41 */
  74 class_alias( SpecialRedirectToSpecial::class, 'SpecialRedirectToSpecial' );