Overview  Package   Class 
Mura CMS 6.1
FRAMES  

mura.plugin
Class pluginManager

railo-context.Component
        extended by mura.cfobject
            extended by mura.plugin.pluginManager

public class pluginManager

extends cfobject

Constructor Summary
init(any configBean, any settingsManager, any utility, any standardEventsHandler, any fileWriter)
 
Method Summary
 void addEventHandler([any component], any siteID, any persist='true')
 any adjustSiteID([any siteID])
 void announceEvent(any eventToAnnounce='', any currentEventObject='', any rsHandlers='', any moduleID='', any index='0')
 any createAppCFCIncludes()
 any createBundle([any id], [any directory])
          I bundle a plugin and return it's filename
 void createLookupTXT()
 void deleteAssignedSites([any moduleID])
 void deleteDisplayObjects([any moduleID])
 void deletePlugin([any moduleID])
 void deleteScripts([any moduleID])
 void deleteSettings([any moduleID])
 any deploy(any moduleID='', any id='', any useDefaultSettings='false', [any siteID=''], any pluginFile='', any pluginDir='', any autoDeploy='true')
          This method is primarily used internally by Mura
 any deployBundle([any siteID], [any bundleFile])
          I return a struct of any errors that occured
 any deployDirectory([any siteID], [any directory], any useDefaultSettings='true', any autoDeploy='true')
 any deployPlugin([any siteID], [any pluginFile], any useDefaultSettings='true', any autoDeploy='true')
 any discover()
 any displayObject([any object], any event='', any moduleID='', any params='')
 any executeScript([any runat], any siteID='', any event='', any index='1')
 any executeScripts([any runat], any siteID='', any event='', any scripts='', any moduleID='')
 query getAllPlugins(any orderby='name')
 query getAssignedSites([any moduleID])
 any getAttributeBean([any theXML], [any moduleID])
 any getCacheFactory(any siteid='')
 any getComponent([any componentPath], [any pluginID], [any siteID], any cache='true')
 any getConfig([any ID], any siteID='', any cache='true')
 string getDirectoryFromQuery([any rs])
 any getDisplayObjectBean()
 query getDisplayObjectsBySiteID(any siteID='', any modulesOnly='false', any moduleID='', any configuratorsOnly='false')
 any getEventHandlerFromPath([any component])
 any getEventMappings([any eventName], any siteID='')
 any getExecutor()
 query getHandlersQuery([any eventToHandle], any siteID='', any moduleID='')
 any getIDFromPath([any path])
 any getLocalFileFromURL([any pluginURL])
 string getLocation([any directory])
 query getPlugin([any ID], any siteID='', any cache='true')
 xml getPluginXML([any moduleID], [any pluginDir=''])
 any getScriptBean()
 query getScripts([any runat], any siteID='', any moduleID='')
 any getSiteListener([any siteID], [any runat])
 struct getSitePluginGroups([query rsplugins])
 query getSitePlugins([any siteID], any orderby='name', any applyPermFilter='false')
 any getStandardEventFactory(any siteid='')
 any getZipTrim([any pluginFile])
 any hasPlugin([any ID], any siteID='', any cache='true')
 void loadPlugins([any safeMode='false'])
 any purgeCacheFactories()
 any purgePluginConfigs()
 any purgeStandardEventFactories()
 any reDeploy([any siteID], [any ID])
 any renderAdminTemplate([any body], [any pageTitle], any jsLib='prototype', any jsLibLoaded='false', [any compactDisplay='false'])
 any renderAdminToolbar(any jsLib='prototype', any jsLibLoaded='false')
 any renderEvent(any eventToRender='', any currentEventObject='', any rsHandlers='', any moduleID='', any index='0')
 any renderScript([any runat], any siteID='', any event='', any index='1')
 any renderScripts([any runat], any siteID='', any event='', any scripts='', any moduleID='')
 any savePluginXML([any modID])
 void updateSettings([any args])
 
