IOC

coldbox.system.plugins

Class IOC

WEB-INF.cftags.component
        coldbox.system.FrameworkSupertype
            coldbox.system.Plugin
                coldbox.system.plugins.IOC

Class Attributes:

singleton

output : false

An Inversion Of Control plugin that interfaces with major ColdFusion IoC/DI frameworks

Constructor Summary
init(any controller) Constructor.

Method Summary
`private any`	buildAdapter(any framework, any definitionFile) Build an IoC framework adapter and returns it.
`void`	configure() Configure or Re-Configure the IoC Plugin.
`any<boolean>`	containsBean(any beanName) Check if the bean factory contains a bean.
`any`	getAdapter() Get the IoC Factory Adapter in use by this plugin.
`any`	getBean(any beanName) Get a Bean from the loaded object factory.
`any`	getIOCDefinitionFile() Get the definition file configured for this plugin.
`any`	getIOCFramework() Get the IoC framework name defined for this plugin.
`any`	getIoCFactory() Returns the IoC Factory in use.
`private void`	processObjectCaching(any target, any cacheKey) Process IoC object Caching.
`void`	reloadDefinitionFile() Reloads the IoC factory.
`private any`	validateDefinitionFile(any definitionFile) Validate the IoC Definition File.

Methods inherited from class `coldbox.system.Plugin`
getPluginDescription, getPluginName, getPluginVersion, getRequestCollection, getRequestContext, getpluginAuthor, getpluginAuthorURL, getpluginPath, setPluginDescription, setPluginName, setPluginVersion, setpluginAuthor, setpluginAuthorURL

Methods inherited from class `coldbox.system.FrameworkSupertype`
$abort, $dump, $htmlhead, $include, $rethrow, $throw, addAsset, announceInterception, getColdboxOCM, getController, getDatasource, getDebugMode, getInterceptor, getMailService, getMailSettings, getMemento, getModel, getModuleSettings, getMyPlugin, getNewMail, getPlugin, getResource, getSetting, getSettingStructure, getSettingsBean, getValidationManager, getfwLocale, includeUDF, loadGlobalUDFLibraries, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderLayout, renderView, runEvent, setDebugMode, setNextEvent, setNextRoute, setSetting, setfwLocale, settingExists, validateModel

Methods inherited from class coldbox.system.FrameworkSupertype

$abort, $dump, $htmlhead, $include, $rethrow, $throw, addAsset, announceInterception, getColdboxOCM, getController, getDatasource, getDebugMode, getInterceptor, getMailService, getMailSettings, getMemento, getModel, getModuleSettings, getMyPlugin, getNewMail, getPlugin, getResource, getSetting, getSettingStructure, getSettingsBean, getValidationManager, getfwLocale, includeUDF, loadGlobalUDFLibraries, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderLayout, renderView, runEvent, setDebugMode, setNextEvent, setNextRoute, setSetting, setfwLocale, settingExists, validateModel

Methods inherited from class `WEB-INF.cftags.component`
None

Constructor Detail

init

public init(any controller)

Constructor

Parameters:: controller - coldbox.system.web.Controller

Method Detail

buildAdapter

private any buildAdapter(any framework, any definitionFile)

Build an IoC framework adapter and returns it

Parameters:: framework - The framework adapter to build; definitionFile - The framework definition file to load

configure

public void configure()

Configure or Re-Configure the IoC Plugin. Loads the chosen IoC Factory and configures it for usage

containsBean

public any<boolean> containsBean(any beanName)

Check if the bean factory contains a bean

Parameters:: beanName - The bean name to retrieve from the object factory

getAdapter

public any getAdapter()

Get the IoC Factory Adapter in use by this plugin

getBean

public any getBean(any beanName)

Get a Bean from the loaded object factory

Parameters:: beanName - The bean name to retrieve from the object factory

getIOCDefinitionFile

public any getIOCDefinitionFile()

Get the definition file configured for this plugin

getIOCFramework

public any getIOCFramework()

Get the IoC framework name defined for this plugin

getIoCFactory

public any getIoCFactory()

Returns the IoC Factory in use

processObjectCaching

private void processObjectCaching(any target, any cacheKey)

Process IoC object Caching

Parameters:: target - The bean target to inspect; cacheKey - CacheKey to use if necessary

reloadDefinitionFile

public void reloadDefinitionFile()

Reloads the IoC factory. Basically calls configure again. DEPRECATED

validateDefinitionFile

private any validateDefinitionFile(any definitionFile)

Validate the IoC Definition File. Called internally to verify the file location and get the correct path to it.

Parameters:: definitionFile - The definition file to verify for loading