ClientException
class ClientException extends RequestException
Traits
Constants
| DEFAULT_TRUNCATE_AT |
The default truncation length for exception messages. |
Properties
| false|int|null | $truncateExceptionsAt | The current truncation length for the exception message. |
from RequestException |
| static false|int | $truncateAt | The global truncation length for the exception message. |
from RequestException |
| bool | $hasBeenSummarized | Whether the response has been summarized in the message. |
from RequestException |
Methods
Create a new exception instance.
Set the truncation length for request exception messages.
Determine if the response code was 202 "Accepted" response.
Determine if the response code was the given status code and the body has no content.
Determine if the response code was a 301 "Moved Permanently".
Determine if the response code was a 304 "Not Modified" response.
Determine if the response was a 400 "Bad Request" response.
Determine if the response was a 401 "Unauthorized" response.
Determine if the response was a 402 "Payment Required" response.
Determine if the response was a 403 "Forbidden" response.
Determine if the response was a 408 "Request Timeout" response.
Determine if the response was a 422 "Unprocessable Content" response.
Determine if the response was a 422 "Unprocessable Content" response.
Determine if the response was a 429 "Too Many Requests" response.
Details
in
RequestException at line 34
__construct(Response $response, false|int|null $truncateExceptionsAt = null)
Create a new exception instance.
in
RequestException at line 49
static void
truncate()
Enable truncation of request exception messages.
Boot-only. The global default persists for the worker lifetime across all coroutines; per-request truncation settings take precedence.
in
RequestException at line 60
static void
truncateAt(int $length)
Set the truncation length for request exception messages.
Boot-only. The global default persists for the worker lifetime across all coroutines; per-request truncation settings take precedence.
in
RequestException at line 71
static void
dontTruncate()
Disable truncation of request exception messages.
Boot-only. The global default persists for the worker lifetime across all coroutines; per-request truncation settings take precedence.
in
RequestException at line 79
bool
report()
Prepare the exception message and set the summarized flag.
in
RequestException at line 93
protected string
prepareMessage(Response $response)
Prepare the exception message.
in
RequestException at line 115
static void
flushState()
Flush all static state.
in
DeterminesStatusCode at line 12
bool
ok()
Determine if the response code was 200 "OK" response.
in
DeterminesStatusCode at line 20
bool
created()
Determine if the response code was 201 "Created" response.
in
DeterminesStatusCode at line 28
bool
accepted()
Determine if the response code was 202 "Accepted" response.
in
DeterminesStatusCode at line 36
bool
noContent(int $status = 204)
Determine if the response code was the given status code and the body has no content.
in
DeterminesStatusCode at line 44
bool
movedPermanently()
Determine if the response code was a 301 "Moved Permanently".
in
DeterminesStatusCode at line 52
bool
found()
Determine if the response code was a 302 "Found" response.
in
DeterminesStatusCode at line 60
bool
notModified()
Determine if the response code was a 304 "Not Modified" response.
in
DeterminesStatusCode at line 68
bool
badRequest()
Determine if the response was a 400 "Bad Request" response.
in
DeterminesStatusCode at line 76
bool
unauthorized()
Determine if the response was a 401 "Unauthorized" response.
in
DeterminesStatusCode at line 84
bool
paymentRequired()
Determine if the response was a 402 "Payment Required" response.
in
DeterminesStatusCode at line 92
bool
forbidden()
Determine if the response was a 403 "Forbidden" response.
in
DeterminesStatusCode at line 100
bool
notFound()
Determine if the response was a 404 "Not Found" response.
in
DeterminesStatusCode at line 108
bool
requestTimeout()
Determine if the response was a 408 "Request Timeout" response.
in
DeterminesStatusCode at line 116
bool
conflict()
Determine if the response was a 409 "Conflict" response.
in
DeterminesStatusCode at line 124
bool
unprocessableContent()
Determine if the response was a 422 "Unprocessable Content" response.
in
DeterminesStatusCode at line 132
bool
unprocessableEntity()
Determine if the response was a 422 "Unprocessable Content" response.
in
DeterminesStatusCode at line 140
bool
tooManyRequests()
Determine if the response was a 429 "Too Many Requests" response.
in
RequestException at line 19
Response
response()
Get the Saloon response.
in
RequestException at line 30
PendingRequest
pendingRequest()
Get the pending request.
in
RequestException at line 38
int
status()
Get the HTTP status code.
in
RequestException at line 46
string
body()
Get the response body.