1. class
  2. Illuminate
  3. Routing
  4. UrlGenerator

UrlGenerator

class UrlGenerator implements UrlGenerator (View source)

Traits

Macroable

Methods

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

Register a custom macro.

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)

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

Get the URL for the previous request.

string
to( string $path, mixed $extra = array(), bool $secure = null)

Generate an absolute URL to the given path.

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

Generate a secure, absolute URL to the given path.

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

Generate a URL to an application asset.

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

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

string
secureAsset( string $path)

Generate a URL to a secure asset.

void
forceSchema( string $schema)

Force the schema for URLs.

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

Get the URL to a named route.

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

Get the URL to a controller action.

void
forceRootUrl( string $root)

Set the forced root URL.

bool
isValidUrl( string $path)

Determine if the given path is a valid URL.

Request
getRequest()

Get the request instance.

void
setRequest( Request $request)

Set the current request instance.

$this
setRoutes( RouteCollection $routes)

Set the route collection.

$this
setSessionResolver( callable $sessionResolver)

Set the session resolver for the generator.

$this
setRootControllerNamespace( string $rootNamespace)

Set the root controller namespace.

Details

in Macroable at line line 24
static void macro( string $name, callable $macro)

Register a custom macro.

Parameters

string $name
callable $macro

Return Value

void

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

Checks if macro is registered.

Parameters

string $name

Return Value

bool

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

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line line 103
void __construct( RouteCollection $routes, Request $request)

Create a new URL Generator instance.

Parameters

RouteCollection $routes
Request $request

Return Value

void

at line line 115
string full()

Get the full URL for the current request.

Return Value

string

at line line 125
string current()

Get the current URL for the request.

Return Value

string

at line line 135
string previous()

Get the URL for the previous request.

Return Value

string

at line line 152
string to( string $path, mixed $extra = array(), bool $secure = null)

Generate an absolute URL to the given path.

Parameters

string $path
mixed $extra
bool $secure

Return Value

string

at line line 191
string secure( string $path, array $parameters = array())

Generate a secure, absolute URL to the given path.

Parameters

string $path
array $parameters

Return Value

string

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

Generate a URL to an application asset.

Parameters

string $path
bool $secure

Return Value

string

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

Generate a 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 line 254
string secureAsset( string $path)

Generate a URL to a secure asset.

Parameters

string $path

Return Value

string

at line line 284
void forceSchema( string $schema)

Force the schema for URLs.

Parameters

string $schema

Return Value

void

at line line 301
string route( string $name, mixed $parameters = array(), bool $absolute = true)

Get the URL to a named route.

Parameters

string $name
mixed $parameters
bool $absolute

Return Value

string

Exceptions

InvalidArgumentException

at line line 591
string action( string $action, mixed $parameters = array(), bool $absolute = true)

Get the URL to a controller action.

Parameters

string $action
mixed $parameters
bool $absolute

Return Value

string

Exceptions

InvalidArgumentException

at line line 634
void forceRootUrl( string $root)

Set the forced root URL.

Parameters

string $root

Return Value

void

at line line 646
bool isValidUrl( string $path)

Determine if the given path is a valid URL.

Parameters

string $path

Return Value

bool

at line line 673
Request getRequest()

Get the request instance.

Return Value

Request

at line line 684
void setRequest( Request $request)

Set the current request instance.

Parameters

Request $request

Return Value

void

at line line 698
$this setRoutes( RouteCollection $routes)

Set the route collection.

Parameters

RouteCollection $routes

Return Value

$this

at line line 735
$this setSessionResolver( callable $sessionResolver)

Set the session resolver for the generator.

Parameters

callable $sessionResolver

Return Value

$this

at line line 748
$this setRootControllerNamespace( string $rootNamespace)

Set the root controller namespace.

Parameters

string $rootNamespace

Return Value

$this