MediaWiki  REL1_31
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. 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...
 
 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.

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, and wfDeprecated().

Member Data Documentation

◆ $mCodestr

UsageException::$mCodestr
private

Definition at line 29 of file ApiUsageException.php.

Referenced by getCodeString(), and getMessageArray().

◆ $mExtraData

null array UsageException::$mExtraData
private

Definition at line 34 of file ApiUsageException.php.


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