A title formatter service for MediaWiki. More...
Public Member Functions | |
| formatTitle ($namespace, $text, $fragment= '') | |
| Returns the title formatted for display. | |
| getFullText (TitleValue $title) | |
| Returns the title formatted for display, with namespace and fragment. | |
| getNamespaceName ($namespace, $text) | |
| Returns the name of the namespace for the given title. | |
| getPrefixedText (TitleValue $title) | |
| Returns the title formatted for display, including the namespace name. | |
| getText (TitleValue $title) | |
| Returns the title text formatted for display, without namespace of fragment. | |
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.
Definition at line 33 of file TitleFormatter.php.
Member Function Documentation
| TitleFormatter::formatTitle | ( | $ | namespace, |
| $ | text, | ||
| $ | fragment = '' |
||
| ) |
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 $namespace The namespace ID (or false, if the namespace should be ignored) string $text The page title string $fragment The fragment name (may be empty).
- Returns:
- string
Implemented in MediaWikiTitleCodec.
| TitleFormatter::getFullText | ( | TitleValue $ | title | ) |
Returns the title formatted for display, with namespace and fragment.
- Parameters:
-
TitleValue $title The title to format
- Returns:
- string
Implemented in MediaWikiTitleCodec.
| 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.
| TitleFormatter::getPrefixedText | ( | TitleValue $ | title | ) |
Returns the title formatted for display, including the namespace name.
- Parameters:
-
TitleValue $title The title to format
- Returns:
- string
Implemented in MediaWikiTitleCodec.
| TitleFormatter::getText | ( | TitleValue $ | title | ) |
Returns the title text formatted for display, without namespace of fragment.
- Note:
- Only minimal normalization is applied. Consider using TitleValue::getText() directly.
- Parameters:
-
TitleValue $title The title to format
- Returns:
- string
Implemented in MediaWikiTitleCodec.
The documentation for this interface was generated from the following file:
- includes/title/TitleFormatter.php
