MediaWiki  master
ApiHelpParamValueMessage Class Reference

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, $internal=false)
 
 fetchMessage ()
 Fetch the message. More...
 
 getParamValue ()
 Fetch the parameter value. More...
 
 isDeprecated ()
 Fetch the 'deprecated' flag. More...
 
 isInternal ()
 Fetch the 'internal' flag. More...
 

Protected Attributes

 $deprecated
 
 $internal
 
 $paramValue
 

Private Member Functions

 subMessage ( $key)
 

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 33 of file ApiHelpParamValueMessage.php.

Constructor & Destructor Documentation

◆ __construct()

ApiHelpParamValueMessage::__construct (   $paramValue,
  $text,
  $params = [],
  $deprecated = false,
  $internal = false 
)
See also
Message::__construct
Parameters
string$paramValueParameter value being documented
string$textMessage to use.
array$paramsParameters for the message.
bool$deprecatedWhether the value is deprecated
bool$internalWhether the value is internal
Exceptions
InvalidArgumentException
Since
1.30 Added the $deprecated parameter
1.35 Added the $internal parameter

Definition at line 51 of file ApiHelpParamValueMessage.php.

References $deprecated, $internal, and $paramValue.

Member Function Documentation

◆ fetchMessage()

ApiHelpParamValueMessage::fetchMessage ( )

Fetch the message.

Returns
string

Definition at line 94 of file ApiHelpParamValueMessage.php.

References isDeprecated(), isInternal(), and subMessage().

◆ getParamValue()

ApiHelpParamValueMessage::getParamValue ( )

Fetch the parameter value.

Returns
string

Definition at line 68 of file ApiHelpParamValueMessage.php.

References $paramValue.

◆ isDeprecated()

ApiHelpParamValueMessage::isDeprecated ( )

Fetch the 'deprecated' flag.

Since
1.30
Returns
bool

Definition at line 77 of file ApiHelpParamValueMessage.php.

References $deprecated.

Referenced by fetchMessage().

◆ isInternal()

ApiHelpParamValueMessage::isInternal ( )

Fetch the 'internal' flag.

Since
1.35
Returns
bool

Definition at line 86 of file ApiHelpParamValueMessage.php.

References $internal.

Referenced by fetchMessage().

◆ subMessage()

ApiHelpParamValueMessage::subMessage (   $key)
private

Definition at line 115 of file ApiHelpParamValueMessage.php.

References $title.

Referenced by fetchMessage().

Member Data Documentation

◆ $deprecated

ApiHelpParamValueMessage::$deprecated
protected

Definition at line 36 of file ApiHelpParamValueMessage.php.

Referenced by __construct(), and isDeprecated().

◆ $internal

ApiHelpParamValueMessage::$internal
protected

Definition at line 37 of file ApiHelpParamValueMessage.php.

Referenced by __construct(), and isInternal().

◆ $paramValue

ApiHelpParamValueMessage::$paramValue
protected

Definition at line 35 of file ApiHelpParamValueMessage.php.

Referenced by __construct(), and getParamValue().


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