Class to expose exceptions to the client (API bots, users, admins using CLI scripts) More...

Static Public Member Functions
static	getHTML ( $e)
	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...

static	output ( $e, $mode, $eNew=null)

Public Attributes
const	AS_PRETTY = 2

const	AS_RAW = 1

Static Private Member Functions
static	getShowBacktraceError ( $e)

static	getText ( $e)

static	header ( $header)

static	isCommandLine ()

static	msg ( $key, $fallback,... $params)
	Get a message from i18n. More...

static	printError ( $message)
	Print a message, if possible to STDERR. More...

static	reportHTML ( $e)
	Output the exception report using HTML. More...

static	reportOutageHTML ( $e)

static	statusHeader ( $code)

static	useOutputPage ( $e)

Detailed Description

Class to expose exceptions to the client (API bots, users, admins using CLI scripts)

Since: 1.28

Definition at line 30 of file MWExceptionRenderer.php.

Member Function Documentation

◆ getHTML()

static MWExceptionRenderer::getHTML ( $e )

static

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.

Parameters

Exception | Throwable $e

Returns: string Html to output

Definition at line 177 of file MWExceptionRenderer.php.

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

Referenced by MediaWiki\run().

◆ getShowBacktraceError()

static MWExceptionRenderer::getShowBacktraceError ( $e )

staticprivate

Parameters

Exception | Throwable $e

Returns: string

Definition at line 250 of file MWExceptionRenderer.php.

◆ getText()

static MWExceptionRenderer::getText ( $e )

staticprivate

Parameters

Exception | Throwable $e

Returns: string

Definition at line 234 of file MWExceptionRenderer.php.

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

◆ header()

static MWExceptionRenderer::header ( $header )

staticprivate

Parameters

string $header

Definition at line 265 of file MWExceptionRenderer.php.

References $header.

◆ isCommandLine()

static MWExceptionRenderer::isCommandLine ( )

staticprivate

Returns: bool

Definition at line 258 of file MWExceptionRenderer.php.

References $GLOBALS.

◆ msg()

static MWExceptionRenderer::msg	(	$key,
		$fallback,
		$params
	)

staticprivate

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 213 of file MWExceptionRenderer.php.

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

◆ output()

static MWExceptionRenderer::output	(	$e,
		$mode,
		$eNew = `null`
	)

static

Parameters

Exception \| Throwable	$e	Original exception
int	$mode	MWExceptionExposer::AS_* constant
Exception \| Throwable \| null	$eNew	New exception from attempting to show the first

Definition at line 39 of file MWExceptionRenderer.php.

References $wgMimeType, $wgShowExceptionDetails, MWExceptionHandler\getLogMessage(), MWExceptionHandler\getPublicLogMessage(), MWExceptionHandler\getRedactedTraceAsString(), print, and wfHttpError().

Referenced by MWExceptionHandler\report(), MWLBFactory\reportIfPrefixSet(), MWLBFactory\reportMismatchedDBs(), and MWLBFactory\reportMismatchedPrefixes().

◆ printError()

static MWExceptionRenderer::printError ( $message )

staticprivate

Print a message, if possible to STDERR.

Use this in command line mode only (see isCommandLine)

SecurityCheck-XSS

Parameters

string $message Failure text

Definition at line 287 of file MWExceptionRenderer.php.

◆ reportHTML()

static MWExceptionRenderer::reportHTML ( $e )

staticprivate

Output the exception report using HTML.

Parameters

Exception | Throwable $e

Definition at line 130 of file MWExceptionRenderer.php.

References $wgOut, $wgSitename, Html\element(), and Message\newFromSpecifier().

◆ reportOutageHTML()

static MWExceptionRenderer::reportOutageHTML ( $e )

staticprivate

Parameters

Exception | Throwable $e

Definition at line 301 of file MWExceptionRenderer.php.

References $wgShowExceptionDetails, $wgShowHostnames, $wgSitename, Html\element(), and MessageCache\singleton().

◆ statusHeader()

static MWExceptionRenderer::statusHeader ( $code )

staticprivate

Parameters

int $code

Definition at line 274 of file MWExceptionRenderer.php.

References HttpStatus\header().

◆ useOutputPage()

static MWExceptionRenderer::useOutputPage ( $e )

staticprivate

Parameters

Exception | Throwable $e

Returns: bool Should the exception use $wgOut to output the error?

Definition at line 105 of file MWExceptionRenderer.php.

References $GLOBALS, and RequestContext\getMain().

Member Data Documentation

◆ AS_PRETTY

const MWExceptionRenderer::AS_PRETTY = 2

Definition at line 32 of file MWExceptionRenderer.php.

Referenced by MWExceptionHandler\report(), MWLBFactory\reportIfPrefixSet(), MWLBFactory\reportMismatchedDBs(), and MWLBFactory\reportMismatchedPrefixes().

◆ AS_RAW

const MWExceptionRenderer::AS_RAW = 1

Definition at line 31 of file MWExceptionRenderer.php.

Referenced by MWExceptionHandler\report().

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

includes/exception/MWExceptionRenderer.php

Static Public Member Functions

Public Attributes

Static Private Member Functions

Detailed Description

Member Function Documentation

◆ getHTML()

◆ getShowBacktraceError()

◆ getText()

◆ header()

◆ isCommandLine()

◆ msg()

◆ output()

◆ printError()

◆ reportHTML()

◆ reportOutageHTML()

◆ statusHeader()

◆ useOutputPage()

Member Data Documentation

◆ AS_PRETTY

◆ AS_RAW