HttpError Class Reference

Show an error that looks like an HTTP server error. More...

Inheritance diagram for HttpError:

Collaboration diagram for HttpError:

Public Member Functions
	__construct ( $httpCode, $content, $header=null)
	Constructor. More...
	getHTML ()
	Returns HTML for reporting the HTTP error. More...
	getStatusCode ()
	Returns the HTTP status code supplied to the constructor. More...
	report ()
	Report the HTTP error. More...
Public Member Functions inherited from MWException
	getLogId ()
	Get a the ID for this error. More...
	getLogMessage ()
	Return the requested URL and point to file and line number from which the exception occurred. 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)
	Get a message from i18n. More...
	reportHTML ()
	Output the exception report using HTML. More...
	runHooks ( $name, $args=array())
	Run hook to allow extensions to modify the text of the exception. 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
	$content
	$header

Private Attributes
	$httpCode

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

Show an error that looks like an HTTP server error.

Replacement for wfHttpError().

Since

1.19

Definition at line 28 of file HttpError.php.

Constructor & Destructor Documentation

__construct()

HttpError::__construct	(		$httpCode,
			$content,
			$header = null
	)

Constructor.

Parameters

	$httpCode	Integer: HTTP status code to send to the client
string | Message	$content	content of the message
string | Message	$header	content of the header (<title> and <h1>)

Definition at line 38 of file HttpError.php.

References $content, $header, $httpCode, and content.

Member Function Documentation

getHTML()

HttpError::getHTML

(

)

Returns HTML for reporting the HTTP error.

This will be a minimal but complete HTML document.

Returns

string HTML

Reimplemented from MWException.

Definition at line 74 of file HttpError.php.

References $content, $header, content, and HttpStatus\getMessage().

Referenced by report().

getStatusCode()

HttpError::getStatusCode

(

)

Returns the HTTP status code supplied to the constructor.

Returns

int

Definition at line 50 of file HttpError.php.

References $httpCode.

report()

HttpError::report

(

)

Report the HTTP error.

Sends the appropriate HTTP status code and outputs an HTML page with an error message.

Reimplemented from MWException.

Definition at line 59 of file HttpError.php.

References getHTML(), and HttpStatus\getMessage().

Member Data Documentation

$content

HttpError::$content

Definition at line 29 of file HttpError.php.

Referenced by __construct(), and getHTML().

$header

HttpError::$header

Definition at line 29 of file HttpError.php.

Referenced by __construct(), and getHTML().

$httpCode

HttpError::$httpCode

private

Definition at line 29 of file HttpError.php.

Referenced by __construct(), and getStatusCode().

---

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

• includes/exception/HttpError.php