ResponseFactory
class ResponseFactory implements ResponseFactory (View source)
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 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.
Details
static void
macro(string $name, object|callable $macro)
Register a custom macro.
static void
mixin(object $mixin, bool $replace = true)
Mix another object into the class.
static bool
hasMacro(string $name)
Checks if macro is registered.
static void
flushMacros()
Flush the existing macros.
static mixed
__callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
mixed
__call(string $method, array $parameters)
Dynamically handle calls to the class.
void
__construct(Factory $view, Redirector $redirector)
Create a new response factory instance.
Response
make(array|string $content = '', int $status = 200, array $headers = [])
Create a new response instance.
Response
noContent(int $status = 204, array $headers = [])
Create a new "no content" response.
Response
view(string|array $view, array $data = [], int $status = 200, array $headers = [])
Create a new response for a given view.
JsonResponse
json(mixed $data = [], int $status = 200, array $headers = [], int $options = 0)
Create a new JSON response instance.
JsonResponse
jsonp(string $callback, mixed $data = [], int $status = 200, array $headers = [], int $options = 0)
Create a new JSONP response instance.
StreamedResponse
eventStream(Closure $callback, array $headers = [], string $endStreamWith = '</stream>')
Create a new event stream response.
StreamedResponse
stream(callable $callback, int $status = 200, array $headers = [])
Create a new streamed response instance.
StreamedJsonResponse
streamJson(array $data, int $status = 200, array $headers = [], int $encodingOptions = JsonResponse::DEFAULT_ENCODING_OPTIONS)
Create a new streamed response instance.
StreamedResponse
streamDownload(callable $callback, string|null $name = null, array $headers = [], string|null $disposition = 'attachment')
Create a new streamed response instance as a file download.
BinaryFileResponse
download(SplFileInfo|string $file, string|null $name = null, array $headers = [], string|null $disposition = 'attachment')
Create a new file download response.
protected string
fallbackName(string $name)
Convert the string to ASCII characters that are equivalent to the given name.
BinaryFileResponse
file(SplFileInfo|string $file, array $headers = [])
Return the raw contents of a binary file.
RedirectResponse
redirectTo(string $path, int $status = 302, array $headers = [], bool|null $secure = null)
Create a new redirect response to the given path.
RedirectResponse
redirectToRoute(BackedEnum|string $route, mixed $parameters = [], int $status = 302, array $headers = [])
Create a new redirect response to a named route.
RedirectResponse
redirectToAction(array|string $action, mixed $parameters = [], int $status = 302, array $headers = [])
Create a new redirect response to a controller action.
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.
RedirectResponse
redirectToIntended(string $default = '/', int $status = 302, array $headers = [], bool|null $secure = null)
Create a new redirect response to the previously intended location.
Laravel Cloud is the best place to deploy Laravel, Nuxt, Express, Hono, Node.js, Bun, Go, Flask, Python, and more, with dedicated infrastructure available on AWS through Laravel Private Cloud.