ApiRawMessage Class Reference
Extension of RawMessage implementing IApiMessage. More...
Inheritance diagram for ApiRawMessage:
Collaboration diagram for ApiRawMessage:
Public Member Functions | |
| __construct ( $msg, $code=null, array $data=null) | |
 Public Member Functions inherited from RawMessage | |
| __construct ( $text, $params=[]) | |
| Call the parent constructor, then store the key as the message. More... | |
| fetchMessage () | |
| Fetch the message (in this case, the key). More... | |
| 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... | |
Detailed Description
Extension of RawMessage implementing IApiMessage.
- Since
- 1.25
Definition at line 26 of file ApiRawMessage.php.
Constructor & Destructor Documentation
◆ __construct()
| ApiRawMessage::__construct | ( | $msg, | |
$code = null, |
|||
| array | $data = null |
||
| ) |
- Parameters
-
RawMessage | string | array $msg - RawMessage: is cloned
- array: first element is $key, rest are $params to RawMessage::__construct
- string: passed to RawMessage::__construct
string | null $code array | null $data
Definition at line 37 of file ApiRawMessage.php.
References IApiMessage\setApiCode().
The documentation for this class was generated from the following file:
- includes/api/ApiRawMessage.php
