class Response extends Response (View source)

Traits

Properties

mixed $original The original content of the response. from ResponseTrait
Exception|null $exception The exception that triggered the error response (if applicable). from ResponseTrait
static protected array $macros The registered string macros. from Macroable

Methods

int
status()

Get the status code for the response.

string
content()

Get the content of the response.

mixed
getOriginalContent()

Get the original response content.

$this
header(string $key, array|string $values, bool $replace = true)

Set a header on the Response.

$this
withHeaders(HeaderBag|array $headers)

Add an array of headers to the response.

$this
cookie(Cookie|mixed $cookie)

Add a cookie to the response.

$this
withCookie(Cookie|mixed $cookie)

Add a cookie to the response.

$this
withException(Exception $e)

Set the exception to attach to the response.

throwResponse()

Throws the response in a HttpResponseException instance.

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

Register a custom macro.

from Macroable
static void
mixin(object $mixin)

Mix another object into the class.

from Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

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

Dynamically handle calls to the class.

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

Dynamically handle calls to the class.

from Macroable
$this
setContent(mixed $content)

Set the content on the response.

bool
shouldBeJson(mixed $content)

Determine if the given content should be turned into JSON.

string
morphToJson(mixed $content)

Morph the given content into JSON.

Details

int status()

Get the status code for the response.

Return Value

int

string content()

Get the content of the response.

Return Value

string

mixed getOriginalContent()

Get the original response content.

Return Value

mixed

$this header(string $key, array|string $values, bool $replace = true)

Set a header on the Response.

Parameters

string $key
array|string $values
bool $replace

Return Value

$this

$this withHeaders(HeaderBag|array $headers)

Add an array of headers to the response.

Parameters

HeaderBag|array $headers

Return Value

$this

Add a cookie to the response.

Parameters

Cookie|mixed $cookie

Return Value

$this

$this withCookie(Cookie|mixed $cookie)

Add a cookie to the response.

Parameters

Cookie|mixed $cookie

Return Value

$this

$this withException(Exception $e)

Set the exception to attach to the response.

Parameters

Exception $e

Return Value

$this

throwResponse()

Throws the response in a HttpResponseException instance.

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

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

static void mixin(object $mixin)

Mix another object into the class.

Parameters

object $mixin

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

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

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

$this setContent(mixed $content)

Set the content on the response.

Parameters

mixed $content

Return Value

$this

protected bool shouldBeJson(mixed $content)

Determine if the given content should be turned into JSON.

Parameters

mixed $content

Return Value

bool

protected string morphToJson(mixed $content)

Morph the given content into JSON.

Parameters

mixed $content

Return Value

string