MediaWiki REL1_28
UsageException Class Reference

This exception will be thrown when dieUsage is called to stop module execution. More...

Inheritance diagram for UsageException:
Collaboration diagram for UsageException:

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.
 runHooks ( $name, $args=[])
 Run hook to allow extensions to modify the text of the exception.
 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

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.

Definition at line 1860 of file ApiMain.php.

Constructor & Destructor Documentation

◆ __construct()

UsageException::__construct (   $message,
  $code = 0,
  $extradata = null 
array | null$extradata

Definition at line 1875 of file ApiMain.php.

References $code.

Member Function Documentation

◆ __toString()

UsageException::__toString ( )

Definition at line 1914 of file ApiMain.php.

◆ getCodeString()

UsageException::getCodeString ( )

◆ getMessageArray()

UsageException::getMessageArray ( )

Definition at line 1899 of file ApiMain.php.

References $mCodestr.

Referenced by ApiParseTest\testParseNonexistentPage().

Member Data Documentation

◆ $mCodestr


Definition at line 1862 of file ApiMain.php.

Referenced by getCodeString(), and getMessageArray().

◆ $mExtraData

null array UsageException::$mExtraData

Definition at line 1867 of file ApiMain.php.

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