MediaWiki  1.29.2
MWException Class Reference

MediaWiki exception. More...

Inheritance diagram for MWException:
Collaboration diagram for MWException:

Public Member Functions

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

Static Public Member Functions

static isCommandLine ()
 Check whether we are in command line mode or not to report the exception in the correct format. More...
 

Static Private Member Functions

static header ( $header)
 Send a header, if we haven't already sent them. More...
 
static statusHeader ( $code)
 

Detailed Description

MediaWiki exception.

Examples
/src/tests/phpunit/MediaWikiTestCase.php.

Definition at line 26 of file MWException.php.

Member Function Documentation

◆ getHTML()

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.

Returns
string Html to output

Reimplemented in HttpError, and FatalError.

Definition at line 105 of file MWException.php.

References $type, class, MWExceptionHandler\getLogMessage(), MWExceptionHandler\getRedactedTraceAsString(), WebRequest\getRequestId(), MWExceptionHandler\getURL(), global, and msg().

Referenced by reportHTML().

◆ getPageTitle()

MWException::getPageTitle ( )

Return the title of the page when reporting this error in a HTTP response.

Returns
string

Definition at line 157 of file MWException.php.

References msg().

Referenced by reportHTML().

◆ getText()

MWException::getText ( )

Get the text to display when reporting the error on the command line.

If $wgShowExceptionDetails is true, return a text message with a backtrace to the error.

Returns
string

Reimplemented in FatalError.

Definition at line 140 of file MWException.php.

References MWExceptionHandler\getLogMessage(), MWExceptionHandler\getRedactedTraceAsString(), and global.

Referenced by ChangePassword\execute(), CreateAndPromote\execute(), and report().

◆ header()

static MWException::header (   $header)
staticprivate

Send a header, if we haven't already sent them.

We shouldn't, but sometimes we might in a weird case like Export

Parameters
string$header

Definition at line 241 of file MWException.php.

References $header.

Referenced by HttpError\__construct(), HttpError\getHTML(), HttpError\report(), report(), and reportHTML().

◆ isCommandLine()

static MWException::isCommandLine ( )
static

Check whether we are in command line mode or not to report the exception in the correct format.

Returns
bool

Definition at line 232 of file MWException.php.

References $GLOBALS.

◆ isLoggable()

MWException::isLoggable ( )

Whether to log this exception in the exception debug log.

Since
1.23
Returns
bool

Reimplemented in HttpError.

Definition at line 45 of file MWException.php.

◆ msg()

MWException::msg (   $key,
  $fallback 
)

Get a message from i18n.

Parameters
string$keyMessage name
string$fallbackDefault message if the message cache can't be called by the exception The function also has other parameters that are arguments for the message
Returns
string Message with arguments replaced

Definition at line 86 of file MWException.php.

References $args, $e, $fallback, useMessageCache(), wfMessage(), and wfMsgReplaceArgs().

Referenced by ErrorPageError\__construct(), UploadChunkVerificationException\__construct(), getHTML(), ErrorPageError\getMessageObject(), getPageTitle(), ErrorPageError\report(), UserNotLoggedIn\report(), and reportHTML().

◆ report()

MWException::report ( )

Output a report about the exception and takes care of formatting.

It will be either HTML or plain text based on isCommandLine().

Reimplemented in LocalFileLockError, UserNotLoggedIn, HttpError, PermissionsError, ErrorPageError, ThrottledError, and BadRequestError.

Definition at line 203 of file MWException.php.

References class, getText(), global, header(), reportHTML(), statusHeader(), and wfHttpError().

◆ reportHTML()

MWException::reportHTML ( )

Output the exception report using HTML.

Definition at line 164 of file MWException.php.

References $wgOut, $wgSitename, class, getHTML(), getPageTitle(), global, header(), msg(), runHooks(), and useOutputPage().

Referenced by report().

◆ runHooks()

MWException::runHooks (   $name,
  $args = [] 
)

Run hook to allow extensions to modify the text of the exception.

Parameters
string$nameClass name of the exception
array$argsArguments to pass to the callback functions
Returns
string|null String to output or null if any hook has been called

Definition at line 73 of file MWException.php.

References $args, $name, and MWExceptionRenderer\runHooks().

Referenced by reportHTML().

◆ statusHeader()

static MWException::statusHeader (   $code)
staticprivate

Definition at line 246 of file MWException.php.

References $code, and HttpStatus\header().

Referenced by report().

◆ useMessageCache()

MWException::useMessageCache ( )

Can the extension use the Message class/wfMessage to get i18n-ed messages?

Returns
bool

Definition at line 54 of file MWException.php.

References $wgLang, as, and global.

Referenced by msg(), and useOutputPage().

◆ useOutputPage()

MWException::useOutputPage ( )

Should the exception use $wgOut to output the error?

Returns
bool

Definition at line 32 of file MWException.php.

References $GLOBALS, and useMessageCache().

Referenced by reportHTML().


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