Methods inherited from class mura.cfobject
commitTracePoint, deleteMethod, getAsJSON, getAsStruct, getBean, getConfigBean, getCurrentUser, getEventManager, getPluginManager, getServiceFactory, getValue, initTracePoint, injectMethod, invokeMethod, removeValue, setValue, valueExists
 
Methods inherited from class railo-context.Component
 

Constructor Detail

init

public init(any configBean, any settingsManager, any utility, any standardEventsHandler, any fileWriter)

Parameters:
configBean
settingsManager
utility
standardEventsHandler
fileWriter
Method Detail

addEventHandler

public void addEventHandler([any component], any siteID, any persist='true')

Parameters:
component
siteID
persist

adjustSiteID

public any adjustSiteID([any siteID])

Parameters:
siteID

announceEvent

public void announceEvent(any eventToAnnounce='', any currentEventObject='', any rsHandlers='', any moduleID='', any index='0')

Parameters:
eventToAnnounce
currentEventObject
rsHandlers
moduleID
index

createAppCFCIncludes

public any createAppCFCIncludes()

createBundle

public any createBundle([any id], [any directory])
I bundle a plugin and return it's filename

Parameters:
id - ModuleID or pluginID or Package
directory - Server directory to save the bundle

createLookupTXT

public void createLookupTXT()

deleteAssignedSites

public void deleteAssignedSites([any moduleID])

Parameters:
moduleID

deleteDisplayObjects

public void deleteDisplayObjects([any moduleID])

Parameters:
moduleID

deletePlugin

public void deletePlugin([any moduleID])

Parameters:
moduleID

deleteScripts

public void deleteScripts([any moduleID])

Parameters:
moduleID

deleteSettings

public void deleteSettings([any moduleID])

Parameters:
moduleID

deploy

public any deploy(any moduleID='', any id='', any useDefaultSettings='false', [any siteID=''], any pluginFile='', any pluginDir='', any autoDeploy='true')
This method is primarily used internally by Mura. See deployPlugin.

Parameters:
moduleID
id - Either ModuleID, PluginID or Package. Can be used instead of moduleID argument.
useDefaultSettings - Deploy default config.xml settings values, not applicable for bundles
siteID - List of siteIDs to assign the plugin. Only applicable when useDefaultSettings is set to true.
pluginFile
pluginDir
autoDeploy

deployBundle

public any deployBundle([any siteID], [any bundleFile])
I return a struct of any errors that occured.

Parameters:
siteID - List of siteIDs to assign the plugin
bundleFile - Complete path to bundle zip file

deployDirectory

public any deployDirectory([any siteID], [any directory], any useDefaultSettings='true', any autoDeploy='true')

Parameters:
siteID - List of siteIDs to assign the plugin. If not defined will defiend to existing assignment.
directory - Complete path to external plugin directory if external, otherwise the name og the directory in /plugins
useDefaultSettings
autoDeploy

deployPlugin

public any deployPlugin([any siteID], [any pluginFile], any useDefaultSettings='true', any autoDeploy='true')

Parameters:
siteID - List of siteIDs to assign the plugin
pluginFile - Complete path to plugin zip file
useDefaultSettings
autoDeploy

discover

public any discover()

displayObject

public any displayObject([any object], any event='', any moduleID='', any params='')

Parameters:
object
event
moduleID
params

executeScript

public any executeScript([any runat], any siteID='', any event='', any index='1')

Parameters:
runat
siteID
event
index

executeScripts

public any executeScripts([any runat], any siteID='', any event='', any scripts='', any moduleID='')

Parameters:
runat
siteID
event
scripts
moduleID

getAllPlugins

public query getAllPlugins(any orderby='name')

Parameters:
orderby

getAssignedSites

public query getAssignedSites([any moduleID])

Parameters:
moduleID

getAttributeBean

public any getAttributeBean([any theXML], [any moduleID])

Parameters:
theXML
moduleID

getCacheFactory

public any getCacheFactory(any siteid='')

Parameters:
siteid

getComponent

public any getComponent([any componentPath], [any pluginID], [any siteID], any cache='true')

