MediaWiki master
MWExceptionRenderer Class Reference

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

Static Public Member Functions

static getHTML (Throwable $e)
 Format an HTML message for the given exception object.
 
static msg ( $key, $fallback,... $params)
 Get a message string from i18n.
 
static output (Throwable $e, $mode, Throwable $eNew=null)
 
static setShowExceptionDetails (bool $showDetails)
 
static shouldShowExceptionDetails ()
 

Public Attributes

const AS_PRETTY = 2
 
const AS_RAW = 1
 

Detailed Description

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

Since
1.28

Definition at line 37 of file MWExceptionRenderer.php.

Member Function Documentation

◆ getHTML()

static MWExceptionRenderer::getHTML ( Throwable $e)
static

Format an HTML message for the given exception object.

Parameters
Throwable$e
Returns
string Html to output

Definition at line 214 of file MWExceptionRenderer.php.

◆ msg()

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

Get a message string 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 253 of file MWExceptionRenderer.php.

References $fallback, and $params.

◆ output()

static MWExceptionRenderer::output ( Throwable $e,
$mode,
Throwable $eNew = null )
static
Parameters
Throwable$eOriginal exception
int$modeMWExceptionExposer::AS_* constant
Throwable | null$eNewNew throwable from attempting to show the first

Definition at line 72 of file MWExceptionRenderer.php.

◆ setShowExceptionDetails()

static MWExceptionRenderer::setShowExceptionDetails ( bool $showDetails)
static
Parameters
bool$showDetails
Access: internal
For use by Setup.php and other internal use cases.

Definition at line 63 of file MWExceptionRenderer.php.

◆ shouldShowExceptionDetails()

static MWExceptionRenderer::shouldShowExceptionDetails ( )
static
Access: internal
For use within core wiring only.
Returns
bool

Definition at line 55 of file MWExceptionRenderer.php.

Member Data Documentation

◆ AS_PRETTY

const MWExceptionRenderer::AS_PRETTY = 2

Definition at line 39 of file MWExceptionRenderer.php.

◆ AS_RAW

const MWExceptionRenderer::AS_RAW = 1

Definition at line 38 of file MWExceptionRenderer.php.


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