The Message class deals with fetching and processing of interface message into a variety of formats. More...

Inherits MessageSpecifier, and Serializable.

Inherited by ApiHelpParamValueMessage, ApiMessage, and MediaWiki\Language\RawMessage.

Collaboration diagram for Message:

[legend]

Public Member Functions
	__construct ( $key, $params=[], Language $language=null)

	__serialize ()

	__toString ()
	Magic method implementation of the above, so we can do, eg: $foo = new Message( $key ); $string = "<abbr>$foo</abbr>";.

	__unserialize ( $data)

	bitrateParams (... $params)
	Add parameters that are bitrates and will be passed through Language::formatBitrate before substitution.

	content ()
	Returns the message as a Content object.

	dateParams (... $params)
	Add parameters that are dates and will be passed through Language::date before substitution.

	dateTimeParams (... $params)
	Add parameters that are date-times and will be passed through Language::timeanddate before substitution.

	durationParams (... $params)
	Add parameters that are durations of time and will be passed through Language::formatDuration before substitution.

	escaped ()
	Returns the message text.

	exists ()
	Check whether a message key has been defined currently.

	expiryParams (... $params)
	Add parameters that are expiration times and will be passed through Language::formatExpiry before substitution.

	getKey ()
	Returns the message key.

	getKeysToTry ()

	getLanguage ()
	Returns the Language of the Message.

	getParams ()
	Returns the message parameters.

	getTitle ()
	Get a title object for a mediawiki message, where it can be found in the mediawiki namespace.

	inContentLanguage ()
	Request the message in the wiki's content language, unless it is disabled for this message.

	inLanguage ( $lang)
	Request the message in any language that is supported.

	isBlank ()
	Check whether a message does not exist, or is an empty string.

	isDisabled ()
	Check whether a message does not exist, is an empty string, or is "-".

	isMultiKey ()

	numParams (... $params)
	Add parameters that are numeric and will be passed through Language::formatNum before substitution.

	objectParams (... $params)
	Add parameters that represent stringable objects.

	page (?PageReference $page)
	Set the page object to use as context when transforming the message.

	params (... $args)
	Adds parameters to the parameter list of this message.

	parse ()
	Fully parse the text from wikitext to HTML.

	parseAsBlock ()
	Returns the parsed message text which is always surrounded by a block element.

	plain ()
	Returns the message text as-is, only parameters are substituted.

	plaintextParams (... $params)
	Add parameters that are plaintext and will be passed through without the content being evaluated.

	rawParams (... $params)
	Add parameters that are substituted after parsing or escaping.

	serialize ()

	setContext (IContextSource $context)
	Set the language and the title from a context object.

	setInterfaceMessageFlag ( $interface)
	Allows manipulating the interface message flag directly.

	sizeParams (... $params)
	Add parameters that are file sizes and will be passed through Language::formatSize before substitution.

	text ()
	Returns the message text.

	timeParams (... $params)
	Add parameters that are times and will be passed through Language::time before substitution.

	timeperiodParams (... $params)
	Add parameters that are time periods and will be passed through Language::formatTimePeriod before substitution.

	title ( $title)
	Set the Title object to use as context when transforming the message.

	toString (string $format)
	Returns the message formatted a certain way.

	unserialize ( $serialized)

	useDatabase ( $useDatabase)

	userGroupParams (... $params)
	Add parameters that represent user groups.

Static Public Member Functions
static	bitrateParam ( $bitrate)

static	dateParam (string $date)

static	dateTimeParam (string $dateTime)

static	durationParam ( $duration)

static	expiryParam ( $expiry)

static	listParam (array $list, $type='text')

static	newFallbackSequence (... $keys)
	Factory function accepting multiple message keys and returning a message instance for the first message which is non-empty.

static	newFromKey ( $key,... $params)
	Factory function that is just wrapper for the real constructor.

static	newFromSpecifier ( $value)
	Transform a MessageSpecifier or a primitive value used interchangeably with specifiers (a message key string, or a key + params array) into a proper Message.

static	numParam ( $num)

static	objectParam (Stringable $object)

static	plaintextParam ( $plaintext)

static	rawParam ( $raw)

static	sizeParam ( $size)

static	timeParam (string $time)

static	timeperiodParam ( $period)

static	userGroupParam (string $userGroup)

