includes/title/ImportTitleFactory.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  * Represents an object that can convert page titles on a foreign wiki
  24  * (ForeignTitle objects) into page titles on the local wiki (Title objects).
  25  */
  26 interface ImportTitleFactory {
  27         /**
  28          * Determines which local title best corresponds to the given foreign title.
  29          * If such a title can't be found or would be locally invalid, null is
  30          * returned.
  31          *
  32          * @param ForeignTitle $foreignTitle The ForeignTitle to convert
  33          * @return Title|null
  34          */
  35         public function createTitleFromForeignTitle( ForeignTitle $foreignTitle );
  36 }