TitleValue Class Reference

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

Inheritance diagram for TitleValue:

Collaboration diagram for TitleValue:

Public Member Functions
	__construct ( $namespace, $dbkey, $fragment='', $interwiki='')
	Constructs a TitleValue.
	__toString ()
	Returns a string representation of the title, for logging.
	createFragmentTarget ( $fragment)
	Creates a new TitleValue for a different fragment of the same page.
	getDBkey ()
	Returns the title's DB key, as supplied to the constructor, without namespace prefix or fragment.
	getFragment ()
	getInterwiki ()
	Returns the interwiki part.
	getNamespace ()
	getText ()
	Returns the title in text form, without namespace prefix or fragment.
	hasFragment ()
	inNamespace ( $ns)
	isExternal ()
	Whether it has an interwiki part.

Protected Attributes
string	$dbkey
string	$fragment
string	$interwiki
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.

See also

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

Since

1.23

Definition at line 35 of file TitleValue.php.

Constructor & Destructor Documentation

__construct()

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

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

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

Exceptions

InvalidArgumentException

Definition at line 78 of file TitleValue.php.

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.

Since

1.23

Returns

string

Implements MediaWiki\Linker\LinkTarget.

Definition at line 200 of file TitleValue.php.

References $name.

createFragmentTarget()

TitleValue::createFragmentTarget

(

$fragment

)

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

Since

1.27

Parameters

string

$fragment

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

Returns

TitleValue

Implements MediaWiki\Linker\LinkTarget.

Definition at line 163 of file TitleValue.php.

getDBkey()

TitleValue::getDBkey

(

)

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

Since

1.23

Returns

string

Implements MediaWiki\Linker\LinkTarget.

Definition at line 135 of file TitleValue.php.

Referenced by getText().

getFragment()

TitleValue::getFragment

(

)

Since

1.23

Returns

string

Implements MediaWiki\Linker\LinkTarget.

Definition at line 116 of file TitleValue.php.

getInterwiki()

TitleValue::getInterwiki

(

)

Returns the interwiki part.

Since

1.27

Returns

string

Implements MediaWiki\Linker\LinkTarget.

Definition at line 188 of file TitleValue.php.

getNamespace()

TitleValue::getNamespace

(

)

Since

1.23

Returns

int

Implements MediaWiki\Linker\LinkTarget.

Definition at line 99 of file TitleValue.php.

getText()

TitleValue::getText

(

)

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

Since

1.23

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

Implements MediaWiki\Linker\LinkTarget.

Definition at line 151 of file TitleValue.php.

References getDBkey().

hasFragment()

TitleValue::hasFragment

(

)

Since

1.27

Returns

bool

Implements MediaWiki\Linker\LinkTarget.

Definition at line 124 of file TitleValue.php.

inNamespace()

TitleValue::inNamespace

(

$ns

)

Since

1.27

Parameters

int

$ns

Returns

bool

Implements MediaWiki\Linker\LinkTarget.

Definition at line 108 of file TitleValue.php.

isExternal()

TitleValue::isExternal

(

)

Whether it has an interwiki part.

Since

1.27

Returns

bool

Implements MediaWiki\Linker\LinkTarget.

Definition at line 178 of file TitleValue.php.

Member Data Documentation

$dbkey

string TitleValue::$dbkey

protected

Deprecated

in 1.31. This class is immutable. Use the getter for access.

Definition at line 47 of file TitleValue.php.

$fragment

string TitleValue::$fragment

protected

Deprecated

in 1.31. This class is immutable. Use the getter for access.

Definition at line 53 of file TitleValue.php.

$interwiki

string TitleValue::$interwiki

protected

Deprecated

in 1.31. This class is immutable. Use the getter for access.

Definition at line 59 of file TitleValue.php.

$namespace

int TitleValue::$namespace

protected

Deprecated

in 1.31. This class is immutable. Use the getter for access.

Definition at line 41 of file TitleValue.php.

---

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

• includes/title/TitleValue.php