|
ColdBox Platform v3.8.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.web.services.BaseService
coldbox.system.web.services.PluginService
public class PluginService
The coldbox plugin service
Constructor Summary | |
---|---|
init(any controller)
Constructor |
Method Summary | |
---|---|
void |
afterInstanceAutowire([any event], [any interceptData])
Called by wirebox once instances are autowired |
void |
configure()
|
any |
get(any plugin, any custom, [any module=''], [any init='true'])
Get a new/cached plugin instance |
any |
getCustomPluginsExternalPath()
Get the base invocation path where external custom convention plugins exist |
any |
getCustomPluginsPath()
Get the base invocation path where custom convention plugins exist |
string |
getCustomPluginsPhysicalPath()
Get the physical path where custom convention plugins exist |
any |
getExtensionsPath()
Get the base invocation path where extension plugins exist |
any |
getExtensionsPhysicalPath()
Get the physical path where extension plugins exist |
private any |
locatePluginPath(any plugin, any custom, [any module=''])
Locate a full plugin instantiation path from the requested plugin name |
any |
new(any plugin, any<Boolean> custom, [any module=''], [any<Boolean> init='true'])
Create a New Plugin Instance whether it is core or custom |
void |
setCustomPluginsExternalPath(any customPluginsExternalPath)
Set customPluginsExternalPath |
void |
setCustomPluginsPath(any customPluginsPath)
Set CorePluginsPath |
void |
setCustomPluginsPhysicalPath(any customPluginsPhysicalPath)
Set customPluginsPhysicalPath |
void |
setExtensionsPath(any extensionsPath)
Set ExtensionsPath |
void |
setExtensionsPhysicalPath(any extensionsPhysicalPath)
Set ExtensionsPhysicalPath |
private any |
wireboxSetup()
Verifies the setup for plugin classes is online |
Methods inherited from class coldbox.system.web.services.BaseService |
---|
convertToColdBox, getColdboxOCM, getController, getUtil, isFamilyType, onConfigurationLoad, onShutdown, setController
|
Methods inherited from class WEB-INF.cftags.component |
---|
None
|
Constructor Detail |
---|
public init(any controller)
controller
Method Detail |
---|
public void afterInstanceAutowire([any event], [any interceptData])
event
interceptData
public void configure()
public any get(any plugin, any custom, [any module=''], [any init='true'])
plugin
- The name (classpath) of the plugin to create. We will search for it.custom
- Custom plugin or coldbox plugin Booleanmodule
- The module to retrieve the plugin frominit
- Auto init() the plugin upon construction. Booleanpublic any getCustomPluginsExternalPath()
public any getCustomPluginsPath()
public string getCustomPluginsPhysicalPath()
public any getExtensionsPath()
public any getExtensionsPhysicalPath()
private any locatePluginPath(any plugin, any custom, [any module=''])
plugin
- The plugin to validate the path on.custom
- Whether its a custom plugin or not. Booleanmodule
- The module to retrieve the plugin frompublic any new(any plugin, any<Boolean> custom, [any module=''], [any<Boolean> init='true'])
plugin
- The name (classpath) of the plugin to createcustom
- Custom plugin or coldbox plugin: Booleanmodule
- The module to retrieve the plugin frominit
- Auto init() the plugin upon construction: Booleanpublic void setCustomPluginsExternalPath(any customPluginsExternalPath)
customPluginsExternalPath
public void setCustomPluginsPath(any customPluginsPath)
customPluginsPath
public void setCustomPluginsPhysicalPath(any customPluginsPhysicalPath)
customPluginsPhysicalPath
public void setExtensionsPath(any extensionsPath)
extensionsPath
public void setExtensionsPhysicalPath(any extensionsPhysicalPath)
extensionsPhysicalPath
private any wireboxSetup()
|
ColdBox Platform v3.8.0 | ||||
FRAMES |