102 ColdBox Tips and Tricks by Luis Majano

Keep your ColdBox Apps Clean and Easy to Manage

Did you know ColdBox provides flexible ways to build routes using structs? In this tip, we’ll cover how to use the event.buildLink() and event.route() methods for named routes, a feature that’s especially handy when working with dynamic URLs.

Building Named Routes with a Struct

ColdBox makes routing easier by letting you use named routes (https://coldbox.ortusbooks.com/the-basics/routing/routing-dsl/named-routes) when creating links. This can be done using the event.buildLink() method, or the most explicit method: event.route().

How to Build Named Routes:

You can pass a struct into the to argument of the buildLink() method, allowing you to bind route names and parameters seamlessly. Here’s how it works:

event.buildLink( { name : "contactUs", params : { id : 3 } } )

In this example:

• name: This specifies the named route you want to link to.
• params: A struct of parameters bound to the URL, making it dynamic based on your data and defined in the route.

The resulting link will look something like this: /contactUs/3.

Why Use Named Routes?

• Better readability: Named routes are clearer and more descriptive than hard-coded URLs.
• Maintainability: If your route changes in the future, you only need to update the route definition, not every instance where it’s used.
• Flexibility: Parameters are easily passed in via the params struct, making it simple to create dynamic links without manually building query strings.

Named routes are a great way to keep your ColdBox apps clean and easy to manage. Try them out in your next project! Stay tuned for more tips and tricks on how to level up your ColdBox development.

Learn More ColdBox Tips and Tricks

Stay tuned for more ColdBox tips in our ongoing series. if you want to learn more than 10 free tips and tricks make sure to get your “ColdBox 102 tips and tricks book” We have a variety of formats you can choose from.

Get your Copy