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