MediaWiki  master
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 ()
 
 getMessageObject ()
 
 getModulePath ()
 Fetch the responsible module name. More...
 
 getStatusValue ()
 Fetch the error status. More...
 
- 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. 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,... $params)
 Get a message from i18n. More...
 
 report ()
 Output a report about the exception and takes care of formatting. More...
 
 reportHTML ()
 Output the exception report using HTML. 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...
 

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. More...
 

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$moduleAPI module responsible for the error, if known
StatusValue$statusStatus holding errors
int$httpCodeHTTP error code to use

Definition at line 38 of file ApiUsageException.php.

References $status, getApiMessage(), StatusValue\isOK(), null, 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 ( )

Implements ILocalizedException.

Definition at line 108 of file ApiUsageException.php.

References Status\wrap().

◆ getModulePath()

ApiUsageException::getModulePath ( )

Fetch the responsible module name.

Returns
string|null

Definition at line 93 of file ApiUsageException.php.

References $modulePath.

◆ getStatusValue()

ApiUsageException::getStatusValue ( )

◆ newWithMessage()

static ApiUsageException::newWithMessage ( ApiBase  $module = null,
  $msg,
  $code = null,
  $data = null,
  $httpCode = 0 
)
static
Parameters
ApiBase | null$moduleAPI module responsible for the error, if known
string | array | Message$msgSee ApiMessage::create()
string | null$codeSee ApiMessage::create()
array | null$dataSee ApiMessage::create()
int$httpCodeHTTP error code to use
Returns
static

Definition at line 63 of file ApiUsageException.php.

References $code, ApiMessage\create(), and StatusValue\newFatal().

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 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: