ApiUsageException Class Reference

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

Inheritance diagram for ApiUsageException:

Collaboration diagram for ApiUsageException:

Public Member Functions
	__construct (ApiBase $module=null, StatusValue $status, $httpCode=0)
	__toString ()
	getCodeString ()
	getMessageArray ()
	getMessageObject ()
	@inheritDoc
	getModulePath ()
	Fetch the responsible module name.
	getStatusValue ()
	Fetch the error status.
Public Member Functions inherited from UsageException
	__construct ( $message, $codestr, $code=0, $extradata=null)
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)
	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.

Note

This currently extends UsageException for backwards compatibility, so all the existing code that catches UsageException won't break when stuff starts throwing ApiUsageException. Eventually UsageException will go away and this will (probably) extend MWException directly.

Definition at line 103 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 113 of file ApiUsageException.php.

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

Member Function Documentation

__toString()

ApiUsageException::__toString

(

)

Returns

string

Reimplemented from UsageException.

Definition at line 221 of file ApiUsageException.php.

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

getApiMessage()

ApiUsageException::getApiMessage ( )

private

Returns

ApiMessage

Definition at line 156 of file ApiUsageException.php.

References ApiMessage\create().

Referenced by __construct(), __toString(), getCodeString(), and getMessageArray().

getCodeString()

ApiUsageException::getCodeString

(

)

Deprecated:

Do not use. This only exists here because UsageException is in the inheritance chain for backwards compatibility. @inheritDoc

Reimplemented from UsageException.

Definition at line 190 of file ApiUsageException.php.

References getApiMessage(), and wfDeprecated().

getMessageArray()

ApiUsageException::getMessageArray

(

)

Deprecated:

Do not use. This only exists here because UsageException is in the inheritance chain for backwards compatibility. @inheritDoc

Reimplemented from UsageException.

Definition at line 200 of file ApiUsageException.php.

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

getMessageObject()

ApiUsageException::getMessageObject

(

)

@inheritDoc

Implements ILocalizedException.

Definition at line 214 of file ApiUsageException.php.

getModulePath()

ApiUsageException::getModulePath

(

)

Fetch the responsible module name.

Returns

string|null

Definition at line 173 of file ApiUsageException.php.

References $modulePath.

Referenced by ApiMain\substituteResultWithError().

getStatusValue()

ApiUsageException::getStatusValue

(

)

Fetch the error status.

Returns

StatusValue

Definition at line 181 of file ApiUsageException.php.

References $status.

Referenced by ApiTestCase\apiExceptionHasCode(), ApiParamInfo\execute(), ApiMain\handleException(), ApiFormatPhpTest\testCrossDomainMangling(), and ApiParseTest\testNonexistentPage().

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 143 of file ApiUsageException.php.

References $code, and ApiMessage\create().

Referenced by ApiContinuationManager\__construct(), ApiBase\dieWithError(), WatchedItemQueryService\getWatchlistOwnerId(), ApiBaseTest\provideGetParameterFromSettings(), ApiTestCase\setExpectedApiException(), and ApiUsageExceptionTest\testNewWithMessage_ThenGetMessageObject_ReturnsApiMessageWithProvidedData().

Member Data Documentation

$modulePath

ApiUsageException::$modulePath

protected

Definition at line 105 of file ApiUsageException.php.

Referenced by getModulePath().

$status

ApiUsageException::$status

protected

Definition at line 106 of file ApiUsageException.php.

Referenced by __construct(), and getStatusValue().

---

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

• includes/api/ApiUsageException.php