1. class
  2. Illuminate
  3. \
  4. Routing
  5. \
  6. Redirector

Redirector

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.

RedirectResponse
home(int $status = 302)

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

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

Create a new redirect response to the previous location.

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

Create a new redirect response to the current URI.

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.

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

Create a new redirect response to the previously intended location.

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

Create a new redirect response to the given path.

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

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

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

Create a new redirect response to the given HTTPS path.

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

Create a new redirect response to a named route.

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

Create a new redirect response to a controller action.

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

Create a new redirect response.

UrlGenerator
getUrlGenerator()

Get the URL generator instance.

void
setSession(Store $session)

Set the active session store.

Details

at line 30
void __construct(UrlGenerator $generator)

Create a new Redirector instance.

Parameters

UrlGenerator $generator

Return Value

void

at line 41
RedirectResponse home(int $status = 302)

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

Parameters

int $status

Return Value

RedirectResponse

at line 53
RedirectResponse back(int $status = 302, array $headers = [])

Create a new redirect response to the previous location.

Parameters

int $status
array $headers

Return Value

RedirectResponse

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

Create a new redirect response to the current URI.

Parameters

int $status
array $headers

Return Value

RedirectResponse

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

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

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

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

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

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

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

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

Create a new redirect response.

Parameters

string $path
int $status
array $headers

Return Value

RedirectResponse

at line 204
UrlGenerator getUrlGenerator()

Get the URL generator instance.

Return Value

UrlGenerator

at line 215
void setSession(Store $session)

Set the active session store.

Parameters

Store $session

Return Value

void