MediaWiki  master
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, $title, $fragment='', $interwiki='')
 Constructs a TitleValue. More...
 
 __toString ()
 Returns a string representation of the title, for logging. More...
 
 createFragmentTarget ( $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 ()
 
 getInterwiki ()
 Returns the interwiki part. More...
 
 getNamespace ()
 
 getText ()
 Returns the title in text form, without namespace prefix or fragment. More...
 
 hasFragment ()
 
 inNamespace ( $ns)
 
 isExternal ()
 Whether it has an interwiki part. More...
 

Static Public Member Functions

static assertValidSpec ( $namespace, $title, $fragment='', $interwiki='')
 Asserts that the given parameters could be used to construct a TitleValue object. More...
 

Public Attributes

string $prefixedText = null
 Text form including namespace/interwiki, initialised on demand. More...
 

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 36 of file TitleValue.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructs a TitleValue.

Note
TitleValue expects a valid namespace and name; typically, a TitleValue is constructed either from a database entry, or by a TitleParser. For constructing a TitleValue from user input or external sources, use a TitleParser.
Parameters
int$namespaceThe namespace ID. This is not validated.
string$titleThe page title in either DBkey or text form. No normalization is applied beyond underscore/space conversion.
string$fragmentThe fragment title. Use '' to represent the whole page. No validation or normalization is applied.
string$interwikiThe interwiki component
Exceptions
InvalidArgumentException

Definition at line 88 of file TitleValue.php.

References $fragment, $interwiki, and $title.

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 244 of file TitleValue.php.

References $fragment, and if.

◆ assertValidSpec()

static TitleValue::assertValidSpec (   $namespace,
  $title,
  $fragment = '',
  $interwiki = '' 
)
static

Asserts that the given parameters could be used to construct a TitleValue object.

Performs basic syntax and consistency checks. Does not perform full validation, use TitleParser::makeTitleValueSafe() for that.

Parameters
int$namespace
string$title
string$fragment
string$interwiki
Exceptions
InvalidArgumentExceptionif the combination of parameters is not valid for constructing a TitleValue.

Definition at line 110 of file TitleValue.php.

References $title, and NS_MAIN.

Referenced by MediaWikiTitleCodec\splitTitleString().

◆ createFragmentTarget()

TitleValue::createFragmentTarget (   $fragment)

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

Since
1.27
Parameters
string$fragmentThe fragment name, or "" for the entire page.
Returns
TitleValue

Implements MediaWiki\Linker\LinkTarget.

Definition at line 207 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 179 of file TitleValue.php.

References $dbkey.

◆ getFragment()

TitleValue::getFragment ( )
Since
1.23
Returns
string

Implements MediaWiki\Linker\LinkTarget.

Definition at line 160 of file TitleValue.php.

References $fragment.

◆ getInterwiki()

TitleValue::getInterwiki ( )

Returns the interwiki part.

Since
1.27
Returns
string

Implements MediaWiki\Linker\LinkTarget.

Definition at line 232 of file TitleValue.php.

References $interwiki.

◆ getNamespace()

TitleValue::getNamespace ( )
Since
1.23
Returns
int

Implements MediaWiki\Linker\LinkTarget.

Definition at line 143 of file TitleValue.php.

References $namespace.

◆ 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 195 of file TitleValue.php.

◆ hasFragment()

TitleValue::hasFragment ( )
Since
1.27
Returns
bool

Implements MediaWiki\Linker\LinkTarget.

Definition at line 168 of file TitleValue.php.

◆ inNamespace()

TitleValue::inNamespace (   $ns)
Since
1.27
Parameters
int$ns
Returns
bool

Implements MediaWiki\Linker\LinkTarget.

Definition at line 152 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 222 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 48 of file TitleValue.php.

Referenced by getDBkey().

◆ $fragment

string TitleValue::$fragment
protected
Deprecated:
in 1.31.

This class is immutable. Use the getter for access.

Definition at line 54 of file TitleValue.php.

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

◆ $interwiki

string TitleValue::$interwiki
protected
Deprecated:
in 1.31.

This class is immutable. Use the getter for access.

Definition at line 60 of file TitleValue.php.

Referenced by __construct(), and getInterwiki().

◆ $namespace

int TitleValue::$namespace
protected
Deprecated:
in 1.31.

This class is immutable. Use the getter for access.

Definition at line 42 of file TitleValue.php.

Referenced by getNamespace().

◆ $prefixedText

string TitleValue::$prefixedText = null

Text form including namespace/interwiki, initialised on demand.

Only public to share cache with TitleFormatter

Access:
private

Definition at line 70 of file TitleValue.php.


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