ResponseFactory
class ResponseFactory implements ResponseFactory
Traits
Properties
| static protected array | $macros | The registered string macros. |
from Macroable |
| protected Factory | $view | The view factory instance. |
|
| protected Redirector | $redirector | The redirector instance. |
Methods
Mix another object into the class.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Create a new response instance.
Create a new response for a given view.
Create a new JSON response instance.
Create a new JSONP response instance.
Create a new event stream response.
Create a new streamed response instance.
Create a new streamed JSON response instance.
Create a new streamed response instance as a file download.
Create a new file download response.
Convert the string to ASCII characters that are equivalent to the given name.
Create a new redirect response to the given path.
Create a new redirect response to a named route.
Create a new redirect response to a controller action.
Create a new redirect response, while putting the current URL in the session.
Create a new redirect response to the previously intended location.
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.
at line 44
__construct(Factory $view, Redirector $redirector)
Create a new response factory instance.
at line 53
Response
make(mixed $content = '', int $status = 200, array $headers = [])
Create a new response instance.
at line 61
Response
noContent(int $status = 204, array $headers = [])
Create a new "no content" response.
at line 69
Response
view(array|string $view, array $data = [], int $status = 200, array $headers = [])
Create a new response for a given view.
at line 81
JsonResponse
json(mixed $data = [], int $status = 200, array $headers = [], int $options = 0)
Create a new JSON response instance.
at line 89
JsonResponse
jsonp(string $callback, mixed $data = [], int $status = 200, array $headers = [], int $options = 0)
Create a new JSONP response instance.
at line 97
StreamedResponse
eventStream(Closure $callback, array $headers = [], StreamedEvent|string|null $endStreamWith = '</stream>')
Create a new event stream response.
at line 151
StreamedResponse
stream(callable $callback = null, int $status = 200, array $headers = [])
Create a new streamed response instance.
Generator callbacks are invoked once and retained as iterable chunks so the Swoole bridge can stop production immediately after a failed socket write.
at line 171
StreamedJsonResponse
streamJson(array $data, int $status = 200, array $headers = [], int $encodingOptions = JsonResponse::DEFAULT_ENCODING_OPTIONS)
Create a new streamed JSON response instance.
at line 181
StreamedResponse
streamDownload(callable $callback, string|null $name = null, array $headers = [], string $disposition = 'attachment')
Create a new streamed response instance as a file download.
at line 207
BinaryFileResponse
download(SplFileInfo|string $file, string|null $name = null, array $headers = [], string $disposition = 'attachment')
Create a new file download response.
at line 221
protected string
fallbackName(string $name)
Convert the string to ASCII characters that are equivalent to the given name.
at line 229
BinaryFileResponse
file(SplFileInfo|string $file, array $headers = [])
Return the raw contents of a binary file.
at line 237
RedirectResponse
redirectTo(string $path, int $status = 302, array $headers = [], bool|null $secure = null)
Create a new redirect response to the given path.
at line 245
RedirectResponse
redirectToRoute(BackedEnum|string $route, mixed $parameters = [], int $status = 302, array $headers = [])
Create a new redirect response to a named route.
at line 253
RedirectResponse
redirectToAction(array|string $action, mixed $parameters = [], int $status = 302, array $headers = [])
Create a new redirect response to a controller action.
at line 261
RedirectResponse
redirectGuest(string $path, int $status = 302, array $headers = [], bool|null $secure = null)
Create a new redirect response, while putting the current URL in the session.
at line 269
RedirectResponse
redirectToIntended(string $default = '/', int $status = 302, array $headers = [], bool|null $secure = null)
Create a new redirect response to the previously intended location.
at line 277
static void
flushState()
Flush all static state.