includes/title/ForeignTitleFactory.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 /**
  24  * A parser that translates page titles into ForeignTitle objects.
  25  */
  26 interface ForeignTitleFactory {
  27         /**
  28          * Create a ForeignTitle object.
  29          *
  30          * Based on the page title and optionally the namespace ID, of a page on a foreign wiki.
  31          * These values could be, for example, the `<title>` and `<ns>` attributes found in an
  32          * XML dump.
  33          *
  34          * @param string $title The page title
  35          * @param int|null $ns The namespace ID, or null if this data is not available
  36          * @return ForeignTitle
  37          */
  38         public function createForeignTitle( $title, $ns = null );
  39 }
  40
  41 /** @deprecated class alias since 1.41 */
  42 class_alias( ForeignTitleFactory::class, 'ForeignTitleFactory' );