Parameters:
componentPath
pluginID
siteID
cache

getConfig

public any getConfig([any ID], any siteID='', any cache='true')

Parameters:
ID
siteID
cache

getDirectoryFromQuery

public string getDirectoryFromQuery([any rs])

Parameters:
rs

getDisplayObjectBean

public any getDisplayObjectBean()

getDisplayObjectsBySiteID

public query getDisplayObjectsBySiteID(any siteID='', any modulesOnly='false', any moduleID='', any configuratorsOnly='false')

Parameters:
siteID
modulesOnly
moduleID
configuratorsOnly

getEventHandlerFromPath

public any getEventHandlerFromPath([any component])

Parameters:
component

getEventMappings

public any getEventMappings([any eventName], any siteID='')

Parameters:
eventName
siteID

getExecutor

public any getExecutor()

getHandlersQuery

public query getHandlersQuery([any eventToHandle], any siteID='', any moduleID='')

Parameters:
eventToHandle
siteID
moduleID

getIDFromPath

public any getIDFromPath([any path])

Parameters:
path

getLocalFileFromURL

public any getLocalFileFromURL([any pluginURL])

Parameters:
pluginURL

getLocation

public string getLocation([any directory])

Parameters:
directory

getPlugin

public query getPlugin([any ID], any siteID='', any cache='true')

Overrides:
getPlugin in class cfobject
Parameters:
ID
siteID
cache

getPluginXML

public xml getPluginXML([any moduleID], [any pluginDir=''])

Parameters:
moduleID
pluginDir

getScriptBean

public any getScriptBean()

getScripts

public query getScripts([any runat], any siteID='', any moduleID='')

Parameters:
runat
siteID
moduleID

getSiteListener

public any getSiteListener([any siteID], [any runat])

Parameters:
siteID
runat

getSitePluginGroups

public struct getSitePluginGroups([query rsplugins])

Parameters:
rsplugins

getSitePlugins

public query getSitePlugins([any siteID], any orderby='name', any applyPermFilter='false')

Parameters:
siteID
orderby
applyPermFilter

getStandardEventFactory

public any getStandardEventFactory(any siteid='')

Parameters:
siteid

getZipTrim

public any getZipTrim([any pluginFile])

Parameters:
pluginFile

hasPlugin

public any hasPlugin([any ID], any siteID='', any cache='true')

Parameters:
ID
siteID
cache

loadPlugins

public void loadPlugins([any safeMode='false'])

Parameters:
safeMode

purgeCacheFactories

public any purgeCacheFactories()

purgePluginConfigs

public any purgePluginConfigs()

purgeStandardEventFactories

public any purgeStandardEventFactories()

reDeploy

public any reDeploy([any siteID], [any ID])

Parameters:
siteID - List of siteIDs to assign the plugin. If not defined will defiend to existing assignment.
ID - The moduleID, pluginID, package or name of plugin to redeploy

renderAdminTemplate

public any renderAdminTemplate([any body], [any pageTitle], any jsLib='prototype', any jsLibLoaded='false', [any compactDisplay='false'])

Parameters:
body
pageTitle
jsLib
jsLibLoaded
compactDisplay

renderAdminToolbar

public any renderAdminToolbar(any jsLib='prototype', any jsLibLoaded='false')

Parameters:
jsLib
jsLibLoaded

renderEvent

public any renderEvent(any eventToRender='', any currentEventObject='', any rsHandlers='', any moduleID='', any index='0')

Parameters:
eventToRender
currentEventObject
rsHandlers
moduleID
index

renderScript

public any renderScript([any runat], any siteID='', any event='', any index='1')

Parameters:
runat
siteID
event
index

renderScripts

public any renderScripts([any runat], any siteID='', any event='', any scripts='', any moduleID='')

Parameters:
runat
siteID
event
scripts
moduleID

savePluginXML

public any savePluginXML([any modID])

Parameters:
modID

updateSettings

public void updateSettings([any args])

Parameters:
args
Overview  Package   Class 
Mura CMS 6.1
FRAMES