1. interface
  2. Hypervel
  3. \
  4. Contracts
  5. \
  6. Routing
  7. \
  8. ResponseFactory

ResponseFactory

interface ResponseFactory

Methods

Response
make(mixed $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(array|string $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 = [], StreamedEvent|string|null $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 = 15)

Create a new streamed JSON response instance.

StreamedResponse
streamDownload(callable $callback, string|null $name = null, array $headers = [], string $disposition = 'attachment')

Create a new streamed response instance as a file download.

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

Create a new file download response.

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.

Details

at line 23
Response make(mixed $content = '', int $status = 200, array $headers = [])

Create a new response instance.

Parameters

mixed $content
int $status
array $headers

Return Value

Response

at line 28
Response noContent(int $status = 204, array $headers = [])

Create a new "no content" response.

Parameters

int $status
array $headers

Return Value

Response

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

Create a new response for a given view.

Parameters

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

Return Value

Response

at line 38
JsonResponse json(mixed $data = [], int $status = 200, array $headers = [], int $options = 0)

Create a new JSON response instance.

Parameters

mixed $data
int $status
array $headers
int $options

Return Value

JsonResponse

at line 43
JsonResponse jsonp(string $callback, mixed $data = [], int $status = 200, array $headers = [], int $options = 0)

Create a new JSONP response instance.

Parameters

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

Return Value

JsonResponse

at line 48
StreamedResponse eventStream(Closure $callback, array $headers = [], StreamedEvent|string|null $endStreamWith = '</stream>')

Create a new event stream response.

Parameters

Closure $callback
array $headers
StreamedEvent|string|null $endStreamWith

Return Value

StreamedResponse

at line 53
StreamedResponse stream(callable $callback, int $status = 200, array $headers = [])

Create a new streamed response instance.

Parameters

callable $callback
int $status
array $headers

Return Value

StreamedResponse

at line 58
StreamedJsonResponse streamJson(array $data, int $status = 200, array $headers = [], int $encodingOptions = 15)

Create a new streamed JSON response instance.

Parameters

array $data
int $status
array $headers
int $encodingOptions

Return Value

StreamedJsonResponse

at line 63
StreamedResponse streamDownload(callable $callback, string|null $name = null, array $headers = [], string $disposition = 'attachment')

Create a new streamed response instance as a file download.

Parameters

callable $callback
string|null $name
array $headers
string $disposition

Return Value

StreamedResponse

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

Create a new file download response.

Parameters

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

Return Value

BinaryFileResponse

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

Return the raw contents of a binary file.

Parameters

SplFileInfo|string $file
array $headers

Return Value

BinaryFileResponse

at line 78
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

at line 83
RedirectResponse redirectToRoute(BackedEnum|string $route, mixed $parameters = [], int $status = 302, array $headers = [])

Create a new redirect response to a named route.

Parameters

BackedEnum|string $route
mixed $parameters
int $status
array $headers

Return Value

RedirectResponse

at line 88
RedirectResponse redirectToAction(array|string $action, mixed $parameters = [], int $status = 302, array $headers = [])

Create a new redirect response to a controller action.

Parameters

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

Return Value

RedirectResponse

at line 93
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

at line 98
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