BlueSpice MediaWiki REL1_27
 All Classes Namespaces Files Functions Variables Groups Pages
ApiHelpParamValueMessage Class Reference
Inheritance diagram for ApiHelpParamValueMessage:
Collaboration diagram for ApiHelpParamValueMessage:

Public Member Functions

 __construct ($paramValue, $text, $params=[])
 
 getParamValue ()
 
 fetchMessage ()
 
- Public Member Functions inherited from Message
 __construct ($key, $params=[], Language $language=null)
 
 serialize ()
 
 unserialize ($serialized)
 
 isMultiKey ()
 
 getKeysToTry ()
 
 getKey ()
 
 getParams ()
 
 getFormat ()
 
 getLanguage ()
 
 getTitle ()
 
 params ()
 
 rawParams ()
 
 numParams ()
 
 durationParams ()
 
 expiryParams ()
 
 timeperiodParams ()
 
 sizeParams ()
 
 bitrateParams ()
 
 plaintextParams ()
 
 setContext (IContextSource $context)
 
 inLanguage ($lang)
 
 inContentLanguage ()
 
 setInterfaceMessageFlag ($interface)
 
 useDatabase ($useDatabase)
 
 title ($title)
 
 content ()
 
 toString ()
 
 __toString ()
 
 parse ()
 
 text ()
 
 plain ()
 
 parseAsBlock ()
 
 escaped ()
 
 exists ()
 
 isBlank ()
 
 isDisabled ()
 

Protected Attributes

 $paramValue
 
- Protected Attributes inherited from Message
 $interface = true
 
 $language = false
 
 $key
 
 $keysToTry
 
 $parameters = []
 
 $format = 'parse'
 
 $useDatabase = true
 
 $title = null
 
 $content = null
 
 $message
 

Additional Inherited Members

- Static Public Member Functions inherited from Message
static newFromKey ($key)
 
static newFromSpecifier ($value)
 
static newFallbackSequence ()
 
static rawParam ($raw)
 
static numParam ($num)
 
static durationParam ($duration)
 
static expiryParam ($expiry)
 
static timeperiodParam ($period)
 
static sizeParam ($size)
 
static bitrateParam ($bitrate)
 
static plaintextParam ($plaintext)
 
- Protected Member Functions inherited from Message
 replaceParameters ($message, $type= 'before')
 
 extractParam ($param)
 
 parseText ($string)
 
 transformText ($string)
 
 fetchMessage ()
 
 formatPlaintext ($plaintext)
 

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

Constructor & Destructor Documentation

ApiHelpParamValueMessage::__construct (   $paramValue,
  $text,
  $params = [] 
)
See Also
Message::__construct
Parameters
string$paramValueParameter value being documented
string$textMessage to use.
array$paramsParameters for the message.
Exceptions
InvalidArgumentException

Member Function Documentation

ApiHelpParamValueMessage::fetchMessage ( )

Fetch the message.

Returns
string
ApiHelpParamValueMessage::getParamValue ( )

Fetch the parameter value

Returns
string

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