Building Routable Links

Search…

In your views, layouts and handlers you can use the buildLink method provided by the request context object (event) to build routable links in your application.
1
buildLink(
2
    // Where to link to
3
    any to, 
4
    // Translate periods to slashes
5
    [boolean translate='true'], 
6
    // Force or un-force SSL, by default we keep the same protocol of the request
7
    [boolean ssl], 
8
    // Update the baseURL, usually used for testing
9
    [any baseURL=''], 
10
    // Append a query string to the URL, as convention name value-pairs
11
    [any queryString='']
12
)
Copied!
Just pass in the routed URL or event and it will create the appropriate routed URL for you:
1
<a href="#event.buildLink( 'home.about' )#">About</a>
2
<a href="#event.buildLink( 'user.edit.id.#user.getID()#' )#">Edit User</a>
Copied!
Inspecting The Current Route
The request context object (event) also has some handy methods to tell you the name or even the current route that was selected for execution:
getCurrentRouteName() - Gives you the name of the current route, if any
getCurrentRoute() - Gives you the currently executed route
getCurrentRoutedURL() - Gives you the complete routed URL pattern that matched the route
getCurrentRoutedNamespace() - Gives you the current routed namespace, if any
​

Routing Namespaces

RESTFul Extension Detection

Last modified 3yr ago

Copy link

Edit on GitHub

Contents

Inspecting The Current Route