Callable

box.system.concurrent.Callable interface"> Callable

Class

ColdBox Platform Version 2.6.4

FRAMES

coldbox.system
Class Plugin

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

Direct Known Subclasses:: AntiSamy , ApplicationStorage , BeanFactory , CFCViewer , ClientStorage , ClusterStorage , CookieStorage , FeedGenerator , FeedReader , IOC , JavaLoader , Logger , MailService , MessageBox , MethodInjector , QueryHelper , Renderer , ResourceBundle , SessionStorage , StringBuffer , Timer , Validator , Webservices , Zip , i18n

public class Plugin
extends FrameworkSupertype
extends FrameworkSupertype

This is the plugin base cfc.

Constructor Summary

init(any controller)
          The plugin constructor

Method Summary

string getPluginDescription()
          Get the instance's pluginDescription

string getPluginName()
          Get the instance's pluginName

string getPluginVersion()
          Get the instance's pluginVersion

private struct getRequestCollection([boolean private='false'])
          Get a reference to the request collection

private RequestContext getRequestContext()
          Retrieve the request context object

string getpluginAuthor()
          Get the instance's pluginAuthor

string getpluginAuthorURL()
          Get the instance's pluginAuthorURL

string getpluginPath()
          Get the instance's pluginPath

string setPluginDescription(string pluginDescription)
          Set the instance's pluginDescription

string setPluginName(string pluginName)
          Set the instance's pluginName

string setPluginVersion(string pluginVersion)
          Set the instance's pluginVersion

void setpluginAuthor(string pluginAuthor)
          Set the instance's pluginAuthor

void setpluginAuthorURL(string pluginAuthorURL)
          Set the instance's pluginAuthorURL

Methods inherited from class coldbox.system.FrameworkSupertype

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

Methods inherited from class WEB-INF.cftags.component

Constructor Summary
`init(any controller)` The plugin constructor

Method Summary
`string`	`getPluginDescription()` Get the instance's pluginDescription
`string`	`getPluginName()` Get the instance's pluginName
`string`	`getPluginVersion()` Get the instance's pluginVersion
`private struct`	`getRequestCollection([boolean private='false'])` Get a reference to the request collection
`private RequestContext`	`getRequestContext()` Retrieve the request context object
`string`	`getpluginAuthor()` Get the instance's pluginAuthor
`string`	`getpluginAuthorURL()` Get the instance's pluginAuthorURL
`string`	`getpluginPath()` Get the instance's pluginPath
`string`	`setPluginDescription(string pluginDescription)` Set the instance's pluginDescription
`string`	`setPluginName(string pluginName)` Set the instance's pluginName
`string`	`setPluginVersion(string pluginVersion)` Set the instance's pluginVersion
`void`	`setpluginAuthor(string pluginAuthor)` Set the instance's pluginAuthor
`void`	`setpluginAuthorURL(string pluginAuthorURL)` Set the instance's pluginAuthorURL

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

Constructor Detail

init

public init(any controller)

The plugin constructor.

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

Method Detail

getPluginDescription

public string getPluginDescription()

Get the instance's pluginDescription

getPluginName

public string getPluginName()

Get the instance's pluginName

getPluginVersion

public string getPluginVersion()

Get the instance's pluginVersion

getRequestCollection

private struct getRequestCollection([boolean private='false'])

Get a reference to the request collection

getRequestContext

private RequestContext getRequestContext()

Retrieve the request context object

getpluginAuthor

public string getpluginAuthor()

Get the instance's pluginAuthor

getpluginAuthorURL

public string getpluginAuthorURL()

Get the instance's pluginAuthorURL

getpluginPath

public string getpluginPath()

Get the instance's pluginPath

setPluginDescription

public string setPluginDescription(string pluginDescription)

Set the instance's pluginDescription

setPluginName

public string setPluginName(string pluginName)

Set the instance's pluginName

setPluginVersion

public string setPluginVersion(string pluginVersion)

Set the instance's pluginVersion

setpluginAuthor

public void setpluginAuthor(string pluginAuthor)

Set the instance's pluginAuthor

setpluginAuthorURL

public void setpluginAuthorURL(string pluginAuthorURL)

Set the instance's pluginAuthorURL

Overview

Package