MediaWiki  master
ThrottledError Class Reference

Show an error when the user hits a rate limit. More...

Inheritance diagram for ThrottledError:
Collaboration diagram for ThrottledError:

Public Member Functions

 __construct ()
 Stable to call. More...
 
 report ( $action=ErrorPageError::SEND_OUTPUT)
 Stable to override. More...
 
- Public Member Functions inherited from ErrorPageError
 __construct ( $title, $msg, $params=[])
 Note: these arguments are keys into wfMessage(), not text! More...
 
 getMessageObject ()
 Return a Message object for this exception. 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...
 

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...
 
- Public Attributes inherited from ErrorPageError
 $msg
 
 $params
 
 $title
 
const SEND_OUTPUT = 0
 
const STAGE_OUTPUT = 1
 

Detailed Description

Show an error when the user hits a rate limit.

@newable

Since
1.18

Definition at line 28 of file ThrottledError.php.

Constructor & Destructor Documentation

◆ __construct()

ThrottledError::__construct ( )

Stable to call.

Definition at line 33 of file ThrottledError.php.

Member Function Documentation

◆ report()

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

Stable to override.

Parameters
int$action
Exceptions
FatalError
MWException

Reimplemented from ErrorPageError.

Definition at line 40 of file ThrottledError.php.

References $wgOut.


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