A codec for MediaWiki page titles. More...

Inheritance diagram for MediaWikiTitleCodec:

[legend]

Collaboration diagram for MediaWikiTitleCodec:

[legend]

Public Member Functions
	__construct (Language $language, GenderCache $genderCache, $localInterwikis=[], $interwikiLookup=null)

	formatTitle ( $namespace, $text, $fragment='', $interwiki='')

	getFullText (LinkTarget $title)

	getNamespaceName ( $namespace, $text)

	getPrefixedDBkey (LinkTarget $target)

	getPrefixedText (LinkTarget $title)

	getText (LinkTarget $title)

	parseTitle ( $text, $defaultNamespace=NS_MAIN)
	Parses the given text and constructs a TitleValue.

	splitTitleString ( $text, $defaultNamespace=NS_MAIN)
	Normalizes and splits a title string.

Static Public Member Functions
static	getTitleInvalidRegex ()
	Returns a simple regex that will match on characters and sequences invalid in titles.

Protected Attributes
GenderCache	$genderCache

InterwikiLookup	$interwikiLookup

Language	$language

string[]	$localInterwikis

Detailed Description

A codec for MediaWiki page titles.

Note: Normalization and validation is applied while parsing, not when formatting. It's possible to construct a TitleValue with an invalid title, and use MediaWikiTitleCodec to generate an (invalid) title string from it. TitleValues should be constructed only via parseTitle() or from a (semi)trusted source, such as the database.

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

Since: 1.23

Definition at line 38 of file MediaWikiTitleCodec.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWikiTitleCodec::__construct	(	Language	$language,
		GenderCache	$genderCache,
			$localInterwikis = `[]`,
			$interwikiLookup = `null`
	)

Parameters

Language	$language	The language object to use for localizing namespace names.
GenderCache	$genderCache	The gender cache for generating gendered namespace names
string[] \| string	$localInterwikis
InterwikiLookup \| null	$interwikiLookup

Definition at line 65 of file MediaWikiTitleCodec.php.

References $genderCache, $interwikiLookup, $language, $localInterwikis, and array().

Member Function Documentation

◆ formatTitle()

MediaWikiTitleCodec::formatTitle	(	$namespace,
		$text,
		$fragment = `''`,
		$interwiki = `''`
	)

See also: TitleFormatter::formatTitle()

Parameters

int \| bool	$namespace	The namespace ID (or false, if the namespace should be ignored)
string	$text	The page title. Should be valid. Only minimal normalization is applied. Underscores will be replaced.
string	$fragment	The fragment name (may be empty).
string	$interwiki	The interwiki name (may be empty).

Exceptions

InvalidArgumentException If the namespace is invalid

Returns: string

Implements TitleFormatter.

Definition at line 114 of file MediaWikiTitleCodec.php.

References $e, $out, getNamespaceName(), and NS_SPECIAL.

Referenced by getFullText(), getPrefixedDBkey(), and getPrefixedText().

◆ getFullText()

MediaWikiTitleCodec::getFullText ( LinkTarget $title )

See also: TitleFormatter::getText()

Parameters

LinkTarget $title

Returns: string

Implements TitleFormatter.

Definition at line 223 of file MediaWikiTitleCodec.php.

References $title, formatTitle(), and MediaWiki\Linker\LinkTarget\getNamespace().

◆ getNamespaceName()

MediaWikiTitleCodec::getNamespaceName	(	$namespace,
		$text
	)

See also: TitleFormatter::getNamespaceName()

Parameters

int	$namespace
string	$text

Exceptions

InvalidArgumentException If the namespace is invalid

Returns: string Namespace name with underscores (not spaces)

Implements TitleFormatter.

Definition at line 84 of file MediaWikiTitleCodec.php.

References $name.

Referenced by formatTitle().

◆ getPrefixedDBkey()

MediaWikiTitleCodec::getPrefixedDBkey ( LinkTarget $target )

Since: 1.27

See also: TitleFormatter::getPrefixedDBkey()

Parameters

LinkTarget $target

Returns: string

Implements TitleFormatter.

