1. class
  2. Brandon14
  3. \
  4. FossabotCommander
  5. \
  6. Contracts
  7. \
  8. Exceptions
  9. \
  10. FossabotApiException

FossabotApiException

class FossabotApiException extends FossabotCommanderException (View source)

Generic Fossabot API exception thrown when making Fossabot custom API requests.

Methods

__construct(string $fossabotCode, string $errorClass, string $errorMessage, int $statusCode, array|null $body = null, Throwable|null $previous = null)

Constructs a new FossabotApiException class.

string
fossabotCode()

Error code from Fossabot API response.

string
errorClass()

Error class (error param) from Fossabot API response.

string
errorMessage()

Error message from Fossabot API response.

int
statusCode()

HTTP status code from Fossabot API exception.

array|null
body()

Parsed HTTP body from Fossabot API exception.

__toString()

{@inheritDoc}

Details

at line 82
__construct(string $fossabotCode, string $errorClass, string $errorMessage, int $statusCode, array|null $body = null, Throwable|null $previous = null)

Constructs a new FossabotApiException class.

Parameters

string $fossabotCode

Error code from Fossabot API response
string $errorClass

Error class (error param) from Fossabot API response
string $errorMessage

Error message from Fossabot API response
int $statusCode

HTTP status code from Fossabot API exception
array|null $body

Parsed HTTP body from Fossabot API exception
Throwable|null $previous

Previous exception

at line 106
string fossabotCode()

Error code from Fossabot API response.

Return Value

string

Fossabot error code

at line 116
string errorClass()

Error class (error param) from Fossabot API response.

Return Value

string

Error class

at line 126
string errorMessage()

Error message from Fossabot API response.

Return Value

string

Error message

at line 136
int statusCode()

HTTP status code from Fossabot API exception.

Return Value

int

HTTP status code

at line 146
array|null body()

Parsed HTTP body from Fossabot API exception.

Return Value

array|null

HTTP body

at line 154
__toString()

{@inheritDoc}