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

Redirector

class Redirector (View source)

Traits

Macroable

Properties

static protected array $macros

The registered string macros.

 from  Macroable
protected UrlGenerator $generator

The URL generator instance.
protected Store $session

The session store instance.

Methods

static void
macro(string $name, object|callable $macro)

Register a custom macro.

from  Macroable
static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

from  Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

from  Macroable
static void
flushMacros()

Flush the existing macros.

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
__construct(UrlGenerator $generator)

Create a new Redirector instance.

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

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|null $secure = null)

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

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

Create a new redirect response to the previously intended location.

RedirectResponse
to(string $path, int $status = 302, array $headers = [], bool|null $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(BackedEnum|string $route, mixed $parameters = [], int $status = 302, array $headers = [])

Create a new redirect response to a named route.

RedirectResponse
signedRoute(BackedEnum|string $route, mixed $parameters = [], DateTimeInterface|DateInterval|int|null $expiration = null, int $status = 302, array $headers = [])

Create a new redirect response to a signed named route.

RedirectResponse
temporarySignedRoute(BackedEnum|string $route, DateTimeInterface|DateInterval|int|null $expiration, mixed $parameters = [], int $status = 302, array $headers = [])

Create a new redirect response to a signed named route.

RedirectResponse
action(string|array $action, mixed $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.

string|null
getIntendedUrl()

Get the "intended" URL from the session.

$this
setIntendedUrl(string $url)

Set the "intended" URL in the session.

Details

in Macroable at line 29
static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

in Macroable at line 43
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 62
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Return Value

void

in Macroable at line 86
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 112
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 32
__construct(UrlGenerator $generator)

Create a new Redirector instance.

Parameters

UrlGenerator $generator

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

at line 57
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 71
RedirectResponse guest(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 95
RedirectResponse intended(mixed $default = '/', int $status = 302, array $headers = [], bool|null $secure = null)

Create a new redirect response to the previously intended location.

Parameters

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

Return Value

RedirectResponse

at line 111
RedirectResponse to(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 124
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 137
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 151
RedirectResponse route(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 166
RedirectResponse signedRoute(BackedEnum|string $route, mixed $parameters = [], DateTimeInterface|DateInterval|int|null $expiration = null, int $status = 302, array $headers = [])

Create a new redirect response to a signed named route.

Parameters

BackedEnum|string $route
mixed $parameters
DateTimeInterface|DateInterval|int|null $expiration
int $status
array $headers

Return Value

RedirectResponse

at line 181
RedirectResponse temporarySignedRoute(BackedEnum|string $route, DateTimeInterface|DateInterval|int|null $expiration, mixed $parameters = [], int $status = 302, array $headers = [])

Create a new redirect response to a signed named route.

Parameters

BackedEnum|string $route
DateTimeInterface|DateInterval|int|null $expiration
mixed $parameters
int $status
array $headers

Return Value

RedirectResponse

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

Create a new redirect response to a controller action.

Parameters

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

Return Value

RedirectResponse

at line 208
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 224
UrlGenerator getUrlGenerator()

Get the URL generator instance.

Return Value

UrlGenerator

at line 235
void setSession(Store $session)

Set the active session store.

Parameters

Store $session

Return Value

void

at line 245
string|null getIntendedUrl()

Get the "intended" URL from the session.

Return Value

string|null

at line 256
$this setIntendedUrl(string $url)

Set the "intended" URL in the session.

Parameters

string $url

Return Value

$this