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. More... | |
| getPageTitle () | |
| Return the title of the page when reporting this error in a HTTP response. More... | |
| getText () | |
| Get the text to display when reporting the error on the command line. More... | |
| isLoggable () | |
| Whether to log this exception in the exception debug log. More... | |
| msg ($key, $fallback) | |
| Get a message from i18n. More... | |
| report () | |
| Output a report about the exception and takes care of formatting. More... | |
| reportHTML () | |
| Output the exception report using HTML. More... | |
| runHooks ($name, $args=[]) | |
| Run hook to allow extensions to modify the text of the exception. More... | |
| useMessageCache () | |
| Can the extension use the Message class/wfMessage to get i18n-ed messages? More... | |
| useOutputPage () | |
| Should the exception use $wgOut to output the error? More... | |
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. More... | |
Detailed Description
This exception will be thrown when dieUsage is called to stop module execution.
Definition at line 1947 of file ApiMain.php.
Constructor & Destructor Documentation
| UsageException::__construct | ( | $message, | |
| $codestr, | |||
$code = 0, |
|||
$extradata = null |
|||
| ) |
- Parameters
-
string $message string $codestr int $code array | null $extradata
Definition at line 1962 of file ApiMain.php.
References $code.
Member Function Documentation
| UsageException::__toString | ( | ) |
- Returns
- string
Definition at line 2001 of file ApiMain.php.
| UsageException::getCodeString | ( | ) |
- Returns
- string
Definition at line 1979 of file ApiMain.php.
References $mCodestr.
Referenced by ApiOptionsTest\testAnon(), ApiMainTest\testAssert(), ApiEditPageTest\testEdit_redirectText(), ApiEditPageTest\testEditConflict(), ApiEditPageTest\testEditSection(), ApiOptionsTest\testNoChanges(), ApiOptionsTest\testNoOptionname(), ApiParseTest\testParseNonexistentPage(), and ApiWatchTest\testWatchRollback().
| UsageException::getMessageArray | ( | ) |
- Returns
- array
Definition at line 1986 of file ApiMain.php.
References $mCodestr.
Referenced by ApiParseTest\testParseNonexistentPage().
Member Data Documentation
|
private |
Definition at line 1949 of file ApiMain.php.
Referenced by getCodeString(), and getMessageArray().
|
private |
Definition at line 1954 of file ApiMain.php.
The documentation for this class was generated from the following file:
- includes/api/ApiMain.php
