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  * @license GPL 2+
  20  */
  21
  22 /**
  23  * A class to convert page titles on a foreign wiki (ForeignTitle objects) into
  24  * page titles on the local wiki (Title objects), placing all pages as subpages
  25  * of a given root page.
  26  */
  27 class SubpageImportTitleFactory implements ImportTitleFactory {
  28         /** @var Title */
  29         protected $rootPage;
  30
  31         /**
  32          * @param Title $rootPage The root page under which all pages should be
  33          * created
  34          */
  35         public function __construct( Title $rootPage ) {
  36                 if ( !MWNamespace::hasSubpages( $rootPage->getNamespace() ) ) {
  37                         throw new MWException( "The root page you specified, $rootPage, is in a " .
  38                                 "namespace where subpages are not allowed" );
  39                 }
  40                 $this->rootPage = $rootPage;
  41         }
  42
  43         /**
  44          * Determines which local title best corresponds to the given foreign title.
  45          * If such a title can't be found or would be locally invalid, null is
  46          * returned.
  47          *
  48          * @param ForeignTitle $foreignTitle The ForeignTitle to convert
  49          * @return Title|null
  50          */
  51         public function createTitleFromForeignTitle( ForeignTitle $foreignTitle ) {
  52                 return Title::newFromText( $this->rootPage->getPrefixedDBkey() . '/' .
  53                         $foreignTitle->getFullText() );
  54         }
  55 }