includes/title/TitleParser.php

   1 <?php
   2 /**
   3  * A title parser service for %MediaWiki.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @author Daniel Kinzler
  22  */
  23
  24 /**
  25  * A title parser service for %MediaWiki.
  26  *
  27  * This is designed to encapsulate knowledge about conventions for the title
  28  * forms to be used in the database, in urls, in wikitext, etc.
  29  *
  30  * @see https://www.mediawiki.org/wiki/Requests_for_comment/TitleValue
  31  * @since 1.23
  32  */
  33 interface TitleParser {
  34         /**
  35          * Parses the given text and constructs a TitleValue.
  36          *
  37          * @note this only parses local page links, interwiki-prefixes etc. are not considered!
  38          *
  39          * @param string $text The text to parse
  40          * @param int $defaultNamespace Namespace to assume per default (usually NS_MAIN)
  41          *
  42          * @throws MalformedTitleException If the text is not a valid representation of a page title.
  43          * @return TitleValue
  44          */
  45         public function parseTitle( $text, $defaultNamespace = NS_MAIN );
  46
  47         /**
  48          * Given a namespace and title, return a TitleValue if valid, or null if invalid.
  49          *
  50          * @param int $namespace
  51          * @param string $text
  52          * @param string $fragment
  53          * @param string $interwiki
  54          *
  55          * @return TitleValue|null
  56          */
  57         public function makeTitleValueSafe( $namespace, $text, $fragment = '', $interwiki = '' );
  58 }