MediaWiki  master
Wikimedia\Message\MessageParam Class Reference

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

Inheritance diagram for Wikimedia\Message\MessageParam:

Public Member Functions

 dump ()
 Dump the object for testing/debugging. More...
 
 getType ()
 Get the type of the parameter. More...
 
 getValue ()
 Get the input value of the parameter. More...
 

Protected Attributes

 $type
 
 $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 safely newable.

Definition at line 10 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 19 of file MessageParam.php.

References Wikimedia\Message\MessageParam\$type.

◆ getValue()

Wikimedia\Message\MessageParam::getValue ( )

Get the input value of the parameter.

Returns
mixed

Definition at line 28 of file MessageParam.php.

References Wikimedia\Message\MessageParam\$value.

Member Data Documentation

◆ $type

Wikimedia\Message\MessageParam::$type
protected

◆ $value

Wikimedia\Message\MessageParam::$value
protected

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