Blog

Tip of the Week: Implicit View Dispatch

Brad Wood December 05, 2012

Spread the word

Brad Wood

December 05, 2012

Spread the word


Share your thoughts

 

In the past we've talked about implicit views in ColdBox which mean that if the action in your event handler doesn't call setView() explicitly, ColdBox will use conventions to try and find the view to render.  Well, ColdBox also supports something called Implicit View Dispatch which goes one step further and allows you to dispatch a view to the user without running any event at all.
 
What are the use cases?  Well, perhaps you have a completely static view like a contact us page and creating a method in a handler somewhere would just be pure boilerplate.  We can tell ColdBox to just send the view directly back to the user (using the default layout). 
 
Or perhaps you're slowly integrating ColdBox into a legacy app and you want to still serve up a legacy CFM page while using ColdBox's routing mechanisms.  Again, we can ease into ColdBox without creating handlers for all those legacy pages yet.
 
So, how does it work?  Very simply, and unsurprisingly similar to how implicit views work.  If ColdBox can't located the package/handler or the action specified by your event, it uses a /views/[package/]handler/action.cfm convention to try and locate a view to return.
 
Consider a URL that looks like this:
 
mySite.com/index.cfm?event=contact.about
 
(Or the following equivalent for you people using the SES Interceptor and rewrites)
 
mySite.com/contact/about
 
If the "contact" handler doesn't exist, or does exist but doesn't have an "about" action, then ColdBox will look for the following view to dispatch directly:
 
/views/contact/about.cfm
 
If you have external view locations defined, ColdBox will check them as well before finally giving up and throwing an error.
 
 
P.S. It is also possible to add SES routes that directly dispatch a view without running an event like so:
 
addRoute(pattern='/AboutUs',view='contact/about');
 
That would make the following URL dispatch the same view as above, but with an even prettier URL:
 
mySite.com/AboutUs
 

Add Your Comment

Recent Entries

A Year in Review - BoxLang 2024 Recap!

A Year in Review - BoxLang 2024 Recap!

BoxLang has come a long way since its beta release, and we're thrilled to share the incredible progress made so far. From its initial launch to the upcoming stable version, BoxLang has been evolving with new features, tools, and a growing ecosystem, all aimed at empowering modern developers.In this recap, we’ll highlight the milestones and advancements that have shaped BoxLang’s journey to this point. Let’s take a look at what we’ve achieved and what’s coming next!

Maria Jose Herrera
Maria Jose Herrera
January 03, 2025
Partner with BoxLang and Ortus at Into the Box 2025: Empowering the Future of Modern Software Development!

Partner with BoxLang and Ortus at Into the Box 2025: Empowering the Future of Modern Software Development!

At Ortus Solutions, we’ve always been at the forefront of innovation in the ColdFusion ecosystem. From pioneering modern ColdFusion practices to developing cutting-edge tools and frameworks, we’ve been passionate to help and sup[port the community into shaping the future of web development.That’s why we decided to build BoxLang, our new JVM programming language that not only builds on the strengths of ColdFusion but takes modern software development to the next level.

Maria Jose Herrera
Maria Jose Herrera
December 23, 2024