MediaWiki REL1_39
BadTitleError Class Reference

Show an error page on a badtitle. More...

Inheritance diagram for BadTitleError:
Collaboration diagram for BadTitleError:

Public Member Functions

 __construct ( $msg='badtitletext', $params=[])
 
 report ( $action=self::SEND_OUTPUT)
 
Stability: stable
to override
Parameters
int$action
Exceptions
FatalError
MWException

 
- Public Member Functions inherited from ErrorPageError
 __construct ( $title, $msg, $params=[])
 Note: these arguments are keys into wfMessage(), not text!
 
 getMessageObject ()
 Return a Message object for this exception.
 
- Public Member Functions inherited from MWException
 getHTML ()
 Format an HTML message for the current exception object.
 
 getPageTitle ()
 Return the title of the page when reporting this error in a HTTP response.
 
 getText ()
 Format plain text message for the current exception object.
 
 isLoggable ()
 Whether to log this exception in the exception debug log.
 
 msg ( $key, $fallback,... $params)
 Get a message from i18n.
 
 report ()
 Output a report about the exception and takes care of formatting.
 
 reportHTML ()
 Output the exception report using HTML.
 
 useMessageCache ()
 Can the extension use the Message class/wfMessage to get i18n-ed messages?
 

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

Detailed Description

Show an error page on a badtitle.

We always emit a HTTP 404 error code since pages with an invalid title will never have any content. In the past this emitted a 400 error code to ensure caching proxies and mobile browsers don't cache it as valid content (T35646), but that had the disadvantage of telling caches in front of MediaWiki (Varnish, etc.), not to cache it either.

Stability: newable
Since
1.19

Definition at line 34 of file BadTitleError.php.

Constructor & Destructor Documentation

◆ __construct()

BadTitleError::__construct (   $msg = 'badtitletext',
  $params = [] 
)
Stability: stable
to call
Parameters
string | Message | MalformedTitleException$msgA message key (default: 'badtitletext'), or a MalformedTitleException to figure out things from
array$paramsParameter to wfMessage()

Definition at line 42 of file BadTitleError.php.

References ErrorPageError\$msg, and ErrorPageError\$params.

Member Function Documentation

◆ report()

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

Stability: stable
to override
Parameters
int$action
Exceptions
FatalError
MWException

Reimplemented from ErrorPageError.

Definition at line 59 of file BadTitleError.php.

References $wgOut.


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