class UrlGenerator implements UrlGenerator (View source)

Methods

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 a 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
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

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

Create a new URL Generator instance.

Parameters

RouteCollection $routes
Request $request

Return Value

void

at line line 107
string full()

Get the full URL for the current request.

Return Value

string

at line line 117
string current()

Get the current URL for the request.

Return Value

string

at line line 127
string previous()

Get the URL for the previous request.

Return Value

string

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

Generate a absolute URL to the given path.

Parameters

string $path
mixed $extra
bool $secure

Return Value

string

at line line 174
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 186
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 217
string secureAsset(string $path)

Generate a URL to a secure asset.

Parameters

string $path

Return Value

string

at line line 249
void forceSchema(string $schema)

Force the schema for URLs.

Parameters

string $schema

Return Value

void

at line line 266
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 545
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 594
void forceRootUrl(string $root)

Set the forced root URL.

Parameters

string $root

Return Value

void

at line line 606
bool isValidUrl(string $path)

Determine if the given path is a valid URL.

Parameters

string $path

Return Value

bool

at line line 631
Request getRequest()

Get the request instance.

Return Value

Request

at line line 642
void setRequest(Request $request)

Set the current request instance.

Parameters

Request $request

Return Value

void

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

Set the route collection.

Parameters

RouteCollection $routes

Return Value

$this

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

Set the session resolver for the generator.

Parameters

callable $sessionResolver

Return Value

$this

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

Set the root controller namespace.

Parameters

string $rootNamespace

Return Value

$this