Value object representing a message parameter that consists of a list of values. More...

Inherits MediaWiki\Json\JsonDeserializable.

Inherited by Wikimedia\Message\ListParam, and Wikimedia\Message\ScalarParam.

Collaboration diagram for Wikimedia\Message\MessageParam:

[legend]

Public Member Functions
	dump ()
	Dump the object for testing/debugging.

	getType ()
	Get the type of the parameter.

	getValue ()
	Get the input value of the parameter.

Protected Attributes
string	$type

mixed	$value

Additional Inherited Members
Static Public Member Functions inherited from MediaWiki\Json\JsonDeserializable
static	newFromJsonArray (JsonDeserializer $deserializer, array $json)
	Creates a new instance of the class and initialized it from the $json array.

Detailed Description

Value object representing a message parameter that consists of a list of values.

Message parameter classes are pure value objects and are newable and (de)serializable.

Definition at line 13 of file MessageParam.php.

Member Function Documentation

◆ dump()

Wikimedia\Message\MessageParam::dump ( )

abstract

Dump the object for testing/debugging.

Returns: string

Reimplemented in Wikimedia\Message\ListParam, and Wikimedia\Message\ScalarParam.

◆ getType()

Wikimedia\Message\MessageParam::getType ( )

Get the type of the parameter.

Returns: string One of the ParamType constants

Definition at line 26 of file MessageParam.php.

References Wikimedia\Message\MessageParam\$type.

Referenced by MediaWiki\Message\Message\formatListParam(), and MediaWiki\Message\Message\params().

◆ getValue()

Wikimedia\Message\MessageParam::getValue ( )

Get the input value of the parameter.

Returns: mixed

Definition at line 35 of file MessageParam.php.

References Wikimedia\Message\MessageParam\$value.

Member Data Documentation

◆ $type

string Wikimedia\Message\MessageParam::$type

protected

Definition at line 17 of file MessageParam.php.

Referenced by Wikimedia\Message\ScalarParam\__construct(), and Wikimedia\Message\MessageParam\getType().

◆ $value

mixed Wikimedia\Message\MessageParam::$value

protected

Definition at line 19 of file MessageParam.php.

Referenced by Wikimedia\Message\ScalarParam\__construct(), and Wikimedia\Message\MessageParam\getValue().

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

includes/libs/Message/MessageParam.php

Public Member Functions

Protected Attributes

Additional Inherited Members