Response
class Response implements ArrayAccess (View source)
Traits
Properties
| static protected array | $macros | The registered string macros. |
from Macroable |
| protected ResponseInterface | $response | The underlying PSR response. |
|
| protected array | $decoded | The decoded JSON response. |
|
| CookieJar | $cookies | The request cookies. |
|
| TransferStats|null | $transferStats | The transfer stats for the request. |
Methods
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 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 Entity" response.
Determine if the response was a 429 "Too Many Requests" response.
Mix another object into the class.
Dynamically handle calls to the class.
Dynamically proxy other methods to the underlying response.
Create a new response instance.
Get the body of the response.
Get the JSON decoded body of the response as an array or scalar value.
Get the JSON decoded body of the response as an object.
Get the JSON decoded body of the response as a collection.
Get a header from the response.
Get the headers from the response.
Get the status code of the response.
Get the reason phrase of the response.
Get the effective URI of the response.
Determine if the request was successful.
Determine if the response was a redirect.
Determine if the response indicates a client or server error occurred.
Determine if the response indicates a client error occurred.
Determine if the response indicates a server error occurred.
Execute the given callback if there was a server or client error.
Get the response cookies.
Get the handler stats of the response.
Close the stream and any underlying resources.
Get the underlying PSR response for the response.
Create an exception if a server or client error occurred.
Throw an exception if a server or client error occurred.
Throw an exception if the response status code matches the given code.
Throw an exception unless the response status code matches the given code.
Throw an exception if the response status code is a 4xx level code.
Throw an exception if the response status code is a 5xx level code.
Determine if the given offset exists.
Get the value for a given offset.
Set the value at the given offset.
Unset the value at the given offset.
Get the body of the response.
Details
bool
ok()
Determine if the response code was 200 "OK" response.
bool
created()
Determine if the response code was 201 "Created" response.
bool
accepted()
Determine if the response code was 202 "Accepted" response.
bool
noContent(int $status = 204)
Determine if the response code was the given status code and the body has no content.
bool
movedPermanently()
Determine if the response code was a 301 "Moved Permanently".
bool
found()
Determine if the response code was a 302 "Found" response.
bool
badRequest()
Determine if the response was a 400 "Bad Request" response.
bool
unauthorized()
Determine if the response was a 401 "Unauthorized" response.
bool
paymentRequired()
Determine if the response was a 402 "Payment Required" response.
bool
forbidden()
Determine if the response was a 403 "Forbidden" response.
bool
notFound()
Determine if the response was a 404 "Not Found" response.
bool
requestTimeout()
Determine if the response was a 408 "Request Timeout" response.
bool
conflict()
Determine if the response was a 409 "Conflict" response.
bool
unprocessableEntity()
Determine if the response was a 422 "Unprocessable Entity" response.
bool
tooManyRequests()
Determine if the response was a 429 "Too Many Requests" response.
static void
macro(string $name, object|callable $macro)
Register a custom macro.
static void
mixin(object $mixin, bool $replace = true)
Mix another object into the class.
static bool
hasMacro(string $name)
Checks if macro is registered.
static void
flushMacros()
Flush the existing macros.
static mixed
__callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
mixed
__call(string $method, array $parameters)
Dynamically proxy other methods to the underlying response.
void
__construct(MessageInterface $response)
Create a new response instance.
string
body()
Get the body of the response.
mixed
json(string|null $key = null, mixed $default = null)
Get the JSON decoded body of the response as an array or scalar value.
object|array
object()
Get the JSON decoded body of the response as an object.
Collection
collect(string|null $key = null)
Get the JSON decoded body of the response as a collection.
string
header(string $header)
Get a header from the response.
array
headers()
Get the headers from the response.
int
status()
Get the status code of the response.
string
reason()
Get the reason phrase of the response.
UriInterface|null
effectiveUri()
Get the effective URI of the response.
bool
successful()
Determine if the request was successful.
bool
redirect()
Determine if the response was a redirect.
bool
failed()
Determine if the response indicates a client or server error occurred.
bool
clientError()
Determine if the response indicates a client error occurred.
bool
serverError()
Determine if the response indicates a server error occurred.
$this
onError(callable $callback)
Execute the given callback if there was a server or client error.
CookieJar
cookies()
Get the response cookies.
array
handlerStats()
Get the handler stats of the response.
$this
close()
Close the stream and any underlying resources.
ResponseInterface
toPsrResponse()
Get the underlying PSR response for the response.
RequestException|null
toException()
Create an exception if a server or client error occurred.
$this
throw()
Throw an exception if a server or client error occurred.
$this
throwIf(Closure|bool $condition)
Throw an exception if a server or client error occurred and the given condition evaluates to true.
$this
throwIfStatus(callable|int $statusCode)
Throw an exception if the response status code matches the given code.
$this
throwUnlessStatus(callable|int $statusCode)
Throw an exception unless the response status code matches the given code.
$this
throwIfClientError()
Throw an exception if the response status code is a 4xx level code.
$this
throwIfServerError()
Throw an exception if the response status code is a 5xx level code.
bool
offsetExists(string $offset)
Determine if the given offset exists.
mixed
offsetGet(string $offset)
Get the value for a given offset.
void
offsetSet(string $offset, mixed $value)
Set the value at the given offset.
void
offsetUnset(string $offset)
Unset the value at the given offset.
string
__toString()
Get the body of the response.