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 namespace MediaWiki\Title;
  22
  23 use InvalidArgumentException;
  24
  25 /**
  26  * A class to convert page titles on a foreign wiki (ForeignTitle objects) into
  27  * page titles on the local wiki (Title objects), placing all pages as subpages
  28  * of a given root page.
  29  */
  30 class SubpageImportTitleFactory implements ImportTitleFactory {
  31         private TitleFactory $titleFactory;
  32         private Title $rootPage;
  33
  34         /**
  35          * @param NamespaceInfo $namespaceInfo
  36          * @param TitleFactory $titleFactory
  37          * @param Title $rootPage The root page under which all pages should be created
  38          */
  39         public function __construct(
  40                 NamespaceInfo $namespaceInfo,
  41                 TitleFactory $titleFactory,
  42                 Title $rootPage
  43         ) {
  44                 if ( !$namespaceInfo->hasSubpages( $rootPage->getNamespace() ) ) {
  45                         throw new InvalidArgumentException( "The root page you specified, $rootPage, is in a " .
  46                                 "namespace where subpages are not allowed" );
  47                 }
  48                 $this->titleFactory = $titleFactory;
  49                 $this->rootPage = $rootPage;
  50         }
  51
  52         /**
  53          * Determines which local title best corresponds to the given foreign title.
  54          * If such a title can't be found or would be locally invalid, null is
  55          * returned.
  56          *
  57          * @param ForeignTitle $foreignTitle The ForeignTitle to convert
  58          * @return Title|null
  59          */
  60         public function createTitleFromForeignTitle( ForeignTitle $foreignTitle ) {
  61                 return $this->titleFactory->newFromText(
  62                         $this->rootPage->getPrefixedDBkey() . '/' . $foreignTitle->getFullText()
  63                 );
  64         }
  65 }
  66
  67 /** @deprecated class alias since 1.41 */
  68 class_alias( SubpageImportTitleFactory::class, 'SubpageImportTitleFactory' );