Don't rely on $wgTitle in WebRequest
[mediawiki.git] / includes / title / TitleParser.php
blob0635ee86af467237bce92a4930ca9fcd99281a33
1 <?php
2 /**
3 * A title parser service for %MediaWiki.
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.
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.
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
20 * @file
21 * @license GPL 2+
22 * @author Daniel Kinzler
25 /**
26 * A title parser service for %MediaWiki.
28 * This is designed to encapsulate knowledge about conventions for the title
29 * forms to be used in the database, in urls, in wikitext, etc.
31 * @see https://www.mediawiki.org/wiki/Requests_for_comment/TitleValue
33 interface TitleParser {
34 /**
35 * Parses the given text and constructs a TitleValue. Normalization
36 * is applied according to the rules appropriate for the form specified by $form.
38 * @note this only parses local page links, interwiki-prefixes etc. are not considered!
40 * @param string $text The text to parse
41 * @param int $defaultNamespace Namespace to assume per default (usually NS_MAIN)
43 * @throws MalformedTitleException If the text is not a valid representation of a page title.
44 * @return TitleValue
46 public function parseTitle( $text, $defaultNamespace );