W3cubDocs

/Laravel 11

Response

class Response extends Response (View source)

Traits

ResponseTrait
Macroable

Properties

mixed $original

The original content of the response.

 from ResponseTrait
Throwable|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.

 from ResponseTrait
string statusText()

Get the status text for the response.

 from ResponseTrait
string content()

Get the content of the response.

 from ResponseTrait
mixed getOriginalContent()

Get the original response content.

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

Set a header on the Response.

 from ResponseTrait
$this withHeaders(HeaderBag|array $headers)

Add an array of headers to the response.

 from ResponseTrait
$this cookie(Cookie|mixed $cookie)

Add a cookie to the response.

 from ResponseTrait
$this withCookie(Cookie|mixed $cookie)

Add a cookie to the response.

 from ResponseTrait
$this withoutCookie(Cookie|mixed $cookie, string|null $path = null, string|null $domain = null)

Expire a cookie when sending the response.

 from ResponseTrait
string|null getCallback()

Get the callback of the response.

 from ResponseTrait
$this withException(Throwable $e)

Set the exception to attach to the response.

 from ResponseTrait
void throwResponse()

Throws the response in a HttpResponseException instance.

 from ResponseTrait
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 handle calls to the class.

 from Macroable
void __construct(mixed $content = '', int $status = 200, array $headers = [])

Create a new HTTP response.
Response setContent(mixed $content)

Set the content on the response.
bool shouldBeJson(mixed $content)

Determine if the given content should be turned into JSON.
string|false morphToJson(mixed $content)

Morph the given content into JSON.

Details

int status()

Get the status code for the response.

Return Value

int

string statusText()

Get the status text for the response.

Return Value

string

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 withoutCookie(Cookie|mixed $cookie, string|null $path = null, string|null $domain = null)

Expire a cookie when sending the response.

Parameters

Cookie|mixed $cookie
string|null $path
string|null $domain

Return Value

$this

string|null getCallback()

Get the callback of the response.

Return Value

string|null

$this withException(Throwable $e)

Set the exception to attach to the response.

Parameters

Throwable $e

Return Value

$this

void throwResponse()

Throws the response in a HttpResponseException instance.

Return Value

void

Exceptions

HttpResponseException

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, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

static void flushMacros()

Flush the existing macros.

Return Value

void

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

void __construct(mixed $content = '', int $status = 200, array $headers = [])

Create a new HTTP response.

Parameters

mixed $content
int $status
array $headers

Return Value

void

Exceptions

InvalidArgumentException

Response setContent(mixed $content)

Set the content on the response.

Parameters

mixed $content

Return Value

Response

Exceptions

InvalidArgumentException

protected bool shouldBeJson(mixed $content)

Determine if the given content should be turned into JSON.

Parameters

mixed $content

Return Value

bool

protected string|false morphToJson(mixed $content)

Morph the given content into JSON.

Parameters

mixed $content

Return Value

string|false

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Http/Response.html