1. class
  2. Illuminate
  3. \
  4. Http
  5. \
  6. Client
  7. \
  8. Response

Response

class Response implements ArrayAccess, Stringable mixin ResponseInterface (View source)

Traits

DeterminesStatusCode
Macroable

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

bool
ok()

Determine if the response code was 200 "OK" response.

from  DeterminesStatusCode
bool
created()

Determine if the response code was 201 "Created" response.

from  DeterminesStatusCode
bool
accepted()

Determine if the response code was 202 "Accepted" response.

from  DeterminesStatusCode
bool
noContent(int $status = 204)

Determine if the response code was the given status code and the body has no content.

from  DeterminesStatusCode
bool
movedPermanently()

Determine if the response code was a 301 "Moved Permanently".

from  DeterminesStatusCode
bool
found()

Determine if the response code was a 302 "Found" response.

from  DeterminesStatusCode
bool
notModified()

Determine if the response code was a 304 "Not Modified" response.

from  DeterminesStatusCode
bool
badRequest()

Determine if the response was a 400 "Bad Request" response.

from  DeterminesStatusCode
bool
unauthorized()

Determine if the response was a 401 "Unauthorized" response.

from  DeterminesStatusCode
bool
paymentRequired()

Determine if the response was a 402 "Payment Required" response.

from  DeterminesStatusCode
bool
forbidden()

Determine if the response was a 403 "Forbidden" response.

from  DeterminesStatusCode
bool
notFound()

Determine if the response was a 404 "Not Found" response.

from  DeterminesStatusCode
bool
requestTimeout()

Determine if the response was a 408 "Request Timeout" response.

from  DeterminesStatusCode
bool
conflict()

Determine if the response was a 409 "Conflict" response.

from  DeterminesStatusCode
bool
unprocessableContent()

Determine if the response was a 422 "Unprocessable Content" response.

from  DeterminesStatusCode
bool
unprocessableEntity()

Determine if the response was a 422 "Unprocessable Content" response.

from  DeterminesStatusCode
bool
tooManyRequests()

Determine if the response was a 429 "Too Many Requests" response.

from  DeterminesStatusCode
static void
macro(string $name, object|callable $macro)

Register a custom macro.

from  Macroable
static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

from  Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

from  Macroable
static void
flushMacros()

Flush the existing macros.

from  Macroable
static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
mixed
__call(string $method, array $parameters)

Dynamically proxy other methods to the underlying response.

__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|null
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.

Fluent
fluent(string|null $key = null)

Get the JSON decoded body of the response as a fluent object.

resource
resource()

Get the body of the response as a PHP resource.

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.

$this
dump(string|null $key = null)

Dump the content from the response.

never
dd(string|null $key = null)

Dump the content from the response and end the script.

$this
dumpHeaders()

Dump the headers from the response.

never
ddHeaders()

Dump the headers from the response and end the script.

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.

Details

in DeterminesStatusCode at line 12
bool ok()

Determine if the response code was 200 "OK" response.

Return Value

bool

in DeterminesStatusCode at line 22
bool created()

Determine if the response code was 201 "Created" response.

Return Value

bool

in DeterminesStatusCode at line 32
bool accepted()

Determine if the response code was 202 "Accepted" response.

Return Value

bool

in DeterminesStatusCode at line 43
bool noContent(int $status = 204)

Determine if the response code was the given status code and the body has no content.

Parameters

int $status

Return Value

bool

in DeterminesStatusCode at line 53
bool movedPermanently()

Determine if the response code was a 301 "Moved Permanently".

Return Value

bool

in DeterminesStatusCode at line 63
bool found()

Determine if the response code was a 302 "Found" response.

Return Value

bool

in DeterminesStatusCode at line 73
bool notModified()

Determine if the response code was a 304 "Not Modified" response.

Return Value

bool

in DeterminesStatusCode at line 83
bool badRequest()

Determine if the response was a 400 "Bad Request" response.

Return Value

bool

in DeterminesStatusCode at line 93
bool unauthorized()

Determine if the response was a 401 "Unauthorized" response.

Return Value

bool

in DeterminesStatusCode at line 103
bool paymentRequired()

Determine if the response was a 402 "Payment Required" response.

Return Value

bool

in DeterminesStatusCode at line 113
bool forbidden()

Determine if the response was a 403 "Forbidden" response.

Return Value

bool

in DeterminesStatusCode at line 123
bool notFound()

Determine if the response was a 404 "Not Found" response.

Return Value

bool

in DeterminesStatusCode at line 133
bool requestTimeout()

Determine if the response was a 408 "Request Timeout" response.

Return Value

bool

in DeterminesStatusCode at line 143
bool conflict()

Determine if the response was a 409 "Conflict" response.

Return Value

bool

in DeterminesStatusCode at line 153
bool unprocessableContent()

Determine if the response was a 422 "Unprocessable Content" response.

Return Value

bool

in DeterminesStatusCode at line 163
bool unprocessableEntity()

