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