includes/title/NamespaceImportTitleFactory.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 in a fixed
  25  * local namespace.
  26  */
  27 class NamespaceImportTitleFactory implements ImportTitleFactory {
  28         /** @var int */
  29         protected $ns;
  30
  31         /**
  32          * @param int $ns The namespace to use for all pages
  33          */
  34         public function __construct( $ns ) {
  35                 if ( !MWNamespace::exists( $ns ) ) {
  36                         throw new MWException( "Namespace $ns doesn't exist on this wiki" );
  37                 }
  38                 $this->ns = $ns;
  39         }
  40
  41         /**
  42          * Determines which local title best corresponds to the given foreign title.
  43          * If such a title can't be found or would be locally invalid, null is
  44          * returned.
  45          *
  46          * @param ForeignTitle $foreignTitle The ForeignTitle to convert
  47          * @return Title|null
  48          */
  49         public function createTitleFromForeignTitle( ForeignTitle $foreignTitle ) {
  50                 return Title::makeTitleSafe( $this->ns, $foreignTitle->getText() );
  51         }
  52 }