For the complete documentation index, see llms.txt. This page is also available as Markdown.

ModuleConfig

The ModuleConfig.bx class is the boot code of a ColdBox module and must define a configure() method.

The module configuration object: ModuleConfig.bx (or .cfc for CFML) is the boot code of your module and where you can tell the host application how this module will behave. This is a simple class, no inheritance needed, because it is decorated with methods and variables by ColdBox at runtime.

The only requirement is that this object MUST exist in the root of the module folder and contain a configure() method. This is the way modules are discovered, so if there is no ModuleConfig.bx (or .cfc for CFML) in the root of that folder inside of the modules folder, the framework skips it. So let's investigate what we need or can do in this class.

class{

    function configure(){

    }

}
component{

    function configure(){

    }

}

Last updated

Was this helpful?