Wikimedia\Message\ListParam Class Reference

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

Inherits Wikimedia\Message\MessageParam.

Collaboration diagram for Wikimedia\Message\ListParam:

Public Member Functions
	__construct (string|ListType $listType, array $elements)
	__wakeup ()
	dump ()
	Dump the object for testing/debugging.
	getListType ()
	Get the type of the list.
	isSameAs (MessageParam $mp)
	Equality testing.
	toJsonArray ()
Public Member Functions inherited from Wikimedia\Message\MessageParam
	getType ()
	Get the type of the parameter.
	getValue ()
	Get the input value of the parameter.

Static Public Member Functions
static	jsonClassHintFor (string $keyName)
static	newFromJsonArray (array $json)
Static Public Member Functions inherited from Wikimedia\Message\MessageParam
static	hint ()
	If you are serializing a MessageParam, use this JsonCodec hint to suppress unnecessary type information.

Additional Inherited Members
Protected Attributes inherited from Wikimedia\Message\MessageParam
ParamType	$type
mixed	$value

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.

Stability: newable

Definition at line 15 of file ListParam.php.

Constructor & Destructor Documentation

__construct()

Wikimedia\Message\ListParam::__construct	(	string|ListType	$listType,
		array	$elements )

Stability: stable

to call.

Parameters

string | ListType	$listType	One of the ListType constants.
	(MessageParam|MessageSpecifier|string|int|float)[]	$elements Values in the list. Values that are not instances of MessageParam are wrapped using ParamType::TEXT.

Definition at line 29 of file ListParam.php.

References wfDeprecated().

Member Function Documentation

__wakeup()

Wikimedia\Message\ListParam::__wakeup

(

)

Reimplemented from Wikimedia\Message\MessageParam.

Definition at line 111 of file ListParam.php.

dump()

Wikimedia\Message\ListParam::dump

(

)

Dump the object for testing/debugging.

Returns

string

Reimplemented from Wikimedia\Message\MessageParam.

Definition at line 55 of file ListParam.php.

getListType()

Wikimedia\Message\ListParam::getListType

(

)

Get the type of the list.

Returns

ListType One of the ListType constants

Definition at line 51 of file ListParam.php.

isSameAs()

Wikimedia\Message\ListParam::isSameAs

(

MessageParam

$mp

)

Equality testing.

Reimplemented from Wikimedia\Message\MessageParam.

Definition at line 63 of file ListParam.php.

jsonClassHintFor()

static Wikimedia\Message\ListParam::jsonClassHintFor ( string $keyName )

static

Reimplemented from Wikimedia\Message\MessageParam.

Definition at line 90 of file ListParam.php.

Referenced by Wikimedia\Message\MessageParam\jsonClassHintFor().

newFromJsonArray()

static Wikimedia\Message\ListParam::newFromJsonArray ( array $json )

static

Reimplemented from Wikimedia\Message\MessageParam.

Definition at line 102 of file ListParam.php.

Referenced by Wikimedia\Message\MessageParam\newFromJsonArray().

toJsonArray()

Wikimedia\Message\ListParam::toJsonArray

(

)

Definition at line 73 of file ListParam.php.

---

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

• includes/libs/Message/ListParam.php