W3cubDocs

/Laravel 11

ResponseTrait

trait ResponseTrait (View source)

Properties

mixed $original

The original content of the response.
Throwable|null $exception

The exception that triggered the error response (if applicable).

Methods

int status()

Get the status code for the response.
string statusText()

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

Expire a cookie when sending the response.
string|null getCallback()

Get the callback of the response.
$this withException(Throwable $e)

Set the exception to attach to the response.
void throwResponse()

Throws the response in a HttpResponseException instance.

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

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