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 /**
  25  * @ingroup SpecialPage
  26  */
  27 abstract class SpecialRedirectToSpecial extends RedirectSpecialPage {
  28         /** @var string Name of redirect target */
  29         protected $redirName;
  30
  31         /** @var string Name of subpage of redirect target */
  32         protected $redirSubpage;
  33
  34         function __construct(
  35                 $name, $redirName, $redirSubpage = false,
  36                 $allowedRedirectParams = [], $addedRedirectParams = []
  37         ) {
  38                 parent::__construct( $name );
  39                 $this->redirName = $redirName;
  40                 $this->redirSubpage = $redirSubpage;
  41                 $this->mAllowedRedirectParams = $allowedRedirectParams;
  42                 $this->mAddedRedirectParams = $addedRedirectParams;
  43         }
  44
  45         /**
  46          * @param string|null $subpage
  47          * @return Title|bool
  48          */
  49         public function getRedirect( $subpage ) {
  50                 if ( $this->redirSubpage === false ) {
  51                         return SpecialPage::getTitleFor( $this->redirName, $subpage );
  52                 }
  53
  54                 return SpecialPage::getTitleFor( $this->redirName, $this->redirSubpage );
  55         }
  56 }