Inheritance diagram for MWException:

[legend]

Collaboration diagram for MWException:

Public Member Functions
	getHTML ()
	Format an HTML message for the current exception object. More...

	getPageTitle ()
	Return the title of the page when reporting this error in a HTTP response. More...

	getText ()
	Format plain text message for the current exception object. 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...

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

Detailed Description

MediaWiki exception.

Stability: newable

Stability: stable: to extend

Deprecated:: since 1.40, use native exceptions instead (either directly, or defining subclasses when appropriate)

Definition at line 32 of file MWException.php.

Member Function Documentation

◆ getHTML()

MWException::getHTML ( )

Format an HTML message for the current exception object.

Stability: stable: to override

Todo:: Rarely used, remove in favour of generic MWExceptionRenderer

Returns: string HTML to output

Reimplemented in HttpError, and FatalError.

Definition at line 113 of file MWException.php.

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

Referenced by reportHTML(), and wfStreamThumb().

◆ getPageTitle()

MWException::getPageTitle ( )

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

Stability: stable: to override

Returns: string

Definition at line 163 of file MWException.php.

References msg().

Referenced by reportHTML().

◆ getText()

MWException::getText ( )

Format plain text message for the current exception object.

Stability: stable: to override

Todo:: Rarely used, remove in favour of generic MWExceptionRenderer

Returns: string

Reimplemented in FatalError.

Definition at line 146 of file MWException.php.

References MWExceptionHandler\getLogMessage(), MWExceptionHandler\getRedactedTraceAsString(), and MWExceptionRenderer\shouldShowExceptionDetails().

Referenced by DatabaseInstaller\doUpgrade(), and report().

◆ 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 243 of file MWException.php.

◆ isLoggable()

MWException::isLoggable ( )

Whether to log this exception in the exception debug log.

Stability: stable: to override

Since: 1.23

Returns: bool

Reimplemented in HttpError.

Definition at line 56 of file MWException.php.

◆ msg()

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

Get a message from i18n.

Parameters

string	$key	Message name
string	$fallback	Default 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 85 of file MWException.php.

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

Referenced by ErrorPageError\__construct(), UploadChunkVerificationException\__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().

Stability: stable: to override

Reimplemented in HttpError.

Definition at line 208 of file MWException.php.

References getText(), and reportHTML().

◆ reportHTML()

MWException::reportHTML ( )

Output the exception report using HTML.

Stability: stable: to override

Definition at line 171 of file MWException.php.

References $wgOut, getHTML(), getPageTitle(), and msg().

Referenced by report().

◆ useMessageCache()

MWException::useMessageCache ( )

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

Stability: stable: to override

Returns: bool

Definition at line 67 of file MWException.php.

Referenced by msg().

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

includes/exception/MWException.php

Public Member Functions

Static Public Member Functions