Extension of Message implementing IApiMessage. More...

Collaboration diagram for ApiMessage:

[legend]

Public Member Functions
	__construct ( $msg, $code=null, array $data=null)

Public Member Functions inherited from Message
	__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.

Public Member Functions inherited from IApiMessage
	getApiCode ()
	Returns a machine-readable code for use by the API.

	getApiData ()
	Returns additional machine-readable data about the error condition.

	setApiCode ( $code, array $data=null)
	Sets the machine-readable code for use by the API.

	setApiData (array $data)
	Sets additional machine-readable data about the error condition.

Static Public Member Functions
static	create ( $msg, $code=null, array $data=null)
	Create an IApiMessage for the message.

Static Public Member Functions inherited from Message
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)

Additional Inherited Members
Public Attributes inherited from Message
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 inherited from Message
	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 inherited from Message
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 inherited from Message
static array	$listTypeMap
	Mapping from Message::listParam() types to Language methods.

Detailed Description

Extension of Message implementing IApiMessage.

Stability: newable

Since: 1.25

Definition at line 29 of file ApiMessage.php.

Constructor & Destructor Documentation

◆ __construct()

ApiMessage::__construct	(		$msg,
			$code = null,
		array	$data = null )

Parameters

Message \| string \| array	$msg	Message: is cloned array: first element is $key, rest are $params to Message::__construct string: passed to Message::__construct
string \| null	$code
array \| null	$data

Definition at line 79 of file ApiMessage.php.

References Message\$key, and setApiCode().

Member Function Documentation

◆ create()

static ApiMessage::create	(		$msg,
			$code = null,
		array	$data = null )

static

Create an IApiMessage for the message.

This returns $msg if it's an IApiMessage, calls 'new ApiRawMessage' if $msg is a RawMessage, or calls 'new ApiMessage' in all other cases.

Stability: stable: to call

Parameters

Message \| RawMessage \| array \| string	$msg
string \| null	$code
array \| null	$data

Returns: IApiMessage

Parameters

-taint $msg tainted

Definition at line 45 of file ApiMessage.php.

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

includes/api/ApiMessage.php

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ create()