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

RateLimitException

final class RateLimitException extends FossabotApiException (View source)

Exception thrown when making a Fossabot API call, and it results in a rate limit throttled response (429).

Methods

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

Constructs a new RateLimitException class.

string
fossabotCode()

Error code from Fossabot API response.

from  FossabotApiException
string
errorClass()

Error class (error param) from Fossabot API response.

from  FossabotApiException
string
errorMessage()

Error message from Fossabot API response.

from  FossabotApiException
int
statusCode()

HTTP status code from Fossabot API exception.

from  FossabotApiException
array|null
body()

Parsed HTTP body from Fossabot API exception.

from  FossabotApiException
__toString()

{@inheritDoc}

from  FossabotApiException
int
total()

Total size of rate limit bucket.

int
remaining()

Remaining request in bucket.

DateTimeImmutable
resetsAt()

Time when rate limit bucket is refilled.

Details

at line 77
__construct(string $fossabotCode, string $errorClass, string $errorMessage, int $total, int $remaining, int $resetsAt, array|null $body = null, Throwable|null $previous = null)

Constructs a new RateLimitException 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 $total

Total size of rate limit bucket
int $remaining

Remaining request in bucket
int $resetsAt

Time when rate limit bucket is refilled
array|null $body

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

Previous exception

in FossabotApiException at line 106
string fossabotCode()

Error code from Fossabot API response.

Return Value

string

Fossabot error code

in FossabotApiException at line 116
string errorClass()

Error class (error param) from Fossabot API response.

Return Value

string

Error class

in FossabotApiException at line 126
string errorMessage()

Error message from Fossabot API response.

Return Value

string

Error message

in FossabotApiException at line 136
int statusCode()

HTTP status code from Fossabot API exception.

Return Value

int

HTTP status code

in FossabotApiException at line 146
array|null body()

Parsed HTTP body from Fossabot API exception.

Return Value

array|null

HTTP body

in FossabotApiException at line 154
__toString()

{@inheritDoc}

at line 112
int total()

Total size of rate limit bucket.

Return Value

int

at line 120
int remaining()

Remaining request in bucket.

Return Value

int

at line 128
DateTimeImmutable resetsAt()

Time when rate limit bucket is refilled.

Return Value

DateTimeImmutable