Wikimedia\Message\ITextFormatter Interface Reference

Converts MessageSpecifier objects to localized plain text in a certain language. More...

Inherited by MediaWiki\Message\TextFormatter.

Public Member Functions
	format (MessageSpecifier $message)
	Convert a MessageSpecifier to text.
	getLangCode ()
	Get the internal language code in which format() is.

Detailed Description

Converts MessageSpecifier objects to localized plain text in a certain language.

The caller cannot modify the details of message translation, such as which of multiple sources the message is taken from. Any such flags may be injected into the factory constructor.

Implementations of TextFormatter are not required to perfectly format any message in any language. Implementations should make a best effort to produce human-readable text.

Definition at line 16 of file ITextFormatter.php.

Member Function Documentation

format()

Wikimedia\Message\ITextFormatter::format

(

MessageSpecifier

$message

)

Convert a MessageSpecifier to text.

The result is not safe for use as raw HTML.

Parameters

MessageSpecifier

$message

Returns

string

Implemented in MediaWiki\Message\TextFormatter.

getLangCode()

Wikimedia\Message\ITextFormatter::getLangCode

(

)

Get the internal language code in which format() is.

Returns

string

Implemented in MediaWiki\Message\TextFormatter.

---

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

• includes/libs/Message/ITextFormatter.php