Configuring WireBox

When using WireBox inside of ColdBox, the binder class is located by convention in /config/WireBox.bx (or /config/WireBox.cfc for CFML applications). When using WireBox outside of ColdBox, you can create a binder anywhere with any name using one of these two approaches:

1. Extend the WireBox Binder — create a configuration class that extends coldbox.system.ioc.config.Binder and implements a configure() method:

BoxLang

// config/WireBox.bx
class extends="coldbox.system.ioc.config.Binder" {

    function configure(){

    }

    function onLoad(){

    }

    function onShutdown(){

    }

}

CFML

// config/WireBox.cfc
component extends="coldbox.system.ioc.config.Binder" {

    function configure(){

    }

    function onLoad(){

    }

    function onShutdown(){

    }
}

2. Simple configuration class — create a class with a configure( binder ) method that accepts a WireBox binder object:

BoxLang

// config/WireBox.bx
class {

    function configure( required binder ){

    }

    function onLoad(){

    }

    function onShutdown(){

    }

}

CFML

// config/WireBox.cfc
component {

    function configure( required binder ){

    }

    function onLoad(){

    }

    function onShutdown(){

    }

}

The latter approach will be less verbose when talking to the mapping DSL the Binder object exposes. However, both are fully functional and matter of preference.

From the configure() method you will be able to interact with the Binder methods or creating implicit DSL structures in order to configure WireBox for operation and also to create object mappings. From the onLoad() method you can also use it for mappings with main distinction that the WireBox machinery is now online (logging, events, caching, etc). This is necessary for leveraging mapDirectory() calls.

Please also note that the Binder itself has a reference to the current Injector it belongs to (getInjector()).

When you instantiate the WireBox injector, pass either the class path to your binder or an instance of it:

BoxLang

// Path-based
new coldbox.system.ioc.Injector( "path.to.my.Binder" )

// Instance-based
var oBinder = new path.to.my.Binder()
new coldbox.system.ioc.Injector( oBinder )

CFML

new wirebox.system.ioc.Injector( "path.to.my.Binder" );
// or
var oBinder = createObject( "path.to.my.Binder" );
new wirebox.system.ioc.Injector( oBinder );