coldbox.system

Class Plugin

WEB-INF.cftags.component
        extended by coldbox.system.FrameworkSupertype
            extended by coldbox.system.Plugin
Class Attributes:
  • serializable : false
    •  
  • output : false
    •  
    Direct Known Subclasses:
    AntiSamy , ApplicationStorage , BeanFactory , ClientStorage , ClusterStorage , CookieStorage , FeedGenerator , FeedReader , IOC , JavaLoader , Logger , MessageBox , QueryHelper , Renderer , ResourceBundle , SessionStorage , Timer , Webservices , i18n

    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 any<struct> getRequestCollection([boolean private='false'])
         Get a reference to the request collection.
    private any<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(any pluginDescription)
         Set the instance's pluginDescription.
    string setPluginName(any pluginName)
         Set the instance's pluginName.
    string setPluginVersion(any pluginVersion)
         Set the instance's pluginVersion.
    void setpluginAuthor(any pluginAuthor)
         Set the instance's pluginAuthor.
    void setpluginAuthorURL(any 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, getInterceptor, getMailService, getMailSettings, getMemento, getModel, getModuleSettings, getMyPlugin, getNewMail, getPlugin, getResource, getSetting, getSettingStructure, getSettingsBean, getValidationManager, getfwLocale, includeUDF, loadGlobalUDFLibraries, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderLayout, renderView, runEvent, setDebugMode, setNextEvent, setNextRoute, setSetting, setfwLocale, settingExists, validateModel
     
    Methods inherited from class WEB-INF.cftags.component
    None
    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 any<struct> getRequestCollection([boolean private='false'])

    Get a reference to the request collection

    Parameters:
    private - Get the request collection or private request collection

    getRequestContext

    private any<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(any pluginDescription)

    Set the instance's pluginDescription

    Parameters:
    pluginDescription

    setPluginName

    public string setPluginName(any pluginName)

    Set the instance's pluginName

    Parameters:
    pluginName

    setPluginVersion

    public string setPluginVersion(any pluginVersion)

    Set the instance's pluginVersion

    Parameters:
    pluginVersion

    setpluginAuthor

    public void setpluginAuthor(any pluginAuthor)

    Set the instance's pluginAuthor

    Parameters:
    pluginAuthor

    setpluginAuthorURL

    public void setpluginAuthorURL(any pluginAuthorURL)

    Set the instance's pluginAuthorURL

    Parameters:
    pluginAuthorURL