Message subclass that prepends wikitext for API help. More...

Inheritance diagram for ApiHelpParamValueMessage:

Collaboration diagram for ApiHelpParamValueMessage:

Public Member Functions
	__construct ( $paramValue, $text, $params=[], $deprecated=false)

	fetchMessage ()
	Fetch the message. More...

	getParamValue ()
	Fetch the parameter value. More...

	isDeprecated ()
	Fetch the 'deprecated' flag. More...

Protected Attributes
	$deprecated

	$paramValue

Detailed Description

Message subclass that prepends wikitext for API help.

This exists so the apihelp-*-paramvalue-*-* messages don't all have to include markup wikitext while still keeping the 'APIGetParamDescriptionMessages' hook simple.

Since: 1.25

Definition at line 36 of file ApiHelpParamValueMessage.php.

Constructor & Destructor Documentation

◆ __construct()

ApiHelpParamValueMessage::__construct	(	$paramValue,
		$text,
		$params = `[]`,
		$deprecated = `false`
	)

See also: Message::__construct

Parameters

string	$paramValue	Parameter value being documented
string	$text	Message to use.
array	$params	Parameters for the message.
bool	$deprecated	Whether the value is deprecated