ColdBox Platform Version 2.6.3

coldbox.system.services
Class PluginService

WEB-INF.cftags.component
        extended by coldbox.system.services.BaseService
            extended by coldbox.system.services.PluginService

public class PluginService
extends BaseService

The coldbox plugin service


Constructor Summary
init(any controller)
          Constructor
 
Method Summary
 void clearDictionary()
          Clear the cache dictionary
 any get(string plugin, boolean custom)
          Get a new/cached plugin instance
 string getColdBoxPluginsPath()
          Get ColdBoxPluginsPath
 struct getNewMDEntry()
          Get a new metadata entry structure
 struct getcacheDictionary()
          Get the plugin cache dictionary
private string locatePluginPath(string plugin, boolean custom)
          Locate a full plugin instantiation path from the requested plugin name
 any new(string plugin, boolean custom)
          Create a New Plugin Instance wether its core or custom
private void setColdBoxPluginsPath(string ColdBoxPluginsPath)
          Set ColdBoxPluginsPath
private void setcacheDictionary(BaseDictionary cacheDictionary)
          Set the plugin cache dictionary. NOT EXPOSED to avoid screwups
 
Methods inherited from class coldbox.system.services.BaseService
debug, getColdboxOCM, getUtil, getcontroller, setcontroller
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init(any controller)

Method Detail

clearDictionary

public void clearDictionary()
Clear the cache dictionary


get

public any get(string plugin, boolean custom)
Get a new/cached plugin instance

Parameters:
plugin - The named plugin to create
custom - Custom plugin or coldbox plugin

getColdBoxPluginsPath

public string getColdBoxPluginsPath()
Get ColdBoxPluginsPath


getNewMDEntry

public struct getNewMDEntry()
Get a new metadata entry structure


getcacheDictionary

public struct getcacheDictionary()
Get the plugin cache dictionary


locatePluginPath

private string locatePluginPath(string plugin, boolean custom)
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.

new

public any new(string plugin, boolean custom)
Create a New Plugin Instance wether its core or custom

Parameters:
plugin - The named plugin to create
custom - Custom plugin or coldbox plugin

setColdBoxPluginsPath

private void setColdBoxPluginsPath(string ColdBoxPluginsPath)
Set ColdBoxPluginsPath

Parameters:
ColdBoxPluginsPath

setcacheDictionary

private void setcacheDictionary(BaseDictionary cacheDictionary)
Set the plugin cache dictionary. NOT EXPOSED to avoid screwups

Parameters:
cacheDictionary

ColdBox Platform Version 2.6.3