UrlGenerator (Routing)
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(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 | 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 | formatScheme(bool|null $secure) Get the default scheme for a raw URL. | |
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. | |
array | formatParameters(mixed|array $parameters) Format the array of URL parameters. | |
string | formatRoot(string $scheme, string $root = null) Get the base URL for the request. | |
string | format(string $root, string $path) Format the given URL segments into a single URL. | |
bool | isValidUrl(string $path) Determine if the given path is a valid URL. | |
void | defaults(array $defaults) Set the default named parameters used by the URL generator. | |
void | forceScheme(string $schema) 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. | |
$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)
Register a custom macro.
static bool hasMacro(string $name)
Checks if macro is registered.
static mixed __callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
mixed __call(string $method, array $parameters)
Dynamically handle calls to the class.
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 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 formatScheme(bool|null $secure)
Get the default scheme for a raw URL.
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.
array formatParameters(mixed|array $parameters)
Format the array of URL parameters.
string formatRoot(string $scheme, string $root = null)
Get the base URL for the request.
string format(string $root, string $path)
Format the given URL segments into a single URL.
bool isValidUrl(string $path)
Determine if the given path is a valid URL.
void defaults(array $defaults)
Set the default named parameters used by the URL generator.
void forceScheme(string $schema)
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.
$this setSessionResolver(callable $sessionResolver)
Set the session resolver for the generator.
$this setRootControllerNamespace(string $rootNamespace)
Set the root controller namespace.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.4/Illuminate/Routing/UrlGenerator.html