BlueSpice MediaWiki master
 All Classes Namespaces Files Functions Variables Groups Pages
TitleValue Class Reference
Inheritance diagram for TitleValue:
Collaboration diagram for TitleValue:

Public Member Functions

 __construct ($namespace, $dbkey, $fragment= '', $interwiki= '')
 
 getNamespace ()
 
 inNamespace ($ns)
 
 getFragment ()
 
 hasFragment ()
 
 getDBkey ()
 
 getText ()
 
 createFragmentTarget ($fragment)
 
 isExternal ()
 
 getInterwiki ()
 
 __toString ()
 

Protected Attributes

 $namespace
 
 $dbkey
 
 $fragment
 
 $interwiki
 

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

Constructor & Destructor Documentation

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$namespaceThe namespace ID. This is not validated.
string$dbkeyThe page title in valid DBkey form. No normalization is applied.
string$fragmentThe fragment title. Use '' to represent the whole page. No validation or normalization is applied.
string$interwikiThe interwiki component
Exceptions
InvalidArgumentException

Member Function Documentation

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.

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.

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.

TitleValue::getFragment ( )
Since
1.23
Returns
string

Implements MediaWiki\Linker\LinkTarget.

TitleValue::getInterwiki ( )

Returns the interwiki part

Since
1.27
Returns
string

Implements MediaWiki\Linker\LinkTarget.

TitleValue::getNamespace ( )
Since
1.23
Returns
int

Implements MediaWiki\Linker\LinkTarget.

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.

TitleValue::hasFragment ( )
Since
1.27
Returns
bool

Implements MediaWiki\Linker\LinkTarget.

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

Implements MediaWiki\Linker\LinkTarget.

TitleValue::isExternal ( )

Whether it has an interwiki part

Since
1.27
Returns
bool

Implements MediaWiki\Linker\LinkTarget.


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