ResponseFactory
class ResponseFactory implements ResponseFactory (View source)
Traits
| Macroable |
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
| static void | macro(string $name, object|callable $macro) Register a custom macro. | from Macroable |
| static void | mixin(object $mixin) Mix another object into the class. | from Macroable |
| static bool | hasMacro(string $name) Checks if macro is registered. | 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(Factory $view, Redirector $redirector) Create a new response factory instance. | |
| Response | make(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 $view, array $data = [], int $status = 200, array $headers = []) Create a new response for a given view. | |
| JsonResponse | json(string|array $data = [], int $status = 200, array $headers = [], int $options = 0) Create a new JSON response instance. | |
| JsonResponse | jsonp(string $callback, string|array $data = [], int $status = 200, array $headers = [], int $options = 0) Create a new JSONP response instance. | |
| StreamedResponse | stream(Closure $callback, int $status = 200, array $headers = []) Create a new streamed response instance. | |
| StreamedResponse | streamDownload(Closure $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. | |
| 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(string $route, array $parameters = [], int $status = 302, array $headers = []) Create a new redirect response to a named route. | |
| RedirectResponse | redirectToAction(string $action, array $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. |
Details
static void macro(string $name, object|callable $macro)
Register a custom macro.
static void mixin(object $mixin)
Mix another object into the class.
static bool hasMacro(string $name)
Checks if macro is registered.
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(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 $view, array $data = [], int $status = 200, array $headers = [])
Create a new response for a given view.
JsonResponse json(string|array $data = [], int $status = 200, array $headers = [], int $options = 0)
Create a new JSON response instance.
JsonResponse jsonp(string $callback, string|array $data = [], int $status = 200, array $headers = [], int $options = 0)
Create a new JSONP response instance.
StreamedResponse stream(Closure $callback, int $status = 200, array $headers = [])
Create a new streamed response instance.
StreamedResponse streamDownload(Closure $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(string $route, array $parameters = [], int $status = 302, array $headers = [])
Create a new redirect response to a named route.
RedirectResponse redirectToAction(string $action, array $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.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.7/Illuminate/Routing/ResponseFactory.html