Callable

Class

ColdBox Platform Version 2.6.4

FRAMES

coldbox.system.services
Class PluginService

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

public class PluginService
extends BaseService
extends BaseService

The coldbox plugin service

Constructor Summary
`init(any controller)` Constructor

Method Summary
`void`	`clearDictionary()` Clear the cache dictionary
`any`	`get(any plugin, boolean custom, [any module=''], [boolean init='true'])` Get a new/cached plugin instance
`struct`	`getCacheDictionary()` Get the plugin cache dictionary
`string`	`getCorePluginsPath()` Get the base invocation path where core plugins exist
`string`	`getCustomPluginsExternalPath()` Get the base invocation path where external custom convention plugins exist
`string`	`getCustomPluginsPath()` Get the base invocation path where custom convention plugins exist
`string`	`getCustomPluginsPhysicalPath()` Get the physical path where custom convention plugins exist
`string`	`getExtensionsPath()` Get the base invocation path where extension plugins exist
`string`	`getExtensionsPhysicalPath()` Get the physical path where extension plugins exist
`private struct`	`getNewMDEntry()` Get a new metadata entry structure for plugins
`private string`	`getPluginCacheKey(any plugin, boolean custom, [any module=''])` Get the plugin Cache Key
`private string`	`locatePluginPath(any plugin, boolean custom, [any module=''])` Locate a full plugin instantiation path from the requested plugin name
`any`	`new(any plugin, boolean custom, [any module=''], [boolean init='true'])` Create a New Plugin Instance whether it is core or custom
`void`	`onConfigurationLoad()`
`private void`	`setCacheDictionary(BaseDictionary cacheDictionary)` Set the plugin cache dictionary
`private void`	`setCorePluginsPath(string corePluginsPath)` Set CorePluginsPath
`private void`	`setCustomPluginsExternalPath(string customPluginsExternalPath)` Set customPluginsExternalPath
`private void`	`setCustomPluginsPath(string customPluginsPath)` Set CorePluginsPath
`private void`	`setCustomPluginsPhysicalPath(string customPluginsPhysicalPath)` Set customPluginsPhysicalPath
`private void`	`setExtensionsPath(string extensionsPath)` Set ExtensionsPath
`private void`	`setExtensionsPhysicalPath(string extensionsPhysicalPath)` Set ExtensionsPhysicalPath
`private struct`	`storeMetadata(string pluginKey, any pluginMD)` Store a plugin's metadata introspection

Methods inherited from class coldbox.system.services.BaseService
`convertToColdBox, debug, getColdboxOCM, getLogger, getUtil, getcontroller, isFamilyType, onAspectsLoad, onShutdown, setcontroller`

Methods inherited from class WEB-INF.cftags.component

Constructor Detail

init

public init(any controller)

Constructor

Parameters:: controller

Method Detail

clearDictionary

public void clearDictionary()

Clear the cache dictionary

get

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

Get a new/cached plugin instance

getCacheDictionary

public struct getCacheDictionary()

Get the plugin cache dictionary

getCorePluginsPath

public string getCorePluginsPath()

Get the base invocation path where core plugins exist.

getCustomPluginsExternalPath

public string getCustomPluginsExternalPath()

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

getCustomPluginsPath

public string 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 string getExtensionsPath()

Get the base invocation path where extension plugins exist.

getExtensionsPhysicalPath

public string getExtensionsPhysicalPath()

Get the physical path where extension plugins exist.

getNewMDEntry

private struct getNewMDEntry()

Get a new metadata entry structure for plugins

getPluginCacheKey

private string getPluginCacheKey(any plugin, boolean custom, [any module=''])

Get the plugin Cache Key

locatePluginPath

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

Locate a full plugin instantiation path from the requested plugin name

new

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

Create a New Plugin Instance whether it is core or custom

onConfigurationLoad

public void onConfigurationLoad()

Overrides:: onConfigurationLoad in class BaseService

setCacheDictionary

private void setCacheDictionary(BaseDictionary cacheDictionary)

Set the plugin cache dictionary. NOT EXPOSED to avoid screwups

setCorePluginsPath

private void setCorePluginsPath(string corePluginsPath)

Set CorePluginsPath

setCustomPluginsExternalPath

private void setCustomPluginsExternalPath(string customPluginsExternalPath)

Set customPluginsExternalPath

setCustomPluginsPath

private void setCustomPluginsPath(string customPluginsPath)

Set CorePluginsPath

setCustomPluginsPhysicalPath

private void setCustomPluginsPhysicalPath(string customPluginsPhysicalPath)

Set customPluginsPhysicalPath

setExtensionsPath

private void setExtensionsPath(string extensionsPath)

Set ExtensionsPath

setExtensionsPhysicalPath

private void setExtensionsPhysicalPath(string extensionsPhysicalPath)

Set ExtensionsPhysicalPath

storeMetadata

private struct storeMetadata(string pluginKey, any pluginMD)

Store a plugin's metadata introspection

Overview

Package