ApiHelpParamValueMessage Class Reference

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

Inherits Message.

Collaboration diagram for ApiHelpParamValueMessage:

Public Member Functions
	__construct ( $paramValue, $text, $params=[], $deprecated=false, $internal=false)
	fetchMessage ()
	getParamValue ()
	Fetch the parameter value.
	isDeprecated ()
	Fetch the 'deprecated' flag.
	isInternal ()
	Fetch the 'internal' flag.

Protected Attributes
	$deprecated
	$internal
	$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.

Stability: newable

Since

1.25

Definition at line 34 of file ApiHelpParamValueMessage.php.

Constructor & Destructor Documentation

__construct()

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

See also

Message::__construct

Stability: stable

to call

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
bool	$internal	Whether the value is internal

Exceptions

InvalidArgumentException

Since

1.30 Added the $deprecated parameter

1.35 Added the $internal parameter

Definition at line 53 of file ApiHelpParamValueMessage.php.

References $deprecated, $internal, $params, and $paramValue.

Member Function Documentation

fetchMessage()

ApiHelpParamValueMessage::fetchMessage

(

)

Returns

string

Definition at line 95 of file ApiHelpParamValueMessage.php.

References isDeprecated(), and isInternal().

getParamValue()

ApiHelpParamValueMessage::getParamValue

(

)

Fetch the parameter value.

Returns

string

Definition at line 70 of file ApiHelpParamValueMessage.php.

References $paramValue.

isDeprecated()

ApiHelpParamValueMessage::isDeprecated

(

)

Fetch the 'deprecated' flag.

Since

1.30

Returns

bool

Definition at line 79 of file ApiHelpParamValueMessage.php.

References $deprecated.

Referenced by fetchMessage().

isInternal()

ApiHelpParamValueMessage::isInternal

(

)

Fetch the 'internal' flag.

Since

1.35

Returns

bool

Definition at line 88 of file ApiHelpParamValueMessage.php.

References $internal.

Referenced by fetchMessage().

Member Data Documentation

$deprecated

ApiHelpParamValueMessage::$deprecated

protected

Definition at line 37 of file ApiHelpParamValueMessage.php.

Referenced by __construct(), and isDeprecated().

$internal

ApiHelpParamValueMessage::$internal

protected

Definition at line 38 of file ApiHelpParamValueMessage.php.

Referenced by __construct(), and isInternal().

$paramValue

ApiHelpParamValueMessage::$paramValue

protected

Definition at line 36 of file ApiHelpParamValueMessage.php.

Referenced by __construct(), and getParamValue().

---

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

• includes/api/ApiHelpParamValueMessage.php