Wikimedia\Message\ScalarParam Class Reference

Value object representing a message parameter holding a single value. More...

Inheritance diagram for Wikimedia\Message\ScalarParam:

Collaboration diagram for Wikimedia\Message\ScalarParam:

Public Member Functions
	__construct ( $type, $value)
	Construct a text parameter.
	dump ()
	Dump the object for testing/debugging.
Public Member Functions inherited from Wikimedia\Message\MessageParam
	getType ()
	Get the type of the parameter.
	getValue ()
	Get the input value of the parameter.

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

Detailed Description

Value object representing a message parameter holding a single value.

Message parameter classes are pure value objects and are safely newable.

@newable

Definition at line 12 of file ScalarParam.php.

Constructor & Destructor Documentation

__construct()

Wikimedia\Message\ScalarParam::__construct	(		$type,
			$value
	)

Construct a text parameter.

Stability: stable

to call.

Parameters

string	$type	One of the ParamType constants.
string | int | float | MessageValue	$value

Definition at line 21 of file ScalarParam.php.

References Wikimedia\Message\MessageParam\$type, Wikimedia\Message\MessageParam\$value, and Wikimedia\Message\ParamType\LIST.

Member Function Documentation

dump()

Wikimedia\Message\ScalarParam::dump

(

)

Dump the object for testing/debugging.

Returns

string

Reimplemented from Wikimedia\Message\MessageParam.

Definition at line 38 of file ScalarParam.php.

---

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

• includes/libs/Message/ScalarParam.php