MediaWiki  master
ApiMessage Class Reference

Extension of Message implementing IApiMessage. More...

Inheritance diagram for ApiMessage:
Collaboration diagram for ApiMessage:

Public Member Functions

 __construct ( $msg, $code=null, array $data=null)
 
- Public Member Functions inherited from IApiMessage
 getApiCode ()
 Returns a machine-readable code for use by the API. More...
 
 getApiData ()
 Returns additional machine-readable data about the error condition. More...
 
 setApiCode ( $code, array $data=null)
 Sets the machine-readable code for use by the API. More...
 
 setApiData (array $data)
 Sets additional machine-readable data about the error condition. More...
 
- Public Member Functions inherited from MessageSpecifier
 getKey ()
 Returns the message key. More...
 
 getParams ()
 Returns the message parameters. More...
 

Static Public Member Functions

static create ( $msg, $code=null, array $data=null)
 Create an IApiMessage for the message. More...
 

Detailed Description

Extension of Message implementing IApiMessage.

Since
1.25

Definition at line 26 of file ApiMessage.php.

Constructor & Destructor Documentation

◆ __construct()

ApiMessage::__construct (   $msg,
  $code = null,
array  $data = null 
)
Parameters
Message | string | array$msg
  • Message: is cloned
  • array: first element is $key, rest are $params to Message::__construct
  • string: passed to Message::__construct
string | null$code
array | null$data

Definition at line 74 of file ApiMessage.php.

References IApiMessage\setApiCode().

Member Function Documentation

◆ create()


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