MediaWiki  master
ErrorPageError Class Reference

An error page which can definitely be safely rendered using the OutputPage. More...

Inheritance diagram for ErrorPageError:
Collaboration diagram for ErrorPageError:

Public Member Functions

 __construct ( $title, $msg, $params=[])
 Note: these arguments are keys into wfMessage(), not text! More...
 
 getMessageObject ()
 Return a Message object for this exception. More...
 
 report ( $action=self::SEND_OUTPUT)
 Stable to override. More...
 
- Public Member Functions inherited from MWException
 getHTML ()
 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...
 
 getPageTitle ()
 Return the title of the page when reporting this error in a HTTP response. More...
 
 getText ()
 Get the text to display when reporting the error on the command line. 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...
 
 useOutputPage ()
 Should the exception use $wgOut to output the error? More...
 

Public Attributes

 $msg
 
 $params
 
 $title
 
const SEND_OUTPUT = 0
 
const STAGE_OUTPUT = 1
 

Additional Inherited Members

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

Detailed Description

An error page which can definitely be safely rendered using the OutputPage.

@newable Stable to extend

Since
1.7

Definition at line 30 of file ErrorPageError.php.

Constructor & Destructor Documentation

◆ __construct()

ErrorPageError::__construct (   $title,
  $msg,
  $params = [] 
)

Note: these arguments are keys into wfMessage(), not text!

Stable to call

Parameters
string | Message$titleMessage key (string) for page title, or a Message object
string | Message$msgMessage key (string) for error text, or a Message object
array$paramsArray with parameters to wfMessage()

Reimplemented in UserNotLoggedIn.

Definition at line 44 of file ErrorPageError.php.

References $msg, $params, $title, getMessageObject(), and MWException\msg().

Member Function Documentation

◆ getMessageObject()

ErrorPageError::getMessageObject ( )

Return a Message object for this exception.

Since
1.29
Returns
Message

Implements ILocalizedException.

Definition at line 63 of file ErrorPageError.php.

References $msg, MWException\msg(), and wfMessage().

Referenced by __construct().

◆ report()

ErrorPageError::report (   $action = self::SEND_OUTPUT)

Stable to override.

Parameters
int$action
Exceptions
FatalError
MWException

Reimplemented in LocalFileLockError, UserNotLoggedIn, PermissionsError, BadRequestError, and ThrottledError.

Definition at line 77 of file ErrorPageError.php.

References $wgOut, and MWException\msg().

Referenced by MediaWiki\run().

Member Data Documentation

◆ $msg

ErrorPageError::$msg

Definition at line 33 of file ErrorPageError.php.

Referenced by BadTitleError\__construct(), __construct(), and getMessageObject().

◆ $params

ErrorPageError::$params

◆ $title

ErrorPageError::$title

Definition at line 33 of file ErrorPageError.php.

Referenced by __construct().

◆ SEND_OUTPUT

const ErrorPageError::SEND_OUTPUT = 0

Definition at line 31 of file ErrorPageError.php.

◆ STAGE_OUTPUT

const ErrorPageError::STAGE_OUTPUT = 1

Definition at line 32 of file ErrorPageError.php.

Referenced by MediaWiki\run().


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