Response
class Response extends Response implements Transient
Traits
Inline Symfony's side-effect-free common response preparation path.
Properties
| static protected array | $macros | The registered string macros. |
from Macroable |
| 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 ResponseHeaderBag|null | $headerPrototype | The pristine header bag cloned for each response. |
|
| static protected int | $headerPrototypeTimestamp | Unix second represented by the prototype's Date header. |
Methods
Mix another object into the class.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Prepare the response before it is emitted.
Set a header on the Response.
Add an array of headers to the response.
Remove a header(s) from the response.
Expire a cookie when sending the response.
Expire multiple cookies when sending the response.
Create a new HTTP response.
Get the response content.
Set the content on the response.
Determine if the given content should be turned into JSON.
Morph the given content into JSON.
Send HTTP headers.
Send response content.
Send HTTP headers and content.
Flush all static state.
Details
in
Macroable at line 28
static void
macro(string $name, callable|object $macro)
Register a custom macro.
Boot-only. Macros persist in a static property for the worker lifetime and apply to every subsequent call on the macroable class.
in
Macroable at line 41
static void
mixin(object $mixin, bool $replace = true)
Mix another object into the class.
Boot-only. Delegates to macro() for each method; registered macros persist in a static property for the worker lifetime.
in
Macroable at line 57
static bool
hasMacro(string $name)
Check if macro is registered.
in
Macroable at line 68
static void
flushMacros()
Flush the existing macros.
Boot or tests only. Clears worker-wide macros; concurrent coroutines may resolve different methods depending on timing.
in
Macroable at line 78
static mixed
__callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
in
Macroable at line 103
mixed
__call(string $method, array $parameters)
Dynamically handle calls to the class.
in
PreparesResponse at line 21
PreparesResponse
prepare(Request $request)
Prepare the response before it is emitted.
in
ResponseTrait at line 26
int
status()
Get the status code for the response.
in
ResponseTrait at line 34
string
statusText()
Get the status text for the response.
in
ResponseTrait at line 42
string
content()
Get the content of the response.
in
ResponseTrait at line 50
mixed
getOriginalContent()
Get the original response content.
in
ResponseTrait at line 62
ResponseTrait
header(string $key, array|string $values, bool $replace = true)
Set a header on the Response.
in
ResponseTrait at line 74
ResponseTrait
withHeaders(HeaderBag|array $headers)
Add an array of headers to the response.
in
ResponseTrait at line 92
ResponseTrait
withoutHeader(array|string $key)
Remove a header(s) from the response.
in
ResponseTrait at line 106
ResponseTrait
cookie(mixed $cookie)
Add a cookie to the response.
in
ResponseTrait at line 116
ResponseTrait
withCookie(mixed $cookie)
Add a cookie to the response.
in
ResponseTrait at line 132
ResponseTrait
withCookies(array $cookies)
Add multiple cookies to the response.
in
ResponseTrait at line 146
ResponseTrait
withoutCookie(mixed $cookie, string|null $path = null, string|null $domain = null)
Expire a cookie when sending the response.
in
ResponseTrait at line 162
ResponseTrait
withoutCookies(array $cookies, string|null $path = null, string|null $domain = null)
Expire multiple cookies when sending the response.
in
ResponseTrait at line 174
string|null
getCallback()
Get the callback of the response.
in
ResponseTrait at line 184
ResponseTrait
withException(Throwable $e)
Set the exception to attach to the response.
in
ResponseTrait at line 196
never
throwResponse()
Throw the response in a HttpResponseException instance.
at line 44
__construct(mixed $content = '', int $status = 200, array|ResponseHeaderBag $headers = [])
Create a new HTTP response.
at line 77
string
getContent()
Get the response content.
at line 90
Response
setContent(mixed $content)
Set the content on the response.
at line 129
protected bool
shouldBeJson(mixed $content)
Determine if the given content should be turned into JSON.
at line 141
protected string|false
morphToJson(mixed $content)
Morph the given content into JSON.
at line 158
never
sendHeaders(int|null $statusCode = null)
Send HTTP headers.
at line 169
never
sendContent()
Send response content.
at line 180
never
send(bool $flush = true)
Send HTTP headers and content.
at line 189
static void
flushState()
Flush all static state.