Public Attributes
const	FORMAT_BLOCK_PARSE = 'block-parse'
	Use normal wikitext -> HTML parsing (the result will be wrapped in a block-level HTML tag)

const	FORMAT_ESCAPED = 'escaped'
	Transform {{..}} constructs, HTML-escape the result.

const	FORMAT_PARSE = 'parse'
	Use normal wikitext -> HTML parsing but strip the block-level wrapper.

const	FORMAT_PLAIN = 'plain'
	Use message text as-is.

const	FORMAT_TEXT = 'text'
	Transform {{..}} constructs but don't transform to HTML.

Protected Member Functions
	extractParam ( $param, $format)
	Extracts the parameter type and preprocessed the value if needed.

	fetchMessage ()
	Wrapper for whatever method we use to get message contents.

	formatListParam (array $params, $listType, $format)
	Formats a list of parameters as a concatenated string.

	formatPlaintext ( $plaintext, $format)
	Formats a message parameter wrapped with 'plaintext'.

	parseText ( $string)
	Wrapper for what ever method we use to parse wikitext.

	replaceParameters ( $message, $type, $format)
	Substitutes any parameters into the message text.

	transformText ( $string)
	Wrapper for what ever method we use to {{-transform wikitext (substituting the template with its parsed result).

Protected Attributes
Content null	$content = null
	Content object representing the message.

PageReference	$contextPage = null
	page object to use as context.

bool	$interface = true
	In which language to get this message.

string	$key
	The message key.

string[]	$keysToTry
	List of keys to try when fetching the message.

Language null	$language = null
	In which language to get this message.

string null false	$message

array	$parameters = []
	List of parameters which will be substituted into the message.

bool	$useDatabase = true
	If messages in the local MediaWiki namespace should be loaded; false to use only the compiled LocalisationCache.

Static Protected Attributes
static array	$listTypeMap
	Mapping from Message::listParam() types to Language methods.

Detailed Description

The Message class deals with fetching and processing of interface message into a variety of formats.

First implemented with MediaWiki 1.17, the Message class is intended to replace the old wfMsg* functions that over time grew unusable.

See also: https://www.mediawiki.org/wiki/Manual:Messages_API for equivalences between old and new functions.

The preferred way to create Message objects is via the msg() method of of an available RequestContext and ResourceLoader Context object; this will ensure that the message uses the correct language. When that is not possible, the wfMessage() global function can be used, which will cause Message to get the language from the global RequestContext object. In rare circumstances when sessions are not available or not initialized, that can lead to errors.

The most basic usage cases would be:

// Initialize a Message object using the 'some_key' message key
$message = $context->msg( 'some_key' );
 
// Using two parameters those values are strings 'value1' and 'value2':
$message = $context->msg( 'some_key',
     'value1', 'value2'
);

Global function wrapper:

Since msg() returns a Message instance, you can chain its call with a method. Some of them return a Message instance too so you can chain them. You will find below several examples of msg() usage.

Fetching a message text for interface message:

$button = Xml::button(
     $context->msg( 'submit' )->text()
);

A Message instance can be passed parameters after it has been constructed, use the params() method to do so:

$context->msg( 'welcome-to' )
    ->params( $wgSitename )
    ->text();

{{GRAMMAR}} and friends work correctly:

$context->msg( 'are-friends',
    $user, $friend
);
$context->msg( 'bad-message' )
     ->rawParams( '<script>...</script>' )
     ->escaped();

Changing language:

Messages can be requested in a different language or in whatever current content language is being used. The methods are:

Message->inContentLanguage()
Message->inLanguage()

Sometimes the message text ends up in the database, so content language is needed:

wfMessage( 'file-log',
    $user, $filename
)->inContentLanguage()->text();

Checking whether a message exists:

$context->msg( 'mysterious-message' )->exists()

// returns a boolean whether the 'mysterious-message' key exist.

If you want to use a different language:

$userLanguage = $user->getOption( 'language' );
wfMessage( 'email-header' )
     ->inLanguage( $userLanguage )
     ->plain();

Note: You can parse the text only in the content or interface languages

Appendix:

Todo

test, can we have tests?
this documentation needs to be extended

See also: https://www.mediawiki.org/wiki/WfMessage(); https://www.mediawiki.org/wiki/New_messages_API; https://www.mediawiki.org/wiki/Localisation

Since: 1.17

Stability: newable

Definition at line 144 of file Message.php.

Constructor & Destructor Documentation

◆ __construct()

Message::__construct	(		$key,
			$params = [],
		Language	$language = null )

Stability: stable: to call

Since: 1.17

Parameters

string \| string[] \| MessageSpecifier	$key	Message key, or array of message keys to try and use the first non-empty message for, or a MessageSpecifier to copy from.
array	$params	Message parameters.
Language \| null	$language	[optional] Language to use (defaults to current user language).

Exceptions

InvalidArgumentException

Definition at line 229 of file Message.php.

References $key, and $language.

Member Function Documentation

◆ __serialize()

Message::__serialize ( )

See also: Serializable::serialize()

Since: 1.38

Returns: array

Definition at line 273 of file Message.php.

◆ __toString()

Message::__toString ( )

Magic method implementation of the above, so we can do, eg: $foo = new Message( $key ); $string = "<abbr>$foo</abbr>";.

Since: 1.18

Returns: string; -taint escaped

Definition at line 1033 of file Message.php.

◆ __unserialize()

Message::__unserialize ( $data )

See also: Serializable::unserialize()

Since: 1.26

Parameters

array $data

Definition at line 305 of file Message.php.

◆ bitrateParam()

static Message::bitrateParam ( $bitrate )

static

Since: 1.22

Parameters

int $bitrate

Returns: int[] Array with a single "bitrate" key.

Definition at line 1264 of file Message.php.

◆ bitrateParams()

Message::bitrateParams ( $params )

Add parameters that are bitrates and will be passed through Language::formatBitrate before substitution.

Since: 1.22

Parameters

int|int[] ...$params Bit rate parameters, or a single argument that is an array of bit rate parameters.

Returns: self $this

Definition at line 777 of file Message.php.

◆ content()

Message::content ( )

Returns the message as a Content object.

Deprecated: since 1.38, MessageContent class is hard-deprecated.

Returns: Content

Definition at line 944 of file Message.php.

References $content, and wfDeprecated().

◆ dateParam()

static Message::dateParam ( string $date )

static

Since: 1.36

Parameters

string $date

Returns: string[] Array with a single "date" key.

Definition at line 1198 of file Message.php.

◆ dateParams()

Message::dateParams ( $params )

Add parameters that are dates and will be passed through Language::date before substitution.

Since: 1.36

Parameters

string|string[] ...$params Date parameters, or a single argument that is an array of date parameters.

Returns: self $this

Definition at line 653 of file Message.php.

◆ dateTimeParam()

static Message::dateTimeParam ( string $dateTime )

static

Since: 1.36

Parameters

string $dateTime

Returns: string[] Array with a single "datetime" key.

Definition at line 1187 of file Message.php.

◆ dateTimeParams()

Message::dateTimeParams ( $params )

Add parameters that are date-times and will be passed through Language::timeanddate before substitution.

Since: 1.36

Parameters

string|string[] ...$params Date-time parameters, or a single argument that is an array of date-time parameters.

Returns: self $this

Definition at line 632 of file Message.php.

◆ durationParam()

static Message::durationParam ( $duration )

static

Since: 1.22

Parameters

int $duration

Returns: int[] Array with a single "duration" key.

Definition at line 1165 of file Message.php.

Referenced by MediaWiki\Specials\SpecialBlock\getFormFields().

◆ durationParams()

Message::durationParams ( $params )

Add parameters that are durations of time and will be passed through Language::formatDuration before substitution.

Since: 1.22

Parameters

int|int[] ...$params Duration parameters, or a single argument that is an array of duration parameters.

Returns: self $this

Definition at line 590 of file Message.php.

◆ escaped()

Message::escaped ( )

Returns the message text.

{{-transformation (substituting the template with its parsed result) is done and the result is HTML escaped excluding any raw parameters.

Since: 1.17

Returns: string HTML escaped message text.; -taint escaped

Definition at line 1095 of file Message.php.

Referenced by MediaWiki\Search\SearchWidgets\BasicSearchResultSetWidget\header().

◆ exists()

Message::exists ( )

Check whether a message key has been defined currently.

Since: 1.17

Returns: bool

Definition at line 1106 of file Message.php.

◆ expiryParam()

static Message::expiryParam ( $expiry )

static

Since: 1.22

Parameters

string $expiry

Returns: string[] Array with a single "expiry" key.

Definition at line 1176 of file Message.php.

◆ expiryParams()

Message::expiryParams ( $params )

Add parameters that are expiration times and will be passed through Language::formatExpiry before substitution.

Since: 1.22

Parameters

string|string[] ...$params Expiry parameters, or a single argument that is an array of expiry parameters.

Returns: self $this

Definition at line 611 of file Message.php.

◆ extractParam()

Message::extractParam	(		$param,
			$format )

protected

Extracts the parameter type and preprocessed the value if needed.

Since: 1.18

Parameters

mixed	$param	Parameter as defined in this class.
string	$format	One of the FORMAT_* constants.

Returns: array Array with the parameter type (either "before" or "after") and the value.

Definition at line 1343 of file Message.php.

◆ fetchMessage()

Message::fetchMessage ( )

protected

Wrapper for whatever method we use to get message contents.

Since: 1.17

Returns: string|false

Exceptions

MWException If message key array is empty.

Reimplemented in ApiHelpParamValueMessage, and MediaWiki\Language\RawMessage.

Definition at line 1480 of file Message.php.

◆ formatListParam()

Message::formatListParam	(	array	$params,
			$listType,
			$format )

protected

Formats a list of parameters as a concatenated string.

Since: 1.29

Parameters

array	$params
string	$listType
string	$format	One of the FORMAT_* constants.

Returns: array Array with the parameter type (either "before" or "after") and the value.

Definition at line 1536 of file Message.php.

References wfDebugLog().

◆ formatPlaintext()

Message::formatPlaintext	(		$plaintext,
			$format )

protected

Formats a message parameter wrapped with 'plaintext'.

Ensures that the entire string is displayed unchanged when displayed in the output format.

Since: 1.25

Parameters

string	$plaintext	String to ensure plaintext output of
string	$format	One of the FORMAT_* constants.

Returns: string Input plaintext encoded for output to $format

Definition at line 1514 of file Message.php.

◆ getKey()

Message::getKey ( )

Returns the message key.

If a list of multiple possible keys was supplied to the constructor, this method may return any of these keys. After the message has been fetched, this method will return the key that was actually used to fetch the message.

Since: 1.21

Returns: string

Implements MessageSpecifier.

Definition at line 365 of file Message.php.

Referenced by MediaWiki\EditPage\IntroMessageList\add(), MediaWiki\Message\Converter\convertMessage(), and MediaWiki\Specials\SpecialEmailUser\getPermissionsError().

◆ getKeysToTry()

Message::getKeysToTry ( )

Since: 1.24

Returns: string[] The list of keys to try when fetching the message text, in order of preference.

Definition at line 350 of file Message.php.

◆ getLanguage()

Message::getLanguage ( )

Returns the Language of the Message.

Since: 1.23

Returns: Language

Definition at line 387 of file Message.php.

◆ getParams()

Message::getParams ( )

Returns the message parameters.

Since: 1.21

Returns: array

Implements MessageSpecifier.

Definition at line 376 of file Message.php.

Referenced by MediaWiki\Message\Converter\convertMessage().

◆ getTitle()

Message::getTitle ( )

Get a title object for a mediawiki message, where it can be found in the mediawiki namespace.

The title will be for the current language, if the message key is in $wgForceUIMsgAsContentMsg it will be append with the language code (except content language), because Message::inContentLanguage will also return in user language.

See also: $wgForceUIMsgAsContentMsg

Returns: Title

Since: 1.26

Definition at line 484 of file Message.php.

References NS_MEDIAWIKI.

◆ inContentLanguage()

Message::inContentLanguage ( )

Request the message in the wiki's content language, unless it is disabled for this message.

Since: 1.17

See also: $wgForceUIMsgAsContentMsg

Returns: self $this

Definition at line 871 of file Message.php.

◆ inLanguage()

Message::inLanguage ( $lang )

Request the message in any language that is supported.

As a side effect interface message status is unconditionally turned off.

Since: 1.17

Parameters

Language | StubUserLang | string $lang Language code or Language object.

Returns: self $this

Definition at line 837 of file Message.php.

References Language\getCode().

Referenced by MediaWiki\CommentStore\CommentStoreComment\newUnsavedComment().

◆ isBlank()

Message::isBlank ( )

Check whether a message does not exist, or is an empty string.

Since: 1.18

Todo: FIXME: Merge with isDisabled()?

Returns: bool

Definition at line 1118 of file Message.php.

◆ isDisabled()

Message::isDisabled ( )

Check whether a message does not exist, is an empty string, or is "-".

Since: 1.18

Returns: bool

Definition at line 1130 of file Message.php.

◆ isMultiKey()

Message::isMultiKey ( )

Since: 1.24

Returns: bool True if this is a multi-key message, that is, if the key provided to the constructor was a fallback list of keys to try.

Definition at line 340 of file Message.php.

◆ listParam()

static Message::listParam	(	array	$list,
			$type = 'text' )

static

Since: 1.29

Parameters

array	$list
string	$type	'comma', 'semicolon', 'pipe', 'text'

Returns: array Array with "list" and "type" keys.

Definition at line 1286 of file Message.php.

Referenced by PermissionsError\__construct(), ApiUpload\checkVerification(), ApiQueryLanguageinfo\execute(), ApiPageSet\getAllowedParams(), MediaWiki\Specials\SpecialVersion\getCopyrightAndAuthorList(), ApiMain\modifyHelp(), ApiMain\reportUnusedParams(), ApiBase\requireAtLeastOneParameter(), ApiBase\requireMaxOneParameter(), and ApiBase\requireOnlyOneParameter().

◆ newFallbackSequence()

static Message::newFallbackSequence ( $keys )

static

Factory function accepting multiple message keys and returning a message instance for the first message which is non-empty.

If all messages are empty then an instance of the last message key is returned.

Since: 1.18

Parameters

string\|string[]	...$keys Message keys, or first argument as an array of all the message keys.
-taint	...$keys tainted

Returns: self

Definition at line 461 of file Message.php.

Referenced by wfMessageFallback().

◆ newFromKey()

static Message::newFromKey	(		$key,
			$params )

static

Factory function that is just wrapper for the real constructor.

It is intended to be used instead of the real constructor, because it allows chaining method calls, while new objects don't.

Since: 1.17

Parameters

string \| string[] \| MessageSpecifier	$key
	mixed	...$params Parameters as strings.

Returns: self

Definition at line 404 of file Message.php.

Referenced by MediaWiki\Auth\ButtonAuthenticationRequest\__set_state().

◆ newFromSpecifier()

static Message::newFromSpecifier ( $value )

static

Transform a MessageSpecifier or a primitive value used interchangeably with specifiers (a message key string, or a key + params array) into a proper Message.

Also accepts a MessageSpecifier inside an array: that's not considered a valid format but is an easy error to make due to how StatusValue stores messages internally. Further array elements are ignored in that case.

When the MessageSpecifier object is an instance of Message, a clone of the object is returned. This is unlike the new Message( … ) constructor, which returns a new object constructed from scratch with the same key. This difference is mostly relevant when the passed object is an instance of a subclass like RawMessage or ApiMessage.

Parameters

string \| array \| MessageSpecifier	$value
-taint	$value	tainted

Returns: self

Exceptions

InvalidArgumentException

Since: 1.27

Definition at line 427 of file Message.php.

Referenced by PermissionsError\__construct(), ApiMain\errorMessagesFromException(), MediaWiki\User\PasswordReset\execute(), HTMLForm\getMessage(), HTMLFormField\getMessage(), ApiErrorFormatter\getMessageFromException(), LocalizedException\getMessageObject(), UploadStashException\getMessageObject(), and wfMessage().

◆ numParam()

static Message::numParam ( $num )

static

Since: 1.18

Parameters

mixed $num

Returns: array Array with a single "num" key.

Definition at line 1154 of file Message.php.

Referenced by ApiResult\addValue(), MediaWiki\Linker\Linker\buildRollbackLink(), ApiOptions\execute(), LogFormatter\formatParameterValue(), MediaWiki\Page\MergeHistory\isValidMerge(), Parser\limitationWarn(), PPFrame_Hash\newChild(), MediaWiki\Preferences\DefaultPreferencesFactory\rcPreferences(), MediaWiki\Specials\SpecialSearch\showCreateLink(), MediaWiki\Title\MediaWikiTitleCodec\splitTitleString(), and MediaWiki\Preferences\DefaultPreferencesFactory\watchlistPreferences().

◆ numParams()

Message::numParams ( $params )

Add parameters that are numeric and will be passed through Language::formatNum before substitution.

Since: 1.18

Parameters

mixed ...$params Numeric parameters, or a single argument that is an array of numeric parameters.

Returns: self $this

Definition at line 569 of file Message.php.

◆ objectParam()

static Message::objectParam ( Stringable $object )

static

Since: 1.38

Parameters

Stringable $object

Returns: Stringable[] Array with a single "object" key.

Definition at line 1231 of file Message.php.

◆ objectParams()

Message::objectParams ( $params )

Add parameters that represent stringable objects.

Since: 1.38

Parameters

Stringable|Stringable[] ...$params stringable parameters, or a single argument that is an array of stringable parameters.

Returns: self $this

Definition at line 693 of file Message.php.

◆ page()

Message::page ( ?PageReference $page )

Set the page object to use as context when transforming the message.

Since: 1.37

Parameters

?PageReference $page

Returns: self $this

Definition at line 934 of file Message.php.

◆ params()

Message::params ( $args )

Adds parameters to the parameter list of this message.

Since: 1.17

Parameters

mixed ...$args Parameters as strings or arrays from Message::numParam() and the like, or a single array of parameters.

Returns: self $this

Definition at line 512 of file Message.php.

◆ parse()

Message::parse ( )

Fully parse the text from wikitext to HTML.

Since: 1.17

Returns: string Parsed HTML.; -taint escaped

Definition at line 1045 of file Message.php.

Referenced by MediaWiki\EditPage\IntroMessageList\add(), and HTMLFormField\formatErrors().

◆ parseAsBlock()

Message::parseAsBlock ( )

Returns the parsed message text which is always surrounded by a block element.

Since: 1.17

Returns: string HTML; -taint escaped

Definition at line 1082 of file Message.php.

◆ parseText()

Message::parseText ( $string )

protected

Wrapper for what ever method we use to parse wikitext.

Since: 1.17

Parameters

string $string Wikitext message contents.

Returns: string Wikitext parsed into HTML.

Definition at line 1430 of file Message.php.

References ParserOutput\getText().

◆ plain()

Message::plain ( )

Returns the message text as-is, only parameters are substituted.

Since: 1.17

Returns: string Unescaped untransformed message text.; -taint tainted

Definition at line 1070 of file Message.php.

◆ plaintextParam()

static Message::plaintextParam ( $plaintext )

static

Since: 1.25

Parameters

string $plaintext

Returns: string[] Array with a single "plaintext" key.

Definition at line 1275 of file Message.php.

Referenced by MediaWiki\CommentStore\CommentStoreComment\__construct(), Parser\braceSubstitution(), CoreParserFunctions\displaytitle(), ApiEditPage\execute(), PPFrame_Hash\newChild(), and ChangeTags\tagShortDescriptionMessage().

◆ plaintextParams()

Message::plaintextParams ( $params )

Add parameters that are plaintext and will be passed through without the content being evaluated.

Plaintext parameters are not valid as arguments to parser functions. This differs from self::rawParams in that the Message class handles escaping to match the output format.

Since: 1.25

Parameters

string|string[] ...$params plaintext parameters, or a single argument that is an array of plaintext parameters.

Returns: self $this

Definition at line 800 of file Message.php.

◆ rawParam()

static Message::rawParam ( $raw )

static

Since: 1.17

Parameters

mixed	$raw
-taint	$raw	html,exec_html

Returns: array Array with a single "raw" key.

Definition at line 1143 of file Message.php.

◆ rawParams()

Message::rawParams ( $params )

Add parameters that are substituted after parsing or escaping.

In other words the parsing process cannot access the contents of this type of parameter, and you need to make sure it is sanitized beforehand. The parser will see "$n", instead.

Since: 1.17

Parameters

mixed	...$params Raw parameters as strings, or a single argument that is an array of raw parameters.
-taint	...$params html,exec_html

Returns: self $this

Definition at line 548 of file Message.php.

◆ replaceParameters()

Message::replaceParameters	(	$message,
		$type,
		$format )

protected

Substitutes any parameters into the message text.

Since: 1.17

Parameters

string	$message	The message text.
string	$type	Either "before" or "after".
string	$format	One of the FORMAT_* constants.

Returns: string

Definition at line 1306 of file Message.php.

◆ serialize()

Message::serialize ( )

See also: Serializable::serialize()

Since: 1.26

Returns: string

Definition at line 264 of file Message.php.

◆ setContext()

Message::setContext ( IContextSource $context )

Set the language and the title from a context object.

Since: 1.19

Parameters

IContextSource $context

Returns: self $this

Definition at line 819 of file Message.php.

References IContextSource\getLanguage(), IContextSource\getTitle(), and true.

◆ setInterfaceMessageFlag()

Message::setInterfaceMessageFlag ( $interface )

Allows manipulating the interface message flag directly.

Can be used to restore the flag after setting a language.

Since: 1.20

Parameters

bool $interface

Returns: self $this

Definition at line 892 of file Message.php.

◆ sizeParam()

static Message::sizeParam ( $size )

static

Since: 1.22

Parameters

int $size

Returns: int[] Array with a single "size" key.

Definition at line 1253 of file Message.php.

◆ sizeParams()

Message::sizeParams ( $params )

Add parameters that are file sizes and will be passed through Language::formatSize before substitution.

Since: 1.22

Parameters

int|int[] ...$params Size parameters, or a single argument that is an array of size parameters.

Returns: self $this

Definition at line 756 of file Message.php.

◆ text()

Message::text ( )

Returns the message text.

{{-transformation occurs (substituting the template with its parsed result).

Since: 1.17

Returns: string Unescaped message text.; -taint tainted

Definition at line 1058 of file Message.php.

◆ timeParam()

static Message::timeParam ( string $time )

static

Since: 1.36

Parameters

string $time

Returns: string[] Array with a single "time" key.

Definition at line 1209 of file Message.php.

◆ timeParams()

Message::timeParams ( $params )

Add parameters that are times and will be passed through Language::time before substitution.

Since: 1.36

Parameters

string|string[] ...$params Time parameters, or a single argument that is an array of time parameters.

Returns: self $this

Definition at line 714 of file Message.php.

◆ timeperiodParam()

static Message::timeperiodParam ( $period )

static

Since: 1.22

Parameters

int | float $period

Returns: int[]|float[] Array with a single "period" key.

Definition at line 1242 of file Message.php.

◆ timeperiodParams()

Message::timeperiodParams ( $params )

Add parameters that are time periods and will be passed through Language::formatTimePeriod before substitution.

Since: 1.22

Parameters

int|float|(int|float)[] ...$params Time period parameters, or a single argument that is an array of time period parameters.

Returns: self $this

Definition at line 735 of file Message.php.

◆ title()

Message::title ( $title )

Set the Title object to use as context when transforming the message.

Since: 1.18

Deprecated: since 1.37. Use page instead

Parameters

Title $title

Returns: self $this

Definition at line 921 of file Message.php.

◆ toString()

Message::toString ( string $format )

Returns the message formatted a certain way.

Since: 1.17

Parameters

string $format One of the FORMAT_* constants.

Returns: string Text or HTML

Definition at line 960 of file Message.php.

◆ transformText()

Message::transformText ( $string )

protected

Wrapper for what ever method we use to {{-transform wikitext (substituting the template with its parsed result).

Since: 1.17

Parameters

string $string Wikitext message contents.

Returns: string Wikitext with {{-constructs substituted with its parsed result.

Definition at line 1463 of file Message.php.

◆ unserialize()

Message::unserialize ( $serialized )

See also: Serializable::unserialize()

Since: 1.38

Parameters

string $serialized

Definition at line 296 of file Message.php.

◆ useDatabase()

Message::useDatabase ( $useDatabase )

Since: 1.17

Parameters

bool $useDatabase If messages in the local MediaWiki namespace should be loaded; false to use only the compiled LocalisationCache

Returns: self $this

Definition at line 905 of file Message.php.

◆ userGroupParam()

static Message::userGroupParam ( string $userGroup )

static

Since: 1.38

Parameters

string $userGroup

Returns: string[] Array with a single "group" key.

Definition at line 1220 of file Message.php.

◆ userGroupParams()

Message::userGroupParams ( $params )

Add parameters that represent user groups.

Since: 1.38

Parameters

string|string[] ...$params User Group parameters, or a single argument that is an array of user group parameters.

Returns: self $this

Definition at line 673 of file Message.php.

Member Data Documentation

◆ $content

Content null Message::$content = null

protected

Content object representing the message.

Definition at line 212 of file Message.php.

◆ $contextPage

PageReference Message::$contextPage = null

protected

page object to use as context.

Definition at line 207 of file Message.php.

◆ $interface

bool Message::$interface = true

protected

In which language to get this message.

True, which is the default, means the current user language, false content language.

Definition at line 173 of file Message.php.

◆ $key

string Message::$key

protected

The message key.

If $keysToTry has more than one element, this may change to one of the keys to try when fetching the message text.

Definition at line 186 of file Message.php.

Referenced by __construct(), ApiMessage\__construct(), ApiRawMessage\__construct(), and MediaWiki\Language\RawMessage\fetchMessage().

◆ $keysToTry

string [] Message::$keysToTry

protected

List of keys to try when fetching the message.

Definition at line 191 of file Message.php.

◆ $language

Language null Message::$language = null

protected

In which language to get this message.

Overrides the $interface setting.

Explicit language object, or null for user language

Definition at line 180 of file Message.php.

Referenced by __construct().

◆ $listTypeMap

array Message::$listTypeMap

staticprotected

Initial value:

= [
        'comma' => 'commaList',
        'semicolon' => 'semicolonList',
        'pipe' => 'pipeList',
        'text' => 'listToText',
    ]

Mapping from Message::listParam() types to Language methods.

Definition at line 160 of file Message.php.

◆ $message

string null false Message::$message

protected

Definition at line 217 of file Message.php.

Referenced by ApiHelpParamValueMessage\fetchMessage(), and MediaWiki\Language\RawMessage\fetchMessage().

◆ $parameters

array Message::$parameters = []

protected

List of parameters which will be substituted into the message.

Definition at line 196 of file Message.php.

◆ $useDatabase

bool Message::$useDatabase = true

protected

If messages in the local MediaWiki namespace should be loaded; false to use only the compiled LocalisationCache.

Definition at line 202 of file Message.php.

◆ FORMAT_BLOCK_PARSE

const Message::FORMAT_BLOCK_PARSE = 'block-parse'

Use normal wikitext -> HTML parsing (the result will be wrapped in a block-level HTML tag)

Definition at line 148 of file Message.php.

◆ FORMAT_ESCAPED

const Message::FORMAT_ESCAPED = 'escaped'

Transform {{..}} constructs, HTML-escape the result.

Definition at line 154 of file Message.php.

◆ FORMAT_PARSE

const Message::FORMAT_PARSE = 'parse'

Use normal wikitext -> HTML parsing but strip the block-level wrapper.

Definition at line 150 of file Message.php.

◆ FORMAT_PLAIN

const Message::FORMAT_PLAIN = 'plain'

Use message text as-is.

Definition at line 146 of file Message.php.

◆ FORMAT_TEXT

const Message::FORMAT_TEXT = 'text'

Transform {{..}} constructs but don't transform to HTML.

Definition at line 152 of file Message.php.

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

includes/language/Message.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Global function wrapper:

Changing language:

Appendix:

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __serialize()

◆ __toString()

◆ __unserialize()

◆ bitrateParam()

◆ bitrateParams()

◆ content()

◆ dateParam()

◆ dateParams()

◆ dateTimeParam()

◆ dateTimeParams()

◆ durationParam()

◆ durationParams()

◆ escaped()

◆ exists()

◆ expiryParam()

◆ expiryParams()

◆ extractParam()

◆ fetchMessage()

◆ formatListParam()

◆ formatPlaintext()

◆ getKey()

◆ getKeysToTry()

◆ getLanguage()

◆ getParams()

◆ getTitle()

◆ inContentLanguage()

◆ inLanguage()

◆ isBlank()

◆ isDisabled()

◆ isMultiKey()

◆ listParam()

◆ newFallbackSequence()

◆ newFromKey()

◆ newFromSpecifier()

◆ numParam()

◆ numParams()

◆ objectParam()

◆ objectParams()

◆ page()

◆ params()

◆ parse()

◆ parseAsBlock()

◆ parseText()

◆ plain()

◆ plaintextParam()

◆ plaintextParams()

◆ rawParam()

◆ rawParams()

◆ replaceParameters()

◆ serialize()

◆ setContext()

◆ setInterfaceMessageFlag()

◆ sizeParam()

◆ sizeParams()

◆ text()

◆ timeParam()

◆ timeParams()

◆ timeperiodParam()

◆ timeperiodParams()

◆ title()

◆ toString()

◆ transformText()

◆ unserialize()

◆ useDatabase()

◆ userGroupParam()

◆ userGroupParams()

Member Data Documentation