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

Inheritance diagram for Message:

[legend]

Collaboration diagram for Message:

[legend]

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

	__serialize ()

	__toString ()
	Magic method implementation of the above (for PHP >= 5.2.0), 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.

	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.

	getFormat ()
	Returns the message format.

	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.

	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.

	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 ( $format=null)
	Returns the message parsed from wikitext to HTML.

	unserialize ( $serialized)

	useDatabase ( $useDatabase)
	Enable or disable database use.

Static Public Member Functions
static	bitrateParam ( $bitrate)

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	plaintextParam ( $plaintext)

static	rawParam ( $raw)

static	sizeParam ( $size)

static	timeperiodParam ( $period)

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 what ever 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.

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

string	$format = 'parse'

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 bool	$language = false
	In which language to get this message.

string	$message

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

Title	$title = null
	Title object to use as context.

bool	$useDatabase = true
	Whether database can be used.

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.

You should use the wfMessage() global function which acts as a wrapper for the Message class. The wrapper let you pass parameters as arguments.

The most basic usage cases would be:

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

Global function wrapper:

Since wfMessage() 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 wfMessage() usage.

Fetching a message text for interface message:

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

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

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

{{GRAMMAR}} and friends work correctly:

wfMessage( 'are-friends',
    $user, $friend
);
wfMessage( '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:

wfMessage( '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

Comparison with old wfMsg* functions:

Use full parsing:

// old style:
wfMsgExt( 'key', [ 'parseinline' ], 'apple' );
// new style:
wfMessage( 'key', 'apple' )->parse();

Parseinline is used because it is more useful when pre-building HTML. In normal use it is better to use OutputPage::(add|wrap)WikiMsg.

Places where HTML cannot be used. {{-transformation is done.

// old style:
wfMsgExt( 'key', [ 'parsemag' ], 'apple', 'pear' );
// new style:
wfMessage( 'key', 'apple', 'pear' )->text();

Shortcut for escaping the message. Parameters are not replaced after escaping by default.

$escaped = wfMessage( 'key' )
     ->rawParams( 'apple' )
     ->escaped();

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 @newable

Definition at line 161 of file Message.php.

Constructor & Destructor Documentation

◆ __construct()

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

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 251 of file Message.php.

References $key, and $language.

Member Function Documentation

◆ __serialize()

Message::__serialize ( )

See also: Serializable::serialize()

Since: 1.35.6

Returns: array

Definition at line 294 of file Message.php.

◆ __toString()

Message::__toString ( )

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

Since: 1.18

Returns: string

Definition at line 931 of file Message.php.

◆ __unserialize()

Message::__unserialize ( $data )

See also: Serializable::unserialize()

Since: 1.26

Parameters

array $data

Definition at line 327 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 1119 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: Message $this

Definition at line 696 of file Message.php.

◆ content()

Message::content ( )

Returns the message as a Content object.

Returns: Content

Definition at line 852 of file Message.php.

References $content.

◆ durationParam()

static Message::durationParam ( $duration )

static

Since: 1.22

Parameters

int $duration

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

Definition at line 1075 of file Message.php.

◆ 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: Message $this

Definition at line 612 of file Message.php.

◆ escaped()

Message::escaped ( )

Returns the message text.

{{-transformation is done and the result is escaped excluding any raw parameters.

Since: 1.17

Returns: string Escaped message text.

Definition at line 1005 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 1017 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 1086 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: Message $this

Definition at line 633 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 1198 of file Message.php.

References $title, and serialize().

◆ fetchMessage()

Message::fetchMessage ( )

protected

Wrapper for what ever method we use to get message contents.

Since: 1.17

Returns: string

Exceptions

MWException If message key array is empty.

Reimplemented in ApiHelpParamValueMessage, and RawMessage.

Definition at line 1315 of file Message.php.

References $cache.

◆ 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 1368 of file Message.php.

References $type, serialize(), and 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 1346 of file Message.php.

◆ getFormat()

Message::getFormat ( )

Returns the message format.

Since: 1.21

Returns: string

Deprecated:: since 1.29 formatting is not stateful

Definition at line 406 of file Message.php.

References wfDeprecated().

◆ 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 383 of file Message.php.

Referenced by MediaWiki\Message\Converter\convertMessage(), CommentStore\encodeMessage(), and ApiAuthManagerHelper\formatMessage().

◆ 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 368 of file Message.php.

Referenced by CommentStore\encodeMessage().

◆ getLanguage()

Message::getLanguage ( )

Returns the Language of the Message.

Since: 1.23

Returns: Language

Definition at line 418 of file Message.php.

Referenced by TransformTooBigImageAreaError\__construct().

◆ getParams()

Message::getParams ( )

Returns the message parameters.

Since: 1.21

Returns: array

Implements MessageSpecifier.

Definition at line 394 of file Message.php.

Referenced by MediaWiki\Message\Converter\convertMessage(), CommentStore\encodeMessage(), and ApiAuthManagerHelper\formatMessage().

◆ 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 508 of file Message.php.

References $lang, $title, $wgForceUIMsgAsContentMsg, and 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: Message $this

Definition at line 793 of file Message.php.

References $wgForceUIMsgAsContentMsg.

◆ 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: Message $this

Exceptions

MWException

Definition at line 757 of file Message.php.

References $lang, $type, and Language\getCode().

Referenced by Status\msgInLang(), and 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 1029 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 1041 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 358 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 1141 of file Message.php.

References $type.

Referenced by ApiUpload\checkVerification(), MediaWiki\Message\Converter\convertMessageParam(), ApiQueryLanguageinfo\execute(), ApiPageSet\getAllowedParams(), ApiHelp\getHelpInternal(), ApiMain\modifyHelp(), ApiBase\parseMultiValue(), 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 first message key is returned.

Since: 1.18

Parameters

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

Returns: Message

Definition at line 485 of file Message.php.

References $keys.

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: Message

Definition at line 435 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.

Parameters

string | array | MessageSpecifier $value

Returns: Message

Exceptions

InvalidArgumentException

Since: 1.27

Definition at line 452 of file Message.php.

Referenced by PermissionsError\__construct(), ApiMain\errorMessagesFromException(), PasswordReset\execute(), ApiLogin\formatMessage(), HTMLForm\getMessage(), HTMLFormField\getMessage(), ApiErrorFormatter\getMessageFromException(), LocalizedException\getMessageObject(), UploadStashException\getMessageObject(), and MWExceptionRenderer\reportHTML().

◆ numParam()

static Message::numParam ( $num )

static

Since: 1.18

Parameters

mixed $num

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

Definition at line 1064 of file Message.php.

Referenced by ApiResult\addValue(), Article\confirmDelete(), ApiOptions\execute(), LogFormatter\formatParameterValue(), ApiUpload\getChunkResult(), MergeHistory\isValidMerge(), SpecialBlock\processForm(), SpecialSearch\showCreateLink(), SpecialWhatLinksHere\showIndirectLinks(), and MediaWikiTitleCodec\splitTitleString().

◆ 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: Message $this

Definition at line 591 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: Message $this

Definition at line 535 of file Message.php.

References $args.

Referenced by TransformTooBigImageAreaError\__construct().

◆ parse()

Message::parse ( )

Fully parse the text from wikitext to HTML.

Since: 1.17

Returns: string Parsed HTML.

Definition at line 956 of file Message.php.

Referenced by ApiHelp\wrap().

◆ parseAsBlock()

Message::parseAsBlock ( )

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

Since: 1.17

Returns: string HTML

Definition at line 992 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 1268 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.

Definition at line 980 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 1130 of file Message.php.

Referenced by CommentStoreComment\__construct(), ContentModelChange\createNewContent(), ApiChangeContentModel\execute(), ApiEditPage\execute(), EditPage\initialiseForm(), 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: Message $this

Definition at line 719 of file Message.php.

◆ rawParam()

static Message::rawParam ( $raw )

static

Since: 1.17

Parameters

mixed $raw

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

Definition at line 1053 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.

Returns: Message $this

Definition at line 570 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 1161 of file Message.php.

References $type.

◆ serialize()

Message::serialize ( )

See also: Serializable::serialize()

Since: 1.26

Returns: string

Definition at line 285 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: Message $this

Definition at line 738 of file Message.php.

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

Referenced by ApiAuthManagerHelper\formatMessage().

◆ 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: Message $this

Definition at line 813 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 1108 of file Message.php.

Referenced by UploadBase\checkFileSize().

◆ 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: Message $this

Definition at line 675 of file Message.php.

◆ text()

Message::text ( )

Returns the message text.

{{-transformation is done.

Since: 1.17

Returns: string Unescaped message text.

Definition at line 968 of file Message.php.

◆ timeperiodParam()

static Message::timeperiodParam ( $period )

static

Since: 1.22

Parameters

int $period

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

Definition at line 1097 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|int[] ...$params Time period parameters, or a single argument that is an array of time period parameters.

Returns: Message $this

Definition at line 654 of file Message.php.

◆ title()

Message::title ( $title )

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

Since: 1.18

Parameters

Title $title

Returns: Message $this

Definition at line 842 of file Message.php.

References $title.

◆ toString()

Message::toString ( $format = null )

Returns the message parsed from wikitext to HTML.

Since: 1.17

Parameters

string | null $format One of the FORMAT_* constants. Null means use whatever was used the last time (this is for B/C and should be avoided).

Returns: string HTML SecurityCheck-DoubleEscaped phan false positive

Definition at line 871 of file Message.php.

◆ transformText()

Message::transformText ( $string )

protected

Wrapper for what ever method we use to {{-transform wikitext.

Since: 1.17

Parameters

string $string Wikitext message contents.

Returns: string Wikitext with {{-constructs replaced with their values.

Definition at line 1298 of file Message.php.

◆ unserialize()

Message::unserialize ( $serialized )

See also: Serializable::unserialize()

Since: 1.35.6

Parameters

string $serialized

Definition at line 318 of file Message.php.

◆ useDatabase()

Message::useDatabase ( $useDatabase )

Enable or disable database use.

Since: 1.17

Parameters

bool $useDatabase

Returns: Message $this

Definition at line 827 of file Message.php.

Member Data Documentation

◆ $content

Content Message::$content = null

protected

Content object representing the message.

Definition at line 234 of file Message.php.

◆ $format

string Message::$format = 'parse'

protected

Deprecated:

Definition at line 219 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 190 of file Message.php.

Referenced by ApiHelpParamValueMessage\subMessage().

◆ $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 203 of file Message.php.

Referenced by __construct(), ApiMessage\__construct(), ApiRawMessage\__construct(), and ApiHelpParamValueMessage\subMessage().

◆ $keysToTry

string [] Message::$keysToTry

protected

List of keys to try when fetching the message.

Definition at line 208 of file Message.php.

◆ $language

Language bool Message::$language = false

protected

In which language to get this message.

Overrides the $interface setting.

Explicit language object, or false for user language

Definition at line 197 of file Message.php.

Referenced by __construct(), and ApiHelpParamValueMessage\subMessage().

◆ $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 177 of file Message.php.

◆ $message

string Message::$message

protected

Definition at line 239 of file Message.php.

Referenced by ApiHelpParamValueMessage\fetchMessage().

◆ $parameters

array Message::$parameters = []

protected

List of parameters which will be substituted into the message.

Definition at line 213 of file Message.php.

◆ $title

Title Message::$title = null

protected

Title object to use as context.

Definition at line 229 of file Message.php.

Referenced by ApiHelpParamValueMessage\subMessage().

◆ $useDatabase

bool Message::$useDatabase = true

protected

Whether database can be used.

Definition at line 224 of file Message.php.

Referenced by ApiHelpParamValueMessage\subMessage().

◆ 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 165 of file Message.php.

◆ FORMAT_ESCAPED

const Message::FORMAT_ESCAPED = 'escaped'

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

Definition at line 171 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 167 of file Message.php.

◆ FORMAT_PLAIN

const Message::FORMAT_PLAIN = 'plain'

Use message text as-is.

Definition at line 163 of file Message.php.

◆ FORMAT_TEXT

const Message::FORMAT_TEXT = 'text'

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

Definition at line 169 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:

Comparison with old wfMsg* functions:

Appendix:

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __serialize()

◆ __toString()

◆ __unserialize()

◆ bitrateParam()

◆ bitrateParams()

◆ content()

◆ durationParam()

◆ durationParams()

◆ escaped()

◆ exists()

◆ expiryParam()

◆ expiryParams()

◆ extractParam()

◆ fetchMessage()

◆ formatListParam()

◆ formatPlaintext()

◆ getFormat()

◆ getKey()

◆ getKeysToTry()

◆ getLanguage()

◆ getParams()

◆ getTitle()

◆ inContentLanguage()

◆ inLanguage()

◆ isBlank()

◆ isDisabled()

◆ isMultiKey()

◆ listParam()

◆ newFallbackSequence()

◆ newFromKey()

◆ newFromSpecifier()

◆ numParam()

◆ numParams()

◆ params()

◆ parse()

◆ parseAsBlock()

◆ parseText()

◆ plain()

◆ plaintextParam()

◆ plaintextParams()

◆ rawParam()

◆ rawParams()

◆ replaceParameters()

◆ serialize()

◆ setContext()

◆ setInterfaceMessageFlag()

◆ sizeParam()

◆ sizeParams()

◆ text()

◆ timeperiodParam()

◆ timeperiodParams()

◆ title()

◆ toString()

◆ transformText()

◆ unserialize()

◆ useDatabase()

Member Data Documentation

◆ $content

◆ $format

◆ $interface

◆ $key

◆ $keysToTry

◆ $language

◆ $listTypeMap

◆ $message

◆ $parameters