Exception used to abort API execution with an error. More...

Inheritance diagram for ApiUsageException:

[legend]

Collaboration diagram for ApiUsageException:

[legend]

Public Member Functions
	__construct (ApiBase $module=null, StatusValue $status, $httpCode=0)

	__toString ()

	getMessageObject ()
	Return a Message object for this exception. Returns Message

	getModulePath ()
	Fetch the responsible module name.

	getStatusValue ()
	Fetch the error status.

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.

	getPageTitle ()
	Return the title of the page when reporting this error in a HTTP response.

	getText ()
	Get the text to display when reporting the error on the command line.

	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?

	useOutputPage ()
	Should the exception use $wgOut to output the error?

Static Public Member Functions
static	newWithMessage (ApiBase $module=null, $msg, $code=null, $data=null, $httpCode=0)

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.

Protected Attributes
	$modulePath

	$status

Private Member Functions
	getApiMessage ()

Detailed Description

Exception used to abort API execution with an error.

If possible, use ApiBase::dieWithError() instead of throwing this directly.

Definition at line 28 of file ApiUsageException.php.

Constructor & Destructor Documentation

◆ __construct()

ApiUsageException::__construct	(	ApiBase	$module = `null`,
		StatusValue	$status,
			$httpCode = `0`
	)

Parameters

ApiBase \| null	$module	API module responsible for the error, if known
StatusValue	$status	Status holding errors
int	$httpCode	HTTP error code to use

Definition at line 38 of file ApiUsageException.php.

References $status, getApiMessage(), and ApiErrorFormatter\stripMarkup().

Member Function Documentation

◆ __toString()

ApiUsageException::__toString ( )

Returns: string

Definition at line 115 of file ApiUsageException.php.

References getApiMessage(), and ApiErrorFormatter\stripMarkup().

◆ getApiMessage()

ApiUsageException::getApiMessage ( )

private

Returns: ApiMessage

Definition at line 76 of file ApiUsageException.php.

References ApiMessage\create().

Referenced by __construct(), and __toString().

◆ getMessageObject()

ApiUsageException::getMessageObject ( )

Return a Message object for this exception.

Returns: Message

Implements ILocalizedException.

Definition at line 108 of file ApiUsageException.php.

◆ getModulePath()

ApiUsageException::getModulePath ( )

Fetch the responsible module name.

Returns: string|null

Definition at line 93 of file ApiUsageException.php.

References $modulePath.

Referenced by ApiMain\substituteResultWithError().

◆ getStatusValue()

ApiUsageException::getStatusValue ( )

Fetch the error status.

Returns: StatusValue

Definition at line 101 of file ApiUsageException.php.

References $status.

Referenced by ApiParamInfo\execute(), and ApiMain\handleException().

◆ newWithMessage()

static ApiUsageException::newWithMessage	(	ApiBase	$module = `null`,
			$msg,
			$code = `null`,
			$data = `null`,
			$httpCode = `0`
	)

static

Parameters

ApiBase \| null	$module	API module responsible for the error, if known
string \| array \| Message	$msg	See ApiMessage::create()
string \| null	$code	See ApiMessage::create()
array \| null	$data	See ApiMessage::create()
int	$httpCode	HTTP error code to use

Returns: static

Definition at line 63 of file ApiUsageException.php.

References ApiMessage\create().

Referenced by ApiContinuationManager\__construct(), ApiBase\dieWithError(), and WatchedItemQueryService\getWatchlistOwnerId().

Member Data Documentation

◆ $modulePath

ApiUsageException::$modulePath

protected

Definition at line 30 of file ApiUsageException.php.

Referenced by getModulePath().

◆ $status

ApiUsageException::$status

protected

Definition at line 31 of file ApiUsageException.php.

Referenced by __construct(), and getStatusValue().

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

includes/api/ApiUsageException.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions