This exception will be thrown when dieUsage is called to stop module execution. More...
Public Member Functions | |
| __construct ( $message, $codestr, $code=0, $extradata=null) | |
| __toString () | |
| getCodeString () | |
| getMessageArray () | |
 Public Member Functions inherited from MWException | |
| getHTML () | |
| If $wgShowExceptionDetails is true, return a HTML message with a backtrace to the error, otherwise show a message to ask to set it to true to show that information. | |
| getPageTitle () | |
| Return the title of the page when reporting this error in a HTTP response. | |
| getText () | |
| Get the text to display when reporting the error on the command line. | |
| isLoggable () | |
| Whether to log this exception in the exception debug log. | |
| msg ( $key, $fallback) | |
| Get a message from i18n. | |
| report () | |
| Output a report about the exception and takes care of formatting. | |
| reportHTML () | |
| Output the exception report using HTML. | |
| useMessageCache () | |
| Can the extension use the Message class/wfMessage to get i18n-ed messages? | |
| useOutputPage () | |
| Should the exception use $wgOut to output the error? | |
Private Attributes | |
| $mCodestr | |
| null array | $mExtraData |
Additional Inherited Members | |
| Static Public Member Functions inherited from MWException | |
| static | isCommandLine () |
| Check whether we are in command line mode or not to report the exception in the correct format. | |
Detailed Description
This exception will be thrown when dieUsage is called to stop module execution.
- Deprecated
- since 1.29, use ApiUsageException instead
Definition at line 27 of file ApiUsageException.php.
Constructor & Destructor Documentation
◆ __construct()
| UsageException::__construct | ( | $message, | |
| $codestr, | |||
| $code = 0, | |||
| $extradata = null ) |
- Parameters
-
string $message string $codestr int $code array | null $extradata
Definition at line 42 of file ApiUsageException.php.
References $code, and wfDeprecated().
Member Function Documentation
◆ __toString()
| UsageException::__toString | ( | ) |
- Returns
- string
Reimplemented in ApiUsageException.
Definition at line 87 of file ApiUsageException.php.
◆ getCodeString()
| UsageException::getCodeString | ( | ) |
- Returns
- string
Reimplemented in ApiUsageException.
Definition at line 63 of file ApiUsageException.php.
References $mCodestr, and wfDeprecated().
◆ getMessageArray()
| UsageException::getMessageArray | ( | ) |
- Returns
- array
Reimplemented in ApiUsageException.
Definition at line 71 of file ApiUsageException.php.
References $mCodestr, $result, and wfDeprecated().
Member Data Documentation
◆ $mCodestr
|
private |
Definition at line 29 of file ApiUsageException.php.
Referenced by getCodeString(), and getMessageArray().
◆ $mExtraData
|
private |
Definition at line 34 of file ApiUsageException.php.
The documentation for this class was generated from the following file:
- includes/api/ApiUsageException.php
