coldbox.system.web.services

Class PluginService

WEB-INF.cftags.component
        extended by coldbox.system.web.services.BaseService
            extended by coldbox.system.web.services.PluginService
Class Attributes:
  • output : false
    •  

    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

    init

    public init(any controller)

    Constructor

    Parameters:
    controller
    Method Detail

    afterInstanceAutowire

    public void afterInstanceAutowire([any event], [any interceptData])

    Called by wirebox once instances are autowired

    Parameters:
    event
    interceptData

    configure

    public void configure()

    get

    public any get(any plugin, any custom, [any module=''], [any init='true'])

    Get a new/cached plugin instance

    Parameters:
    plugin - The name (classpath) of the plugin to create. We will search for it.
    custom - Custom plugin or coldbox plugin Boolean
    module - The module to retrieve the plugin from
    init - Auto init() the plugin upon construction. Boolean

    getCustomPluginsExternalPath

    public any getCustomPluginsExternalPath()

    Get the base invocation path where external custom convention plugins exist.

    getCustomPluginsPath

    public any getCustomPluginsPath()

    Get the base invocation path where custom convention plugins exist.

    getCustomPluginsPhysicalPath

    public string getCustomPluginsPhysicalPath()

    Get the physical path where custom convention plugins exist.

    getExtensionsPath

    public any getExtensionsPath()

    Get the base invocation path where extension plugins exist.

    getExtensionsPhysicalPath

    public any getExtensionsPhysicalPath()

    Get the physical path where extension plugins exist.

    locatePluginPath

    private any locatePluginPath(any plugin, any custom, [any module=''])

    Locate a full plugin instantiation path from the requested plugin name

    Parameters:
    plugin - The plugin to validate the path on.
    custom - Whether its a custom plugin or not. Boolean
    module - The module to retrieve the plugin from

    new

    public any new(any plugin, any<Boolean> custom, [any module=''], [any<Boolean> init='true'])

    Create a New Plugin Instance whether it is core or custom

    Parameters:
    plugin - The name (classpath) of the plugin to create
    custom - Custom plugin or coldbox plugin: Boolean
    module - The module to retrieve the plugin from
    init - Auto init() the plugin upon construction: Boolean

    setCustomPluginsExternalPath

    public void setCustomPluginsExternalPath(any customPluginsExternalPath)

    Set customPluginsExternalPath

    Parameters:
    customPluginsExternalPath

    setCustomPluginsPath

    public void setCustomPluginsPath(any customPluginsPath)

    Set CorePluginsPath

    Parameters:
    customPluginsPath

    setCustomPluginsPhysicalPath

    public void setCustomPluginsPhysicalPath(any customPluginsPhysicalPath)

    Set customPluginsPhysicalPath

    Parameters:
    customPluginsPhysicalPath

    setExtensionsPath

    public void setExtensionsPath(any extensionsPath)

    Set ExtensionsPath

    Parameters:
    extensionsPath

    setExtensionsPhysicalPath

    public void setExtensionsPhysicalPath(any extensionsPhysicalPath)

    Set ExtensionsPhysicalPath

    Parameters:
    extensionsPhysicalPath

    wireboxSetup

    private any wireboxSetup()

    Verifies the setup for plugin classes is online