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() 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
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()
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.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.1/Illuminate/Routing/UrlGenerator.html