字典我要纠错

UrlGenerator (Routing)

UrlGenerator

class UrlGenerator implements UrlGenerator (View source)

Traits

Macroable

Methods

static void

macro(string $name, callable $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(mixed $fallback = false)

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 the URL to an application 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

secureAsset(string $path)

Generate the 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

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

Parameters

string	$name
callable	$macro

Return Value

void

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(RouteCollection $routes, Request $request)

Create a new URL Generator instance.

Parameters

RouteCollection	$routes
Request	$request

Return Value

void

string full()

Get the full URL for the current request.

Return Value

string

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 = array(), bool $secure = null)

Generate an absolute URL to the given path.

Parameters

string	$path
mixed	$extra
bool	$secure

Return Value

string

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

Generate a secure, absolute URL to the given path.

Parameters

string	$path
array	$parameters

Return Value

string

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

Generate the URL to an application asset.

Parameters

string	$path
bool	$secure

Return Value

string

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

string secureAsset(string $path)

Generate the URL to a secure asset.

Parameters

string

$path

Return Value

string

void forceSchema(string $schema)

Force the schema for URLs.

Parameters

string

$schema

Return Value

void

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

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

void forceRootUrl(string $root)

Set the forced root URL.

Parameters

string

$root

Return Value

void

bool isValidUrl(string $path)

Determine if the given path is a valid URL.

Parameters

string

$path

Return Value

bool

Request getRequest()

Get the request instance.

Return Value

Request

void setRequest(Request $request)

Set the current request instance.

Parameters

Request

$request

Return Value

void

$this setRoutes(RouteCollection $routes)

Set the route collection.

Parameters

RouteCollection

$routes

Return Value

$this

$this setSessionResolver(callable $sessionResolver)

Set the session resolver for the generator.

Parameters

callable

$sessionResolver

Return Value

$this

$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/5.3/Illuminate/Routing/UrlGenerator.html