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

UrlGenerator

class UrlGenerator implements UrlGenerator (View source)

Traits

InteractsWithTime
Macroable

Properties

static protected array $macros The registered string macros. from Macroable
protected RouteCollection $routes The route collection.
protected Request $request The request instance.
protected string $assetRoot The asset root URL.
protected string $forcedRoot The forced URL root.
protected string $forceScheme The forced scheme for URLs.
protected string|null $cachedRoot A cached copy of the URL root for the current request.
protected string|null $cachedScheme A cached copy of the URL scheme for the current request.
protected string $rootNamespace The root namespace being applied to controller actions.
protected callable $sessionResolver The session resolver callable.
protected callable $keyResolver The encryption key resolver callable.
protected Closure $formatHostUsing The callback to use to format hosts.
protected Closure $formatPathUsing The callback to use to format paths.
protected RouteUrlGenerator|null $routeGenerator The route URL generator instance.

Methods

int
secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

from InteractsWithTime
int
availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

from InteractsWithTime
DateTimeInterface|int
parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

from InteractsWithTime
int
currentTime()

Get the current system time as a UNIX timestamp.

from InteractsWithTime
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(RouteCollection $routes, Request $request, string|null $assetRoot = null)

Create a new URL Generator instance.

string
full()

Get the full URL for the current request.

string
current()

Get the current URL for the request.

string
previous(mixed $fallback = false)

Get the URL for the previous request.

string|null
getPreviousUrlFromSession()

Get the previous URL from the session if possible.

string
to(string $path, mixed $extra = [], bool|null $secure = null)

Generate an absolute URL to the given path.

string
secure(string $path, array $parameters = [])

Generate a secure, absolute URL to the given path.

string
asset(string $path, bool|null $secure = null)

Generate the URL to an application asset.

string
secureAsset(string $path)

Generate the URL to a secure asset.

string
assetFrom(string $root, string $path, bool|null $secure = null)

Generate the URL to an asset from a custom root domain such as CDN, etc.

string
removeIndex(string $root)

Remove the index.php file from a path.

string
formatScheme(bool|null $secure = null)

Get the default scheme for a raw URL.

string
signedRoute(string $name, array $parameters = [], DateTimeInterface|DateInterval|int|null $expiration = null, bool $absolute = true)

Create a signed route URL for a named route.

string
temporarySignedRoute(string $name, DateTimeInterface|DateInterval|int $expiration, array $parameters = [], bool $absolute = true)

Create a temporary signed route URL for a named route.

bool
hasValidSignature(Request $request, bool $absolute = true)

Determine if the given request has a valid signature.

bool
hasCorrectSignature(Request $request, bool $absolute = true)

Determine if the signature from the given request matches the URL.

bool
signatureHasNotExpired(Request $request)

Determine if the expires timestamp from the given request is not from the past.

string
route(string $name, mixed $parameters = [], bool $absolute = true)

Get the URL to a named route.

string
toRoute(Route $route, mixed $parameters, bool $absolute)

Get the URL for a given route instance.

string
action(string|array $action, mixed $parameters = [], bool $absolute = true)

Get the URL to a controller action.

string
formatAction(string|array $action)

Format the given controller action.

array
formatParameters(mixed|array $parameters)

Format the array of URL parameters.

array
extractQueryString(string $path)

Extract the query string from the given path.

string
formatRoot(string $scheme, string|null $root = null)

Get the base URL for the request.

string
format(string $root, string $path, Route|null $route = null)

Format the given URL segments into a single URL.

bool
isValidUrl(string $path)

Determine if the given path is a valid URL.

RouteUrlGenerator
routeUrl()

Get the Route URL generator instance.

void
defaults(array $defaults)

Set the default named parameters used by the URL generator.

array
getDefaultParameters()

Get the default named parameters used by the URL generator.

void
forceScheme(string $scheme)

Force the scheme for URLs.

void
forceRootUrl(string $root)

Set the forced root URL.

$this
formatHostUsing(Closure $callback)

Set a callback to be used to format the host of generated URLs.

$this
formatPathUsing(Closure $callback)

Set a callback to be used to format the path of generated URLs.

Closure
pathFormatter()

Get the path formatter being used by the URL generator.

Request
getRequest()

Get the request instance.

void
setRequest(Request $request)

Set the current request instance.

$this
setRoutes(RouteCollection $routes)

Set the route collection.

Store|null
getSession()

Get the session implementation from the resolver.

$this
setSessionResolver(callable $sessionResolver)

Set the session resolver for the generator.

$this
setKeyResolver(callable $keyResolver)

Set the encryption key resolver.

$this
setRootControllerNamespace(string $rootNamespace)

Set the root controller namespace.

Details

in InteractsWithTime at line 16
protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

in InteractsWithTime at line 31
protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

in InteractsWithTime at line 46
protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

DateTimeInterface|int

in InteractsWithTime at line 60
protected int currentTime()

Get the current system time as a UNIX timestamp.

Return Value

int

in Macroable at line 26
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 40
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 60
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 74
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 100
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 120
void __construct(RouteCollection $routes, Request $request, string|null $assetRoot = null)

Create a new URL Generator instance.

Parameters

RouteCollection $routes
Request $request
string|null $assetRoot

Return Value

void

at line 133
string full()

Get the full URL for the current request.

Return Value

string

at line 143
string current()

Get the current URL for the request.

Return Value

string

at line 154
string previous(mixed $fallback = false)

Get the URL for the previous request.

Parameters

mixed $fallback

Return Value

string

at line 174
protected string|null getPreviousUrlFromSession()

Get the previous URL from the session if possible.

Return Value

string|null

