Over a million developers have joined DZone.
{{announcement.body}}
{{announcement.title}}

ColdBox Event Chaining

DZone's Guide to

ColdBox Event Chaining

· Java Zone ·
Free Resource

The CMS developers love. Open Source, API-first and Enterprise-grade. Try BloomReach CMS for free.

This is probably common knowledge to seasoned ColdBox developers, but I wasn't sure how event chaining worked with runEvent, so I did a simple test.

First off you may wonder why I'd want to run multiple events from one http call, well, I have several things that need to happen overnight, such as updating exchange rates, checking product stock, deleting empty baskets etc. Each of these actions is in a seperate event (so they can be called individually). Being lazy, I didn't want to set up three seperate scheduled tasks.

Here's my test handler:

/**
* I am a ColdBox handler
*/
component
{
  function chaining(event)
  {
    var rc = arguments.event.getCollection();
    runEvent( "legacy.foo" );
    runEvent( "legacy.bar" );
    runEvent( "legacy.foobar" );
  }
  
  function foo(event)
  {
    var prc = arguments.event.getCollection( private=true );
    prc.foo = true;
  }
  
  function bar(event)
  {
    var prc = arguments.event.getCollection( private=true );
    prc.bar = true;
  }
  
  function foobar(event)
  {
    var prc = arguments.event.getCollection( private=true );
    prc.foobar = "pre";
    runEvent( "legacy.nested" );
    prc.foobar = "post";
  }
  
  function nested(event)
  {
    var prc = arguments.event.getCollection( private=true );
    prc.nested = prc.foobar;
  }
}

Nothing out of the ordinary going on here. As you can see I've got a chaining event which executes the other events. I've also added a runevent call inside the foobar method to see what happens. Finally I set up a chaining.cfm view file which simply dumps out the prc struct.

When I run http://localhost/myapp/index.cfm/test/chaining I get the following output.

BAR   true
FOO   true
FOOBAR   post
NESTED   pre 

So ColdBox uses the original events name to find the view template and the application flow returns to the calling method once the runEvent has executed.

BloomReach CMS: the API-first CMS of the future. Open-source & enterprise-grade. - As a Java developer, you will feel at home using Maven builds and your favorite IDE (e.g. Eclipse or IntelliJ) and continuous integration server (e.g. Jenkins). Manage your Java objects using Spring Framework, write your templates in JSP or Freemarker. Try for free.

Topics:

Published at DZone with permission of

Opinions expressed by DZone contributors are their own.

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}