MediaWiki\Rest\HttpException Class Reference

This is the base exception class for non-fatal exceptions thrown from REST handlers. More...

Inheritance diagram for MediaWiki\Rest\HttpException:

Collaboration diagram for MediaWiki\Rest\HttpException:

Public Member Functions
	__construct ( $message, $code=500, $errorData=null)
	Stable to call.
	getErrorData ()

Private Attributes
array null	$errorData = null

Detailed Description

This is the base exception class for non-fatal exceptions thrown from REST handlers.

The exception is not logged, it is merely converted to an error response.

@newable

Definition at line 12 of file HttpException.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Rest\HttpException::__construct	(		$message,
			$code = 500,
			$errorData = null
	)

Stable to call.

Parameters

string	$message
int	$code
array | null	$errorData

Definition at line 24 of file HttpException.php.

References MediaWiki\Rest\HttpException\$errorData.

Member Function Documentation

getErrorData()

MediaWiki\Rest\HttpException::getErrorData

(

)

Returns

array|null

Definition at line 32 of file HttpException.php.

References MediaWiki\Rest\HttpException\$errorData.

Member Data Documentation

$errorData

array null MediaWiki\Rest\HttpException::$errorData = null

private

Definition at line 15 of file HttpException.php.

Referenced by MediaWiki\Rest\HttpException\__construct(), MediaWiki\Rest\LocalizedHttpException\__construct(), and MediaWiki\Rest\HttpException\getErrorData().

---

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

• includes/Rest/HttpException.php