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. |
Methods
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 code was "OK".
Determine if the response was a redirect.
Determine if the response was a 401 "Unauthorized" response.
Determine if the response was a 403 "Forbidden" response.
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 a server or client error occurred and the given condition evaluates to true.
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
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
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
ok()
Determine if the response code was "OK".
bool
redirect()
Determine if the response was a redirect.
bool
unauthorized()
Determine if the response was a 401 "Unauthorized" response.
bool
forbidden()
Determine if the response was a 403 "Forbidden" response.
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(bool $condition)
Throw an exception if a server or client error occurred and the given condition evaluates to true.
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.