MediaWiki  master
TitleFormatter Interface Reference

A title formatter service for MediaWiki. More...

Inheritance diagram for TitleFormatter:

Public Member Functions

 formatTitle ( $namespace, $text, $fragment='', $interwiki='')
 Returns the title formatted for display. More...
 
 getFullText (LinkTarget $title)
 Returns the title formatted for display, with namespace and fragment. More...
 
 getNamespaceName ( $namespace, $text)
 Returns the name of the namespace for the given title. More...
 
 getPrefixedDBkey (LinkTarget $target)
 Return the title in prefixed database key form, with interwiki and namespace. More...
 
 getPrefixedText (LinkTarget $title)
 Returns the title formatted for display, including the namespace name. More...
 
 getText (LinkTarget $title)
 Returns the title text formatted for display, without namespace of fragment. More...
 

Detailed Description

A title formatter service for MediaWiki.

This is designed to encapsulate knowledge about conventions for the title forms to be used in the database, in urls, in wikitext, etc.

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

Definition at line 34 of file TitleFormatter.php.

Member Function Documentation

◆ formatTitle()

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

Returns the title formatted for display.

Per default, this includes the namespace but not the fragment.

Note
Normalization is applied if $title is not in TitleValue::TITLE_FORM.
Parameters
int | bool$namespaceThe namespace ID (or false, if the namespace should be ignored)
string$textThe page title
string$fragmentThe fragment name (may be empty).
string$interwikiThe interwiki prefix (may be empty).
Returns
string

Implemented in MediaWikiTitleCodec.

◆ getFullText()

TitleFormatter::getFullText ( LinkTarget  $title)

Returns the title formatted for display, with namespace and fragment.

Parameters
LinkTarget$titleThe title to format
Returns
string

Implemented in MediaWikiTitleCodec.

◆ getNamespaceName()

TitleFormatter::getNamespaceName (   $namespace,
  $text 
)

Returns the name of the namespace for the given title.

Note
This must take into account gender sensitive namespace names.
Todo:
Move this to a separate interface
Parameters
int$namespace
string$text
Exceptions
InvalidArgumentException
Returns
string

Implemented in MediaWikiTitleCodec.

◆ getPrefixedDBkey()

TitleFormatter::getPrefixedDBkey ( LinkTarget  $target)

Return the title in prefixed database key form, with interwiki and namespace.

Since
1.27
Parameters
LinkTarget$target
Returns
string

Implemented in MediaWikiTitleCodec.

◆ getPrefixedText()

TitleFormatter::getPrefixedText ( LinkTarget  $title)

Returns the title formatted for display, including the namespace name.

Parameters
LinkTarget$titleThe title to format
Returns
string

Implemented in MediaWikiTitleCodec.

◆ getText()

TitleFormatter::getText ( LinkTarget  $title)

Returns the title text formatted for display, without namespace of fragment.

Note
Consider using LinkTarget::getText() directly, it's identical.
Parameters
LinkTarget$titleThe title to format
Returns
string

Implemented in MediaWikiTitleCodec.


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