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)
 
 fetchMessage ()
 Fetch the message. More...
 
 getParamValue ()
 Fetch the parameter value. More...
 
 isDeprecated ()
 Fetch the 'deprecated' flag. More...
 
- Public Member Functions inherited from Message
 __construct ( $key, $params=[], Language $language=null)
 
 __toString ()
 Magic method implementation of the above (for PHP >= 5.2.0), so we can do, eg: $foo = new Message( $key ); $string = "<abbr>$foo</abbr>";. More...
 
 bitrateParams ()
 Add parameters that are bitrates and will be passed through Language::formatBitrate before substitution. More...
 
 content ()
 Returns the message as a Content object. More...
 
 durationParams ()
 Add parameters that are durations of time and will be passed through Language::formatDuration before substitution. More...
 
 escaped ()
 Returns the message text. More...
 
 exists ()
 Check whether a message key has been defined currently. More...
 
 expiryParams ()
 Add parameters that are expiration times and will be passed through Language::formatExpiry before substitution. More...
 
 getFormat ()
 Returns the message format. More...
 
 getKey ()
 Returns the message key. More...
 
 getKeysToTry ()
 
 getLanguage ()
 Returns the Language of the Message. More...
 
 getParams ()
 Returns the message parameters. More...
 
 getTitle ()
 Get a title object for a mediawiki message, where it can be found in the mediawiki namespace. More...
 
 inContentLanguage ()
 Request the message in the wiki's content language, unless it is disabled for this message. More...
 
 inLanguage ( $lang)
 Request the message in any language that is supported. More...
 
 isBlank ()
 Check whether a message does not exist, or is an empty string. More...
 
 isDisabled ()
 Check whether a message does not exist, is an empty string, or is "-". More...
 
 isMultiKey ()
 
 numParams ()
 Add parameters that are numeric and will be passed through Language::formatNum before substitution. More...
 
 params ()
 Adds parameters to the parameter list of this message. More...
 
 parse ()
 Fully parse the text from wikitext to HTML. More...
 
 parseAsBlock ()
 Returns the parsed message text which is always surrounded by a block element. More...
 
 plain ()
 Returns the message text as-is, only parameters are substituted. More...
 
 plaintextParams ()
 Add parameters that are plaintext and will be passed through without the content being evaluated. More...
 
 rawParams ()
 Add parameters that are substituted after parsing or escaping. More...
 
 serialize ()
 
 setContext (IContextSource $context)
 Set the language and the title from a context object. More...
 
 setInterfaceMessageFlag ( $interface)
 Allows manipulating the interface message flag directly. More...
 
 sizeParams ()
 Add parameters that are file sizes and will be passed through Language::formatSize before substitution. More...
 
 text ()
 Returns the message text. More...
 
 timeperiodParams ()
 Add parameters that are time periods and will be passed through Language::formatTimePeriod before substitution. More...
 
 title ( $title)
 Set the Title object to use as context when transforming the message. More...
 
 toString ( $format=null)
 Returns the message parsed from wikitext to HTML. More...
 
 unserialize ( $serialized)
 
 useDatabase ( $useDatabase)
 Enable or disable database use. More...
 

Protected Attributes

 $deprecated
 
 $paramValue
 
- Protected Attributes inherited from Message
Content $content = null
 Content object representing the message. More...
 
string $format = 'parse'
 
static array bool $interface = true
 In which language to get this message. More...
 
string $key
 The message key. More...
 
string [] $keysToTry
 List of keys to try when fetching the message. More...
 
Language bool $language = false
 In which language to get this message. More...
 
string $message
 
array $parameters = []
 List of parameters which will be substituted into the message. More...
 
Title $title = null
 Title object to use as context. More...
 
bool $useDatabase = true
 Whether database can be used. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Message
static bitrateParam ( $bitrate)
 
static durationParam ( $duration)
 
static expiryParam ( $expiry)
 
static listParam (array $list, $type='text')
 
static newFallbackSequence ()
 Factory function accepting multiple message keys and returning a message instance for the first message which is non-empty. More...
 
static newFromKey ( $key)
 Factory function that is just wrapper for the real constructor. More...
 
static newFromSpecifier ( $value)
 Transform a MessageSpecifier or a primitive value used interchangeably with specifiers (a message key string, or a key + params array) into a proper Message. More...
 
static numParam ( $num)
 
static plaintextParam ( $plaintext)
 
static rawParam ( $raw)
 
static sizeParam ( $size)
 
static timeperiodParam ( $period)
 
- Public Attributes inherited from Message
const FORMAT_BLOCK_PARSE = 'block-parse'
 Use normal wikitext -> HTML parsing (the result will be wrapped in a block-level HTML tag) More...
 
const FORMAT_ESCAPED = 'escaped'
 Transform {{..}} constructs, HTML-escape the result. More...
 
const FORMAT_PARSE = 'parse'
 Use normal wikitext -> HTML parsing but strip the block-level wrapper. More...
 
const FORMAT_PLAIN = 'plain'
 Use message text as-is. More...
 
const FORMAT_TEXT = 'text'
 Transform {{..}} constructs but don't transform to HTML. More...
 
- Protected Member Functions inherited from Message
 extractParam ( $param, $format)
 Extracts the parameter type and preprocessed the value if needed. More...
 
 fetchMessage ()
 Wrapper for what ever method we use to get message contents. More...
 
 formatListParam (array $params, $listType, $format)
 Formats a list of parameters as a concatenated string. More...
 
 formatPlaintext ( $plaintext, $format)
 Formats a message parameter wrapped with 'plaintext'. More...
 
 parseText ( $string)
 Wrapper for what ever method we use to parse wikitext. More...
 
 replaceParameters ( $message, $type, $format)
 Substitutes any parameters into the message text. More...
 
 transformText ( $string)
 Wrapper for what ever method we use to {{-transform wikitext. More...
 
- Static Protected Attributes inherited from Message
static array $listTypeMap
 Mapping from Message::listParam() types to Language methods. More...
 

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

Constructor & Destructor Documentation

◆ __construct()

ApiHelpParamValueMessage::__construct (   $paramValue,
  $text,
  $params = [],
  $deprecated = 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
Exceptions
InvalidArgumentException
Since
1.30 Added the $deprecated parameter

Definition at line 47 of file ApiHelpParamValueMessage.php.

References $deprecated, $params, and $paramValue.

Member Function Documentation

◆ fetchMessage()

ApiHelpParamValueMessage::fetchMessage ( )

Fetch the message.

Returns
string

Definition at line 74 of file ApiHelpParamValueMessage.php.

References Message\$interface, Message\$language, Message\$message, Message\$title, Message\$useDatabase, isDeprecated(), message, and null.

◆ getParamValue()

ApiHelpParamValueMessage::getParamValue ( )

Fetch the parameter value.

Returns
string

Definition at line 57 of file ApiHelpParamValueMessage.php.

References $paramValue.

◆ isDeprecated()

ApiHelpParamValueMessage::isDeprecated ( )

Fetch the 'deprecated' flag.

Since
1.30
Returns
bool

Definition at line 66 of file ApiHelpParamValueMessage.php.

References $deprecated.

Referenced by fetchMessage().

Member Data Documentation

◆ $deprecated

ApiHelpParamValueMessage::$deprecated
protected

Definition at line 35 of file ApiHelpParamValueMessage.php.

Referenced by __construct(), and isDeprecated().

◆ $paramValue

ApiHelpParamValueMessage::$paramValue
protected

Definition at line 34 of file ApiHelpParamValueMessage.php.

Referenced by __construct(), and getParamValue().


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