class Redirector (View source)

Properties

protected UrlGenerator $generator The URL generator instance.
protected Store $session The session store instance.

Methods

void
__construct(UrlGenerator $generator)

Create a new Redirector instance.

home(int $status = 302)

Create a new redirect response to the "home" route.

back(int $status = 302, array $headers = [], mixed $fallback = false)

Create a new redirect response to the previous location.

refresh(int $status = 302, array $headers = [])

Create a new redirect response to the current URI.

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

Create a new redirect response, while putting the current URL in the session.

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

Create a new redirect response to the previously intended location.

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

Create a new redirect response to the given path.

away(string $path, int $status = 302, array $headers = [])

Create a new redirect response to an external URL (no validation).

secure(string $path, int $status = 302, array $headers = [])

Create a new redirect response to the given HTTPS path.

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

Create a new redirect response to a named route.

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

Create a new redirect response to a controller action.

createRedirect(string $path, int $status, array $headers)

Create a new redirect response.

getUrlGenerator()

Get the URL generator instance.

void
setSession(Store $session)

Set the active session store.

Details

void __construct(UrlGenerator $generator)

Create a new Redirector instance.

Parameters

UrlGenerator $generator

Return Value

void

RedirectResponse home(int $status = 302)

Create a new redirect response to the "home" route.

Parameters

int $status

Return Value

RedirectResponse

RedirectResponse back(int $status = 302, array $headers = [], mixed $fallback = false)

Create a new redirect response to the previous location.

Parameters

int $status
array $headers
mixed $fallback

Return Value

RedirectResponse

RedirectResponse refresh(int $status = 302, array $headers = [])

Create a new redirect response to the current URI.

Parameters

int $status
array $headers

Return Value

RedirectResponse

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

Create a new redirect response, while putting the current URL in the session.

Parameters

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

Return Value

RedirectResponse

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

Create a new redirect response to the previously intended location.

Parameters

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

Return Value

RedirectResponse

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

Create a new redirect response to the given path.

Parameters

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

Return Value

RedirectResponse

RedirectResponse away(string $path, int $status = 302, array $headers = [])

Create a new redirect response to an external URL (no validation).

Parameters

string $path
int $status
array $headers

Return Value

RedirectResponse

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

Create a new redirect response to the given HTTPS path.

Parameters

string $path
int $status
array $headers

Return Value

RedirectResponse

RedirectResponse route(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 action(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

protected RedirectResponse createRedirect(string $path, int $status, array $headers)

Create a new redirect response.

Parameters

string $path
int $status
array $headers

Return Value

RedirectResponse

UrlGenerator getUrlGenerator()

Get the URL generator instance.

Return Value

UrlGenerator

void setSession(Store $session)

Set the active session store.

Parameters

Store $session

Return Value

void