TitleParser Interface Reference

A title parser service for MediaWiki. More...

Inheritance diagram for TitleParser:

List of all members.

Public Member Functions
	parseTitle ($text, $defaultNamespace)
	Parses the given text and constructs a TitleValue.

---

Detailed Description

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 also:

https://www.mediawiki.org/wiki/Requests_for_comment/TitleValue

Definition at line 33 of file TitleParser.php.

---

Member Function Documentation

TitleParser::parseTitle	(	$	text,
		$	defaultNamespace
	)

Parses the given text and constructs a TitleValue.

Normalization is applied according to the rules appropriate for the form specified by $form.

Note:

this only parses local page links, interwiki-prefixes etc. are not considered!

Parameters:

string	$text	The text to parse
int	$defaultNamespace	Namespace to assume per default (usually NS_MAIN)

Exceptions:

MalformedTitleException

If the text is not a valid representation of a page title.

Returns:

TitleValue

Implemented in MediaWikiTitleCodec.

---

The documentation for this interface was generated from the following file:

• includes/title/TitleParser.php