BlueSpice MediaWiki REL1_27
 All Classes Namespaces Files Functions Variables Groups Pages
ApiMessage Class Reference
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 ()
 
 getApiData ()
 
 setApiCode ($code, array $data=null)
 
 setApiData (array $data)
 
- Public Member Functions inherited from MessageSpecifier
 getKey ()
 
 getParams ()
 

Static Public Member Functions

static create ($msg, $code=null, array $data=null)
 

Detailed Description

Extension of Message implementing IApiMessage

Since
1.25

Constructor & Destructor Documentation

ApiMessage::__construct (   $msg,
  $code = null,
array  $data = null 
)
Parameters
Message | string | array$msg
string | null$code
array | null$data
Returns
ApiMessage

Member Function Documentation

static ApiMessage::create (   $msg,
  $code = null,
array  $data = null 
)
static

Create an IApiMessage for the message

This returns $msg if it's an IApiMessage, calls 'new ApiRawMessage' if $msg is a RawMessage, or calls 'new ApiMessage' in all other cases.

Parameters
Message | RawMessage | array | string$msg
string | null$code
array | null$data
Returns
ApiMessage

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