MediaWiki  master
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,... $params)
 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...
 

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

Private Member Functions

 writeToCommandLine ( $message)
 Write a message to stderr falling back to stdout if stderr unavailable. 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.

@newable Stable to extend

Definition at line 29 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.

Stable to override

Returns
string Html to output

Reimplemented in HttpError, and FatalError.

Definition at line 112 of file MWException.php.

References $type, $wgShowExceptionDetails, Html\errorBox(), MWExceptionHandler\getLogMessage(), MWExceptionHandler\getRedactedTraceAsString(), WebRequest\getRequestId(), MWExceptionHandler\getURL(), and msg().

Referenced by reportHTML(), and wfStreamThumb().

◆ getPageTitle()

MWException::getPageTitle ( )

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

Stable to override

Returns
string

Definition at line 168 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.

Stable to override

Returns
string

Reimplemented in FatalError.

Definition at line 149 of file MWException.php.

References $wgShowExceptionDetails, MWExceptionHandler\getLogMessage(), and MWExceptionHandler\getRedactedTraceAsString().

Referenced by DatabaseInstaller\doUpgrade(), PPFuzzTester\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 265 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 256 of file MWException.php.

References $GLOBALS.

◆ isLoggable()

MWException::isLoggable ( )

Whether to log this exception in the exception debug log.

Stable to override

Since
1.23
Returns
bool

Reimplemented in HttpError.

Definition at line 52 of file MWException.php.

◆ msg()

MWException::msg (   $key,
  $fallback,
  $params 
)

Get a message from i18n.

Parameters
string$keyMessage name
string$fallbackDefault message if the message cache can't be called by the exception
mixed...$params To pass to wfMessage()
Returns
string Message with arguments replaced

Definition at line 81 of file MWException.php.

References $fallback, $res, $wgSitename, useMessageCache(), wfMessage(), and wfMsgReplaceArgs().

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

◆ 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().

Stable to override

Reimplemented in HttpError.

Definition at line 217 of file MWException.php.

References $wgMimeType, getText(), header(), reportHTML(), statusHeader(), and writeToCommandLine().

◆ reportHTML()

MWException::reportHTML ( )

Output the exception report using HTML.

Stable to override

Definition at line 176 of file MWException.php.

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

Referenced by report().

◆ statusHeader()

static MWException::statusHeader (   $code)
staticprivate

Definition at line 271 of file MWException.php.

References HttpStatus\header().

Referenced by report().

◆ useMessageCache()

MWException::useMessageCache ( )

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

Stable to override

Returns
bool

Definition at line 63 of file MWException.php.

Referenced by msg(), and useOutputPage().

◆ useOutputPage()

MWException::useOutputPage ( )

Should the exception use $wgOut to output the error?

Returns
bool

Definition at line 35 of file MWException.php.

References $GLOBALS, and useMessageCache().

Referenced by reportHTML().

◆ writeToCommandLine()

MWException::writeToCommandLine (   $message)
private

Write a message to stderr falling back to stdout if stderr unavailable.

Parameters
string$messageSecurityCheck-XSS

Definition at line 241 of file MWException.php.

Referenced by report().


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