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)

static	runHooks ( $e, $name, $args=[])
	Run hook to allow extensions to modify the text of the exception. More...

Public Attributes
const	AS_PRETTY = 2

const	AS_RAW = 1

Static Private Member Functions
static	getShowBacktraceError ( $e)

static	getText ( $e)

static	googleSearchForm ()

static	header ( $header)

static	isCommandLine ()

static	msg ( $key, $fallback)
	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	showBackTrace ( $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 31 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 218 of file MWExceptionRenderer.php.

References $e, $html, MWExceptionHandler\getLogMessage(), MWExceptionHandler\getRedactedTraceAsString(), WebRequest\getRequestId(), MWExceptionHandler\getURL(), and msg().

Referenced by reportHTML(), and MediaWiki\run().

◆ getShowBacktraceError()

static MWExceptionRenderer::getShowBacktraceError ( $e )

staticprivate

Parameters

Exception | Throwable $e

Returns: string

Definition at line 291 of file MWExceptionRenderer.php.

References $e, $vars, and global.

Referenced by getText(), and output().

◆ getText()

static MWExceptionRenderer::getText ( $e )

staticprivate

Parameters

Exception | Throwable $e

Returns: string

Definition at line 264 of file MWExceptionRenderer.php.

References $e, MWExceptionHandler\getLogMessage(), MWExceptionHandler\getRedactedTraceAsString(), and getShowBacktraceError().

◆ googleSearchForm()

static MWExceptionRenderer::googleSearchForm ( )

staticprivate

Returns: string

Definition at line 392 of file MWExceptionRenderer.php.

References $wgCanonicalServer, $wgRequest, $wgSitename, captcha-old\action, div, form, global, name, style, type, and value.

Referenced by reportOutageHTML().

◆ header()

static MWExceptionRenderer::header ( $header )

staticprivate

Parameters

string $header

Definition at line 314 of file MWExceptionRenderer.php.

References $header.

Referenced by output(), and reportHTML().

◆ isCommandLine()

static MWExceptionRenderer::isCommandLine ( )

staticprivate

Returns: bool

Definition at line 307 of file MWExceptionRenderer.php.

References $GLOBALS.

◆ msg()

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

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 The function also has other parameters that are arguments for the message

Returns: string Message with arguments replaced

Definition at line 251 of file MWExceptionRenderer.php.

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

Referenced by getHTML(), and reportHTML().

◆ output()

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

static

Parameters

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

Definition at line 40 of file MWExceptionRenderer.php.

References $e, MWExceptionHandler\getLogMessage(), MWExceptionHandler\getPublicLogMessage(), MWExceptionHandler\getRedactedTraceAsString(), getShowBacktraceError(), global, header(), printError(), reportHTML(), reportOutageHTML(), statusHeader(), and wfHttpError().

Referenced by MWExceptionHandler\report().

◆ printError()

static MWExceptionRenderer::printError ( $message )

staticprivate

Print a message, if possible to STDERR.

Use this in command line mode only (see isCommandLine)

Parameters

string $message Failure text

Definition at line 335 of file MWExceptionRenderer.php.

Referenced by output().

◆ reportHTML()

static MWExceptionRenderer::reportHTML ( $e )

staticprivate

Output the exception report using HTML.

Parameters

Exception | Throwable $e

Definition at line 161 of file MWExceptionRenderer.php.

References $e, $wgOut, $wgSitename, getHTML(), global, header(), msg(), and runHooks().

Referenced by output().

◆ reportOutageHTML()

static MWExceptionRenderer::reportOutageHTML ( $e )

staticprivate

Parameters

Exception | Throwable $e

Definition at line 349 of file MWExceptionRenderer.php.

References $e, $html, Html\element(), global, googleSearchForm(), and MessageCache\singleton().

Referenced by output().

◆ runHooks()

static MWExceptionRenderer::runHooks	(	$e,
		$name,
		$args = `[]`
	)

static

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

Called by MWException for b/c

Parameters

Exception \| Throwable	$e
string	$name	Class name of the exception
array	$args	Arguments to pass to the callback functions

Returns: string|null String to output or null if any hook has been called

Definition at line 97 of file MWExceptionRenderer.php.

References $args, $e, $name, as, captcha-old\count, and global.

Referenced by reportHTML(), and MWException\runHooks().

◆ showBackTrace()

static MWExceptionRenderer::showBackTrace ( $e )

staticprivate

Parameters

Exception | Throwable $e

Returns: bool

Definition at line 278 of file MWExceptionRenderer.php.

References $e, and global.

◆ statusHeader()

static MWExceptionRenderer::statusHeader ( $code )

staticprivate

Parameters

integer $code

Definition at line 323 of file MWExceptionRenderer.php.

References $code, and HttpStatus\header().

Referenced by output().

◆ useOutputPage()

static MWExceptionRenderer::useOutputPage ( $e )

staticprivate

Parameters

Exception | Throwable $e

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

Definition at line 136 of file MWExceptionRenderer.php.

References $e, $GLOBALS, as, and RequestContext\getMain().

Member Data Documentation

◆ AS_PRETTY

const MWExceptionRenderer::AS_PRETTY = 2

Definition at line 33 of file MWExceptionRenderer.php.

Referenced by MWExceptionHandler\report().

◆ AS_RAW

const MWExceptionRenderer::AS_RAW = 1

Definition at line 32 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()

◆ googleSearchForm()

◆ header()

◆ isCommandLine()

◆ msg()

◆ output()

◆ printError()

◆ reportHTML()

◆ reportOutageHTML()

◆ runHooks()

◆ showBackTrace()

◆ statusHeader()

◆ useOutputPage()

Member Data Documentation

◆ AS_PRETTY

◆ AS_RAW