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

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.

make(string $content = '', int $status = 200, array $headers = [])

Return a new response from the application.

view(string $view, array $data = [], int $status = 200, array $headers = [])

Return a new view response from the application.

json(string|array $data = [], int $status = 200, array $headers = [], int $options = 0)

Return a new JSON response from the application.

jsonp(string $callback, string|array $data = [], int $status = 200, array $headers = [], int $options = 0)

Return a new JSONP response from the application.

StreamedResponse
stream(Closure $callback, int $status = 200, array $headers = [])

Return a new streamed response from the application.

BinaryFileResponse
download(SplFileInfo|string $file, string $name = null, array $headers = [], string|null $disposition = 'attachment')

Create a new file download response.

BinaryFileResponse
file(SplFileInfo|string $file, array $headers = [])

Return the raw contents of a binary file.

redirectTo(string $path, int $status = 302, array $headers = [], bool|null $secure = null)

Create a new redirect response to the given path.

redirectToRoute(string $route, array $parameters = [], int $status = 302, array $headers = [])

Create a new redirect response to a named route.

redirectToAction(string $action, array $parameters = [], int $status = 302, array $headers = [])

Create a new redirect response to a controller action.

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.

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.

Parameters

string $name
object|callable $macro

Return Value

void

static void mixin(object $mixin)

Mix another object into the class.

Parameters

object $mixin

Return Value

void

static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

void __construct(Factory $view, Redirector $redirector)

Create a new response factory instance.

Parameters

Factory $view
Redirector $redirector

Return Value

void

Response make(string $content = '', int $status = 200, array $headers = [])

Return a new response from the application.

Parameters

string $content
int $status
array $headers

Return Value

Response

Response view(string $view, array $data = [], int $status = 200, array $headers = [])

Return a new view response from the application.

Parameters

string $view
array $data
int $status
array $headers

Return Value

Response

JsonResponse json(string|array $data = [], int $status = 200, array $headers = [], int $options = 0)

Return a new JSON response from the application.

Parameters

string|array $data
int $status
array $headers
int $options

Return Value

JsonResponse

JsonResponse jsonp(string $callback, string|array $data = [], int $status = 200, array $headers = [], int $options = 0)

Return a new JSONP response from the application.

Parameters

string $callback
string|array $data
int $status
array $headers
int $options

Return Value

JsonResponse

StreamedResponse stream(Closure $callback, int $status = 200, array $headers = [])

Return a new streamed response from the application.

Parameters

Closure $callback
int $status
array $headers

Return Value

StreamedResponse

BinaryFileResponse download(SplFileInfo|string $file, string $name = null, array $headers = [], string|null $disposition = 'attachment')

Create a new file download response.

Parameters

SplFileInfo|string $file
string $name
array $headers
string|null $disposition

Return Value

BinaryFileResponse

BinaryFileResponse file(SplFileInfo|string $file, array $headers = [])

Return the raw contents of a binary file.

Parameters

SplFileInfo|string $file
array $headers

Return Value

BinaryFileResponse

RedirectResponse redirectTo(string $path, int $status = 302, array $headers = [], bool|null $secure = null)

Create a new redirect response to the given path.

Parameters

string $path
int $status
array $headers
bool|null $secure

Return Value

RedirectResponse

RedirectResponse redirectToRoute(string $route, array $parameters = [], int $status = 302, array $headers = [])

Create a new redirect response to a named route.

Parameters

string $route
array $parameters
int $status
array $headers

Return Value

RedirectResponse

RedirectResponse redirectToAction(string $action, array $parameters = [], int $status = 302, array $headers = [])

Create a new redirect response to a controller action.

Parameters

string $action
array $parameters
int $status
array $headers

Return Value

RedirectResponse

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.

Parameters

string $path
int $status
array $headers
bool|null $secure

Return Value

RedirectResponse

RedirectResponse redirectToIntended(string $default = '/', int $status = 302, array $headers = [], bool|null $secure = null)

Create a new redirect response to the previously intended location.

Parameters

string $default
int $status
array $headers
bool|null $secure

Return Value

RedirectResponse