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, StatusValue $status, $httpCode=0, Throwable $previous=null)
 
 __toString ()
 
 getMessageObject ()
 Return a Message object for this exception.
Returns
Message
More...
 
 getModulePath ()
 Fetch the responsible module name. More...
 
 getStatusValue ()
 Fetch the error status. More...
 
- Public Member Functions inherited from MWException
 getHTML ()
 Format an HTML message for the current exception object. More...
 
 getPageTitle ()
 Return the title of the page when reporting this error in a HTTP response. More...
 
 getText ()
 Format plain text message for the current exception object. 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...
 

Static Public Member Functions

static newWithMessage (?ApiBase $module, $msg, $code=null, $data=null, $httpCode=0, Throwable $previous=null)
 
- 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
 

Detailed Description

Exception used to abort API execution with an error.

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

Stability: newable

Definition at line 31 of file ApiUsageException.php.

Constructor & Destructor Documentation

◆ __construct()

ApiUsageException::__construct ( ?ApiBase  $module,
StatusValue  $status,
  $httpCode = 0,
Throwable  $previous = null 
)
Stability: stable
to call
Parameters
ApiBase | null$moduleAPI module responsible for the error, if known
StatusValue$statusStatus holding errors
int$httpCodeHTTP error code to use
Throwable | null$previousPrevious exception

Definition at line 44 of file ApiUsageException.php.

References $status, ApiBase\getModulePath(), and ApiErrorFormatter\stripMarkup().

Member Function Documentation

◆ __toString()

ApiUsageException::__toString ( )
Returns
string

Definition at line 123 of file ApiUsageException.php.

References ApiErrorFormatter\stripMarkup().

◆ getMessageObject()

ApiUsageException::getMessageObject ( )

Return a Message object for this exception.

Returns
Message

Implements ILocalizedException.

Definition at line 116 of file ApiUsageException.php.

◆ getModulePath()

ApiUsageException::getModulePath ( )

Fetch the responsible module name.

Returns
string|null

Definition at line 101 of file ApiUsageException.php.

References $modulePath.

Referenced by ApiMain\substituteResultWithError().

◆ getStatusValue()

ApiUsageException::getStatusValue ( )

Fetch the error status.

Returns
StatusValue

Definition at line 109 of file ApiUsageException.php.

References $status.

Referenced by ApiParamInfo\execute(), MediaWiki\Rest\Handler\ActionModuleBasedHandler\execute(), and ApiMain\handleException().

◆ newWithMessage()

static ApiUsageException::newWithMessage ( ?ApiBase  $module,
  $msg,
  $code = null,
  $data = null,
  $httpCode = 0,
Throwable  $previous = null 
)
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
Throwable | null$previousPrevious exception
Returns
static

Definition at line 70 of file ApiUsageException.php.

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

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

Member Data Documentation

◆ $modulePath

ApiUsageException::$modulePath
protected

Definition at line 33 of file ApiUsageException.php.

Referenced by getModulePath().

◆ $status

ApiUsageException::$status
protected

Definition at line 34 of file ApiUsageException.php.

Referenced by __construct(), and getStatusValue().


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