Injection DSL
Everything inside CommandBox is built via Wirebox. This means your models, commands, and interceptors can all take advantage of Wirebox's dependency injection. All you need to do is add a property to the top of your CFC that tells WireBox what to inject.
Core Models
There are a number of automatically-mapped objects inside WireBox. Here are some examples:
1
property name='shell' inject='commandbox';
2
property name='tempDir' inject='[email protected]';
3
property name='formatterUtil' inject='formatter';
4
property name='ModuleService' inject='ModuleService';
5
property name='ConfigService' inject='ConfigService';
Copied!
Custom Models
Any CFCs in the
models folder of any module will automatically be mapped in WireBox with the pattern [email protected]. Therefore, if you create a module called "SuperDuper" that has a CFC called models/AmazingService.cfc, you could inject it in your module's custom command like so:1
property name='AmazingService' inject='[email protected]';
Copied!
Module Config and Settings
If a module's service or command wants to access configuration data or module settings, they can be injected using these injection DSLs.
1
property name='allModuleConfigs' inject='commandbox:moduleConfig';
2
property name='moduleConfig' inject='commandbox:moduleConfig:moduleName';
3
property name='moduleSettings' inject='commandbox:moduleSettings:moduleName';
4
property name='mySetting' inject='commandbox:moduleSettings:moduleName:mySetting';
5
property name='myDeepSetting' inject='commandbox:moduleSettings:moduleName:mySetting';
Copied!
CommandBox Config
You can also inject Commandbox config settings into your CFCs. Only inject a specific config setting if you expect it to exist. If you need to check for its existence (and provide a default), then inject the entire settings struct. You can also inject nested keys of a complex config setting directly like the last line shows.
1
property name='allConfigSettings' inject='commandbox:ConfigSettings';
2
property name='myConfigSetting' inject='commandbox:ConfigSettings:myConfigSetting';
3
property name='myDeepConfigSetting' inject='commandbox:ConfigSettings:myConfigSetting.nested.keys.here';
Copied!
box Injection Namespace
In order to provide compatibility for generic modules to work the same between Coldbox MVC and CommandBox CLI, we have introduced a new injection namespace called
box which is simply an alias for commandbox. All of the examples above such as1
property name='moduleSettings' inject='commandbox:moduleSettings:moduleName';
Copied!
can also be written as
1
property name='moduleSettings' inject='box:moduleSettings:moduleName';
Copied!
and will allow your module to work the same when installed to ColdBox MVC or CommandBox CLI. note the
box injection namespace was added to CommandBox in version 4.7.0 and added to ColdBox MVC in version 5.4.0 so using it will preclude the use of your module on older versions of either platform.Reloading Changes
CFProperty injections are aggressively caches on disk to survive restarts. If you change the injections on a command CFC, you will need to run the
reload command (aliased as r) to reprocess metadata on your CFCs.Last modified 1mo ago
Copy link
Edit on GitHub