includes/title/SubpageImportTitleFactory.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  */
  20
  21 use MediaWiki\MediaWikiServices;
  22
  23 /**
  24  * A class to convert page titles on a foreign wiki (ForeignTitle objects) into
  25  * page titles on the local wiki (Title objects), placing all pages as subpages
  26  * of a given root page.
  27  */
  28 class SubpageImportTitleFactory implements ImportTitleFactory {
  29         /** @var Title */
  30         protected $rootPage;
  31
  32         /**
  33          * @param Title $rootPage The root page under which all pages should be
  34          * created
  35          */
  36         public function __construct( Title $rootPage ) {
  37                 if (
  38                         !MediaWikiServices::getInstance()->getNamespaceInfo()->
  39                                 hasSubpages( $rootPage->getNamespace() )
  40                 ) {
  41                         throw new MWException( "The root page you specified, $rootPage, is in a " .
  42                                 "namespace where subpages are not allowed" );
  43                 }
  44                 $this->rootPage = $rootPage;
  45         }
  46
  47         /**
  48          * Determines which local title best corresponds to the given foreign title.
  49          * If such a title can't be found or would be locally invalid, null is
  50          * returned.
  51          *
  52          * @param ForeignTitle $foreignTitle The ForeignTitle to convert
  53          * @return Title|null
  54          */
  55         public function createTitleFromForeignTitle( ForeignTitle $foreignTitle ) {
  56                 return Title::newFromText( $this->rootPage->getPrefixedDBkey() . '/' .
  57                         $foreignTitle->getFullText() );
  58         }
  59 }