Determine if the response was a 422 "Unprocessable Content" response.

Return Value

bool

in DeterminesStatusCode at line 173
bool tooManyRequests()

Determine if the response was a 429 "Too Many Requests" response.

Return Value

bool

in Macroable at line 29
static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

in Macroable at line 43
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 62
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Return Value

void

in Macroable at line 86
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 526
mixed __call(string $method, array $parameters)

Dynamically proxy other methods to the underlying response.

Parameters

string $method
array $parameters

Return Value

mixed

at line 55
__construct(MessageInterface $response)

Create a new response instance.

Parameters

MessageInterface $response

at line 65
string body()

Get the body of the response.

Return Value

string

at line 77
mixed json(string|null $key = null, mixed $default = null)

Get the JSON decoded body of the response as an array or scalar value.

Parameters

string|null $key
mixed $default

Return Value

mixed

at line 95
object|null object()

Get the JSON decoded body of the response as an object.

Return Value

object|null

at line 106
Collection collect(string|null $key = null)

Get the JSON decoded body of the response as a collection.

Parameters

string|null $key

Return Value

Collection

at line 117
Fluent fluent(string|null $key = null)

Get the JSON decoded body of the response as a fluent object.

Parameters

string|null $key

Return Value

Fluent

at line 129
resource resource()

Get the body of the response as a PHP resource.

Return Value

resource

Exceptions

InvalidArgumentException

at line 140
string header(string $header)

Get a header from the response.

Parameters

string $header

Return Value

string

at line 150
array headers()

Get the headers from the response.

Return Value

array

at line 160
int status()

Get the status code of the response.

Return Value

int

at line 170
string reason()

Get the reason phrase of the response.

Return Value

string

at line 180
UriInterface|null effectiveUri()

Get the effective URI of the response.

Return Value

UriInterface|null

at line 190
bool successful()

Determine if the request was successful.

Return Value

bool

at line 200
bool redirect()

Determine if the response was a redirect.

Return Value

bool

at line 210
bool failed()

Determine if the response indicates a client or server error occurred.

Return Value

bool

at line 220
bool clientError()

Determine if the response indicates a client error occurred.

Return Value

bool

at line 230
bool serverError()

Determine if the response indicates a server error occurred.

Return Value

bool

at line 241
$this onError(callable $callback)

Execute the given callback if there was a server or client error.

Parameters

callable $callback

Return Value

$this

at line 255
CookieJar cookies()

Get the response cookies.

Return Value

CookieJar

at line 265
array handlerStats()

Get the handler stats of the response.

Return Value

array

at line 275
$this close()

Close the stream and any underlying resources.

Return Value

$this

at line 287
ResponseInterface toPsrResponse()

Get the underlying PSR response for the response.

Return Value

ResponseInterface

at line 297
RequestException|null toException()

Create an exception if a server or client error occurred.

Return Value

RequestException|null

at line 311
$this throw()

Throw an exception if a server or client error occurred.

Return Value

$this

Exceptions

RequestException

at line 334
$this throwIf(Closure|bool $condition)

Throw an exception if a server or client error occurred and the given condition evaluates to true.

Parameters

Closure|bool $condition

Return Value

$this

Exceptions

RequestException

at line 347
$this throwIfStatus(callable|int $statusCode)

Throw an exception if the response status code matches the given code.

Parameters

callable|int $statusCode

Return Value

$this

Exceptions

RequestException

at line 365
$this throwUnlessStatus(callable|int $statusCode)

Throw an exception unless the response status code matches the given code.

Parameters

callable|int $statusCode

Return Value

$this

Exceptions

RequestException

at line 381
$this throwIfClientError()

Throw an exception if the response status code is a 4xx level code.

Return Value

$this

Exceptions

RequestException

at line 393
$this throwIfServerError()

Throw an exception if the response status code is a 5xx level code.

Return Value

$this

Exceptions

RequestException

at line 404
$this dump(string|null $key = null)

Dump the content from the response.

Parameters

string|null $key

Return Value

$this

at line 429
never dd(string|null $key = null)

Dump the content from the response and end the script.

Parameters

string|null $key

Return Value

never

at line 441
$this dumpHeaders()

Dump the headers from the response.

Return Value

$this

at line 453
never ddHeaders()

Dump the headers from the response and end the script.

Return Value

never

at line 466
bool offsetExists(string $offset)

Determine if the given offset exists.

Parameters

string $offset

Return Value

bool

at line 477
mixed offsetGet(string $offset)

Get the value for a given offset.

Parameters

string $offset

Return Value

mixed

at line 491
void offsetSet(string $offset, mixed $value)

Set the value at the given offset.

Parameters

string $offset
mixed $value

Return Value

void

Exceptions

LogicException

at line 504
void offsetUnset(string $offset)

Unset the value at the given offset.

Parameters

string $offset

Return Value

void

Exceptions

LogicException

at line 514
string __toString()

Get the body of the response.

Return Value

string