MediaWiki\Exception\MWException Class Reference

MediaWiki exception. More...

Inherits Exception.

Inherited by MediaWiki\Api\ApiUsageException, MediaWiki\Exception\ErrorPageError, MediaWiki\Exception\FatalError, MediaWiki\Exception\HttpError, MediaWiki\Exception\MWContentSerializationException, and MediaWiki\Installer\InstallException.

Collaboration diagram for MediaWiki\Exception\MWException:

Public Member Functions
	hasOverriddenHandler ()
	isLoggable ()
	Whether to log this exception in the exception debug log.
	msg ( $key, $fallback,... $params)
	Get a message from i18n.
	report ()
	Output a report about the exception and takes care of formatting.
	useMessageCache ()
	Can the extension use the Message class/wfMessage to get i18n-ed messages?

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

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

Member Function Documentation

hasOverriddenHandler()

MediaWiki\Exception\MWException::hasOverriddenHandler ( )

final

Access: internal

Definition at line 113 of file MWException.php.

isCommandLine()

static MediaWiki\Exception\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 123 of file MWException.php.

References MW_ENTRY_POINT.

isLoggable()

MediaWiki\Exception\MWException::isLoggable

(

)

Whether to log this exception in the exception debug log.

Stability: stable

to override

Since

1.23

Returns

bool

Reimplemented in MediaWiki\Exception\HttpError.

Definition at line 48 of file MWException.php.

msg()

MediaWiki\Exception\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 @phpcs:ignore Generic.Files.LineLength
	MessageParam|MessageSpecifier|string|int|float|list<MessageParam|MessageSpecifier|string|int|float>	...$params See Message::params()

Returns

string Message with arguments replaced

Definition at line 79 of file MWException.php.

References $fallback, MediaWiki\Exception\MWException\useMessageCache(), wfMessage(), and wfMsgReplaceArgs().

Referenced by MediaWiki\Exception\ErrorPageError\__construct(), MediaWiki\Exception\ErrorPageError\getMessageObject(), MediaWiki\Exception\ErrorPageError\report(), and MediaWiki\Exception\UserNotLoggedIn\report().

report()

MediaWiki\Exception\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 MediaWiki\Exception\HttpError.

Definition at line 105 of file MWException.php.

References MediaWiki\Exception\MWExceptionRenderer\AS_PRETTY, and MediaWiki\Exception\MWExceptionRenderer\output().

useMessageCache()

MediaWiki\Exception\MWException::useMessageCache

(

)

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

Stability: stable

to override

Returns

bool

Definition at line 59 of file MWException.php.

Referenced by MediaWiki\Exception\MWException\msg().

---

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

• includes/exception/MWException.php