W3cubDocs

/Laravel 8

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 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
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 = [], 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(string $default = '/', int $status = 302, array $headers = [], bool|null $secure = null)

Create a new redirect response to the previously intended location.
void setIntendedUrl(string $url)

Set the intended url.
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(string $route, mixed $parameters = [], int $status = 302, array $headers = [])

Create a new redirect response to a named route.
RedirectResponse signedRoute(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(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.

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, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

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(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|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 intended(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

void setIntendedUrl(string $url)

Set the intended url.

Parameters

string $url

Return Value

void

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

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, mixed $parameters = [], int $status = 302, array $headers = [])

Create a new redirect response to a named route.

Parameters

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

Return Value

RedirectResponse

RedirectResponse signedRoute(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

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

Return Value

RedirectResponse

RedirectResponse temporarySignedRoute(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

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

Return Value

RedirectResponse

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

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

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Routing/Redirector.html