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 namespace MediaWiki\Title;
  25
  26 /**
  27  * A title parser service for %MediaWiki.
  28  *
  29  * This is designed to encapsulate knowledge about conventions for the title
  30  * forms to be used in the database, in urls, in wikitext, etc.
  31  *
  32  * @see https://www.mediawiki.org/wiki/Requests_for_comment/TitleValue
  33  * @since 1.23
  34  */
  35 interface TitleParser {
  36         /**
  37          * Parses the given text and constructs a TitleValue.
  38          *
  39          * @note this only parses local page links, interwiki-prefixes etc. are not considered!
  40          *
  41          * @param string $text The text to parse
  42          * @param int $defaultNamespace Namespace to assume by default (usually NS_MAIN)
  43          *
  44          * @throws MalformedTitleException If the text is not a valid representation of a page title.
  45          * @return TitleValue
  46          */
  47         public function parseTitle( $text, $defaultNamespace = NS_MAIN );
  48
  49         /**
  50          * Given a namespace and title, return a TitleValue if valid, or null if invalid.
  51          *
  52          * @param int $namespace
  53          * @param string $text
  54          * @param string $fragment
  55          * @param string $interwiki
  56          *
  57          * @return TitleValue|null
  58          */
  59         public function makeTitleValueSafe( $namespace, $text, $fragment = '', $interwiki = '' );
  60 }
  61
  62 /** @deprecated class alias since 1.41 */
  63 class_alias( TitleParser::class, 'TitleParser' );