Blog

ColdBox Free Tip 2: Fluent If Statements using the when() Method

Maria Jose Herrera October 08, 2024

Spread the word

Maria Jose Herrera

October 08, 2024

Spread the word


Share your thoughts

Tip 2 - Fluent If Statements -> when()

Continuing our "102 ColdBox Tips and Tricks" series, let’s explore a powerful feature introduced in ColdBox 6: the when() method. This method simplifies conditional logic by allowing you to chain execution blocks based on boolean values in a clean and fluent way.

More Tips and Tricks

Using the when() Method

The when() method is available in the super type, so all handlers, interceptors, layouts, and views have access to it. This method allows you to create a functional approach to if/then/else statements.

  • Here’s the method signature:
/**
 * Functional construct for if statements
 *
 * @target The boolean evaluator, this can be a boolean value
 * @success The closure/lambda to execute if the boolean value is true
 * @failure The closure/lambda to execute if the boolean value is false
 * @return Returns the SuperType object for chaining
*/
function when( required boolean target, required success, failure )

Example in Action

  • Let’s take a look at an example to see how you can use this method:

var search = getInstance( "SearchCriteria" );
when( rc.filter, () => search.addFilter( rc.filter ) )
  .when(
    currentUser.checkPermission( 'admin' ),
    () => search.showSalaries(),
    () => search.hideSalaries()
  )
  • target: The boolean condition.
  • success: A closure/lambda to execute if the condition is true.
  • failure: A closure/lambda to execute if the condition is false.

This approach helps you manage complex logic with cleaner and more maintainable code. You can chain multiple when() methods for a fluent and functional coding style.

Why Use when() ?

The when() method improves the readability of your code, reducing the need for nested if/else statements and making your logic flow more naturally.

Stay tuned for the next tip in our series! If you’re enjoying these tips, share them and follow us for more insights.

Flow Delegates

The when() is just one method in a collection of what we call flow methods available to you in ColdBox. They come from the Flow delegate class in the core, which means you can easily use them in your models as well as using our delegates pattern. Some of the available methods are:

  • when()
  • unless()
  • throwIf()
  • throwUnless
  • ifNull()
  • ifPresent()

component delegates="Flow@coreDelegates"{
	
	// Now you can use all the methods of the Flow class

}

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

Add Your Comment

Recent Entries

BoxLang 1.0.0 RC1 Launched

BoxLang 1.0.0 RC1 Launched

After nearly a year of relentless iteration, rigorous testing, blood, sweat, lots of praying, tears, and over 1,000 resolved tickets, we proudly announce the first Release Candidate (RC1) of BoxLang! With 27 beta versions behind us, we are now on the final stretch toward the official 1.0 release.

Luis Majano
Luis Majano
February 18, 2025
Exploring BoxLang: A Modern Scripting Language for the JVM!

Exploring BoxLang: A Modern Scripting Language for the JVM!

The amazing CFML community leader Ray Camden recently shared his thoughts on BoxLang, a dynamic scripting language that runs on the Java Virtual Machine (JVM). BoxLang is lightweight (only 6 MB) and doesn’t require Java knowledge, making it accessible to developers from all backgrounds. Whether you're building CLI scriptsweb applications, or experimenting with serverless architecture, BoxLang has you covered.

Maria Jose Herrera
Maria Jose Herrera
February 14, 2025
Get a Free BoxLang+ License with Your ITB 2025 Ticket!

Get a Free BoxLang+ License with Your ITB 2025 Ticket!

At Ortus Solutions, we are dedicated to delivering the best experience for our Into the Box attendees. This year’s event will be an exciting opportunity to explore BoxLang and modern CFML development, and we want to ensure that attending in person is even more rewarding.

Maria Jose Herrera
Maria Jose Herrera
February 07, 2025