Definition at line 207 of file MediaWikiTitleCodec.php.

References formatTitle(), MediaWiki\Linker\LinkTarget\getDBkey(), MediaWiki\Linker\LinkTarget\getInterwiki(), and MediaWiki\Linker\LinkTarget\getNamespace().

◆ getPrefixedText()

MediaWikiTitleCodec::getPrefixedText ( LinkTarget $title )

See also: TitleFormatter::getText()

Parameters

LinkTarget $title

Returns: string

Implements TitleFormatter.

Definition at line 188 of file MediaWikiTitleCodec.php.

References $title, formatTitle(), and MediaWiki\Linker\LinkTarget\getNamespace().

◆ getText()

MediaWikiTitleCodec::getText ( LinkTarget $title )

See also: TitleFormatter::getText()

Parameters

LinkTarget $title

Returns: string $title->getText()

Implements TitleFormatter.

Definition at line 177 of file MediaWikiTitleCodec.php.

References $title.

◆ getTitleInvalidRegex()

static MediaWikiTitleCodec::getTitleInvalidRegex ( )

static

Returns a simple regex that will match on characters and sequences invalid in titles.

Note that this doesn't pick up many things that could be wrong with titles, but that replacing this regex with something valid will make many titles valid. Previously Title::getTitleInvalidRegex()

Returns: string Regex string

Since: 1.25

Definition at line 460 of file MediaWikiTitleCodec.php.

References is.

Referenced by Language\isValidCode(), and splitTitleString().

◆ parseTitle()

MediaWikiTitleCodec::parseTitle	(	$text,
		$defaultNamespace = `NS_MAIN`
	)

Parses the given text and constructs a TitleValue.

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

Parameters

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

Exceptions

MalformedTitleException

Returns: TitleValue

Implements TitleParser.

Definition at line 151 of file MediaWikiTitleCodec.php.

References splitTitleString().

◆ splitTitleString()

MediaWikiTitleCodec::splitTitleString	(	$text,
		$defaultNamespace = `NS_MAIN`
	)

Normalizes and splits a title string.

This function removes illegal characters, splits off the interwiki and namespace prefixes, sets the other forms, and canonicalizes everything.

Todo:: this method is only exposed as a temporary measure to ease refactoring. It was copied with minimal changes from Title::secureAndSplit().

Todo:: This method should be split up and an appropriate interface defined for use by the Title class.

Parameters

string	$text
int	$defaultNamespace

Exceptions

MalformedTitleException If $text is not a valid title string.

Returns: array A map with the fields 'interwiki', 'fragment', 'namespace', 'user_case_dbkey', and 'dbkey'.

Definition at line 252 of file MediaWikiTitleCodec.php.

References $matches, as, getTitleInvalidRegex(), NS_MAIN, NS_SPECIAL, NS_TALK, NS_USER, NS_USER_TALK, and processing.

Referenced by parseTitle().

Member Data Documentation

◆ $genderCache

GenderCache MediaWikiTitleCodec::$genderCache

protected

Definition at line 47 of file MediaWikiTitleCodec.php.

Referenced by __construct().

◆ $interwikiLookup

InterwikiLookup MediaWikiTitleCodec::$interwikiLookup

protected

Definition at line 57 of file MediaWikiTitleCodec.php.

Referenced by __construct().

◆ $language

Language MediaWikiTitleCodec::$language

protected

Definition at line 42 of file MediaWikiTitleCodec.php.

Referenced by __construct().

◆ $localInterwikis

string [] MediaWikiTitleCodec::$localInterwikis

protected

Definition at line 52 of file MediaWikiTitleCodec.php.

Referenced by __construct().

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

includes/title/MediaWikiTitleCodec.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ formatTitle()

◆ getFullText()

◆ getNamespaceName()

◆ getPrefixedDBkey()

◆ getPrefixedText()

◆ getText()

◆ getTitleInvalidRegex()

◆ parseTitle()

◆ splitTitleString()

Member Data Documentation

◆ $genderCache

◆ $interwikiLookup

◆ $language

◆ $localInterwikis