UrlGenerator

interface UrlGenerator (View source)

Methods

string current()

Get the current URL for the request.
string previous(mixed $fallback = false)

Get the URL for the previous request.
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 route(string $name, mixed $parameters = [], bool $absolute = true)

Get the URL to a named route.
string action(string|array $action, mixed $parameters = [], bool $absolute = true)

Get the URL to a controller action.
$this setRootControllerNamespace(string $rootNamespace)

Set the root controller namespace.

Details

string current()

Get the current URL for the request.

Return Value

string

string previous(mixed $fallback = false)

Get the URL for the previous request.

Parameters

mixed $fallback

Return Value

string

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

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

Generate a secure, absolute URL to the given path.

Parameters

string $path
array $parameters

Return Value

string

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

Generate the URL to an application asset.

Parameters

string $path
bool|null $secure

Return Value

string

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

InvalidArgumentException

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

$this setRootControllerNamespace(string $rootNamespace)

Set the root controller namespace.

Parameters

string $rootNamespace

Return Value

$this

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