at line 189
string to(string $path, mixed $extra = [], bool|null $secure = null)

Generate an absolute URL to the given path.

Parameters

string $path
mixed $extra
bool|null $secure

Return Value

string

at line 221
string secure(string $path, array $parameters = [])

Generate a secure, absolute URL to the given path.

Parameters

string $path
array $parameters

Return Value

string

at line 233
string asset(string $path, bool|null $secure = null)

Generate the URL to an application asset.

Parameters

string $path
bool|null $secure

Return Value

string

at line 255
string secureAsset(string $path)

Generate the URL to a secure asset.

Parameters

string $path

Return Value

string

at line 268
string assetFrom(string $root, string $path, bool|null $secure = null)

Generate the URL to an asset from a custom root domain such as CDN, etc.

Parameters

string $root
string $path
bool|null $secure

Return Value

string

at line 284
protected string removeIndex(string $root)

Remove the index.php file from a path.

Parameters

string $root

Return Value

string

at line 297
string formatScheme(bool|null $secure = null)

Get the default scheme for a raw URL.

Parameters

bool|null $secure

Return Value

string

at line 319
string signedRoute(string $name, array $parameters = [], DateTimeInterface|DateInterval|int|null $expiration = null, bool $absolute = true)

Create a signed route URL for a named route.

Parameters

string $name
array $parameters
DateTimeInterface|DateInterval|int|null $expiration
bool $absolute

Return Value

string

at line 345
string temporarySignedRoute(string $name, DateTimeInterface|DateInterval|int $expiration, array $parameters = [], bool $absolute = true)

Create a temporary signed route URL for a named route.

Parameters

string $name
DateTimeInterface|DateInterval|int $expiration
array $parameters
bool $absolute

Return Value

string

at line 357
bool hasValidSignature(Request $request, bool $absolute = true)

Determine if the given request has a valid signature.

Parameters

Request $request
bool $absolute

Return Value

bool

at line 370
bool hasCorrectSignature(Request $request, bool $absolute = true)

Determine if the signature from the given request matches the URL.

Parameters

Request $request
bool $absolute

Return Value

bool

at line 389
bool signatureHasNotExpired(Request $request)

Determine if the expires timestamp from the given request is not from the past.

Parameters

Request $request

Return Value

bool

at line 406
string route(string $name, mixed $parameters = [], bool $absolute = true)

Get the URL to a named route.

Parameters

string $name
mixed $parameters
bool $absolute

Return Value

string

Exceptions

RouteNotFoundException

at line 425
string toRoute(Route $route, mixed $parameters, bool $absolute)

Get the URL for a given route instance.

Parameters

Route $route
mixed $parameters
bool $absolute

Return Value

string

Exceptions

UrlGenerationException

at line 442
string action(string|array $action, mixed $parameters = [], bool $absolute = true)

Get the URL to a controller action.

Parameters

string|array $action
mixed $parameters
bool $absolute

Return Value

string

Exceptions

InvalidArgumentException

at line 457
protected string formatAction(string|array $action)

Format the given controller action.

Parameters

string|array $action

Return Value

string

at line 476
array formatParameters(mixed|array $parameters)

Format the array of URL parameters.

Parameters

mixed|array $parameters

Return Value

array

at line 495
protected array extractQueryString(string $path)

Extract the query string from the given path.

Parameters

string $path

Return Value

array

at line 514
string formatRoot(string $scheme, string|null $root = null)

Get the base URL for the request.

Parameters

string $scheme
string|null $root

Return Value

string

at line 537
string format(string $root, string $path, Route|null $route = null)

Format the given URL segments into a single URL.

Parameters

string $root
string $path
Route|null $route

Return Value

string

at line 558
bool isValidUrl(string $path)

Determine if the given path is a valid URL.

Parameters

string $path

Return Value

bool

at line 572
protected RouteUrlGenerator routeUrl()

Get the Route URL generator instance.

Return Value

RouteUrlGenerator

at line 587
void defaults(array $defaults)

Set the default named parameters used by the URL generator.

Parameters

array $defaults

Return Value

void

at line 597
array getDefaultParameters()

Get the default named parameters used by the URL generator.

Return Value

array

at line 608
void forceScheme(string $scheme)

Force the scheme for URLs.

Parameters

string $scheme

Return Value

void

at line 621
void forceRootUrl(string $root)

Set the forced root URL.

Parameters

string $root

Return Value

void

at line 634
$this formatHostUsing(Closure $callback)

Set a callback to be used to format the host of generated URLs.

Parameters

Closure $callback

Return Value

$this

at line 647
$this formatPathUsing(Closure $callback)

Set a callback to be used to format the path of generated URLs.

Parameters

Closure $callback

Return Value

$this

at line 659
Closure pathFormatter()

Get the path formatter being used by the URL generator.

Return Value

Closure

at line 671
Request getRequest()

Get the request instance.

Return Value

Request

at line 682
void setRequest(Request $request)

Set the current request instance.

Parameters

Request $request

Return Value

void

at line 697
$this setRoutes(RouteCollection $routes)

Set the route collection.

Parameters

RouteCollection $routes

Return Value

$this

at line 709
protected Store|null getSession()

Get the session implementation from the resolver.

Return Value

Store|null

at line 722
$this setSessionResolver(callable $sessionResolver)

Set the session resolver for the generator.

Parameters

callable $sessionResolver

Return Value

$this

at line 735
$this setKeyResolver(callable $keyResolver)

Set the encryption key resolver.

Parameters

callable $keyResolver

Return Value

$this

at line 748
$this setRootControllerNamespace(string $rootNamespace)

Set the root controller namespace.

Parameters

string $rootNamespace

Return Value

$this