TitleValue Class Reference

Represents a page (or page fragment) title within MediaWiki. More...

Collaboration diagram for TitleValue:

Public Member Functions
	__construct ( $namespace, $dbkey, $fragment='')
	Constructs a TitleValue. More...
	__toString ()
	Returns a string representation of the title, for logging. More...
	createFragmentTitle ( $fragment)
	Creates a new TitleValue for a different fragment of the same page. More...
	getDBkey ()
	Returns the title's DB key, as supplied to the constructor, without namespace prefix or fragment. More...
	getFragment ()
	getNamespace ()
	getText ()
	Returns the title in text form, without namespace prefix or fragment. More...

Protected Attributes
string	$dbkey
string	$fragment
int	$namespace

Detailed Description

Represents a page (or page fragment) title within MediaWiki.

Note

In contrast to Title, this is designed to be a plain value object. That is, it is immutable, does not use global state, and causes no side effects.

TitleValue represents the title of a local page (or fragment of a page). It does not represent a link, and does not support interwiki prefixes etc.

See also

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

Definition at line 36 of file TitleValue.php.

Constructor & Destructor Documentation

__construct()

TitleValue::__construct	(		$namespace,
			$dbkey,
			$fragment = ''
	)

Constructs a TitleValue.

Note

: TitleValue expects a valid DB key; typically, a TitleValue is constructed either from a database entry, or by a TitleParser. We could apply "some" normalization here, such as substituting spaces by underscores, but that would encourage the use of un-normalized text when constructing TitleValues. For constructing a TitleValue from user input or external sources, use a TitleParser.

Parameters

$namespace	int The namespace ID. This is not validated.
$dbkey	string The page title in valid DBkey form. No normalization is applied.
$fragment	string The fragment title. Use '' to represent the whole page. No validation or normalization is applied.

Exceptions

InvalidArgumentException

Definition at line 66 of file TitleValue.php.

References $dbkey, $fragment, and $namespace.

Member Function Documentation

__toString()

TitleValue::__toString

(

)

Returns a string representation of the title, for logging.

This is purely informative and must not be used programmatically. Use the appropriate TitleFormatter to generate the correct string representation for a given use.

Returns

string

Definition at line 150 of file TitleValue.php.

References $fragment, $name, and if.

createFragmentTitle()

TitleValue::createFragmentTitle

(

$fragment

)

Creates a new TitleValue for a different fragment of the same page.

Parameters

string

$fragment

The fragment name, or "" for the entire page.

Returns

TitleValue

Definition at line 139 of file TitleValue.php.

References $fragment.

getDBkey()

TitleValue::getDBkey

(

)

Returns the title's DB key, as supplied to the constructor, without namespace prefix or fragment.

Returns

string

Definition at line 113 of file TitleValue.php.

References $dbkey.

Referenced by getText().

getFragment()

TitleValue::getFragment

(

)

Returns

string

Definition at line 103 of file TitleValue.php.

References $fragment.

Referenced by MediaWikiPageLinkRenderer\getPageUrl(), and Title\newFromTitleValue().

getNamespace()

TitleValue::getNamespace

(

)

Returns

int

Definition at line 96 of file TitleValue.php.

References $namespace.

Referenced by MediaWikiTitleCodec\getFullText(), MediaWikiTitleCodec\getPrefixedText(), and Title\newFromTitleValue().

getText()

TitleValue::getText

(

)

Returns the title in text form, without namespace prefix or fragment.

This is computed from the DB key by replacing any underscores with spaces.

Note

: To get a title string that includes the namespace and/or fragment, use a TitleFormatter.

Returns

string

Definition at line 128 of file TitleValue.php.

References getDBkey().

Referenced by MediaWikiTitleCodec\getText(), and Title\newFromTitleValue().

Member Data Documentation

$dbkey

string TitleValue::$dbkey

protected

Definition at line 44 of file TitleValue.php.

Referenced by __construct(), and getDBkey().

$fragment

string TitleValue::$fragment

protected

Definition at line 48 of file TitleValue.php.

Referenced by __construct(), __toString(), createFragmentTitle(), and getFragment().

$namespace

int TitleValue::$namespace

protected

Definition at line 40 of file TitleValue.php.

Referenced by __construct(), and getNamespace().

---

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

• includes/title/TitleValue.php