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  * @license GPL 2+
  20  */
  21
  22 /**
  23  * A parser that translates page titles into ForeignTitle objects.
  24  */
  25 interface ForeignTitleFactory {
  26         /**
  27          * Creates a ForeignTitle object based on the page title, and optionally the
  28          * namespace ID, of a page on a foreign wiki. These values could be, for
  29          * example, the <title> and <ns> attributes found in an XML dump.
  30          *
  31          * @param string $title The page title
  32          * @param int|null $ns The namespace ID, or null if this data is not available
  33          * @return ForeignTitle
  34          */
  35         public function createForeignTitle( $title, $ns = null );
  36 }