mura

Class MuraScope

lucee.Component
    extended by mura.cfobject
      extended by mura.MuraScope

This provides a utility to access all Mura functionality

Class Attributes:
  • output : false
    •  
  • synchronized : false
    •  
  • accessors : false
    •  
  • persistent : false
    •  
    Constructor Summary
    init([any data])
    Method Summary
    any announceEvent([any eventName], [any index='0'])
    any component([any property], [any propertyValue])
    any content([any property], [any propertyValue])
    any createHREF(any type='Page', any filename='', any siteid='[runtime expression]', any contentid='', any target='', any targetParams='', any querystring='', string context='[runtime expression]', string stub='[runtime expression]', string indexFile='', boolean complete='false', string showMeta='0')
    any currentURL()
    any currentUser([any property], [any propertyValue])
    any each([any collection], [any action], [any $='[runtime expression]'], [any delimiters=','])
    any event([any property], [any propertyValue])
    any generateCSRFTokens()
    any getBean([any beanName], [any siteID=''])
    any getContentBean()
    any getContentRenderer([any force='false'])
    any getCrumbPropertyArray([any property], [any direction='desc'])
    any getEvent()
    any getFeed([any entityName])
    any getGlobalEvent()
    any getParent()
    any getSiteRenderer()
         deprecated: use getContentRenderer().
    any getThemeRenderer()
         deprecated: use getContentRenderer().
    any globalConfig([any property], [any propertyValue])
    any hasParent()
    any isHandledEvent([any eventName])
    any OnMissingMethod(string MissingMethodName, struct MissingMethodArguments)
         Handles missing method exceptions.
    any rbKey([any key], [string locale=''])
    any removeAdminAlert([any key], [any text])
    any renderCSRFTokens()
    any renderEvent([any eventName], [any index='0'])
    any setAdminAlert([any key], [any text], [any type=''])
    any setContentBean([any contentBean])
    any setCustomMuraScopeKey([any name], [any value])
    any setEvent([any event])
    any siteConfig([any property], [any propertyValue])
    any static([any staticDirectory=''], [any staticUrl=''], [any outputDirectory='compiled'], [any minifyMode='package'], [any checkForUpdates='true'], [any addCacheBusters='true'], [any forceCompilation='false'], [any javaLoaderScope='[runtime expression]'])
    any validateCSRFTokens()
     
    Methods inherited from class mura.cfobject
    commitTracePoint, convertTimezone, deleteMethod, get, getAsJSON, getAsStruct, getConfigBean, getCurrentUser, getEventManager, getHTTPAttrs, getHTTPService, getJavaTimezone, getPlugin, getPluginManager, getQueryAttrs, getQueryService, getServiceFactory, getSession, getValue, hasCustomDatasource, initTracePoint, inject, injectMethod, invokeMethod, mixin, parseDateArg, removeValue, set, setValue, valueExists
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

    public init([any data])

    Parameters:
    data - Can be an event object, struct or siteID
    Method Detail

    announceEvent

    public any announceEvent([any eventName], [any index='0'])

    Parameters:
    eventName
    index

    component

    public any component([any property], [any propertyValue])

    Parameters:
    property
    propertyValue

    content

    public any content([any property], [any propertyValue])

    Parameters:
    property
    propertyValue

    createHREF

    public any createHREF(any type='Page', any filename='', any siteid='[runtime expression]', any contentid='', any target='', any targetParams='', any querystring='', string context='[runtime expression]', string stub='[runtime expression]', string indexFile='', boolean complete='false', string showMeta='0')

    Parameters:
    type
    filename
    siteid
    contentid
    target
    targetParams
    querystring
    context
    stub
    indexFile
    complete
    showMeta

    currentURL

    public any currentURL()

    currentUser

    public any currentUser([any property], [any propertyValue])

    Parameters:
    property
    propertyValue

    each

    public any each([any collection], [any action], [any $='[runtime expression]'], [any delimiters=','])

    Parameters:
    collection - An Query, Array, Iterator, Struct or List the action function will be applied.
    action - A function that will run per item in iterator.
    $ - A context object that is passed to each method. It defaults to the current MuraScope istance
    delimiters - The delimiter to be used when the collection argument is a list.

    event

    public any event([any property], [any propertyValue])

    Parameters:
    property
    propertyValue

    generateCSRFTokens

    public any generateCSRFTokens()

    getBean

    public any getBean([any beanName], [any siteID=''])

    Overrides:
    getBean in class cfobject
    Parameters:
    beanName
    siteID

    getContentBean

    public any getContentBean()

    getContentRenderer

    public any getContentRenderer([any force='false'])

    Parameters:
    force

    getCrumbPropertyArray

    public any getCrumbPropertyArray([any property], [any direction='desc'])

    Parameters:
    property
    direction

    getEvent

    public any getEvent()

    getFeed

    public any getFeed([any entityName])

    Overrides:
    getFeed in class cfobject
    Parameters:
    entityName

    getGlobalEvent

    public any getGlobalEvent()

    getParent

    public any getParent()

    getSiteRenderer

    public any getSiteRenderer()

    deprecated: use getContentRenderer()

    getThemeRenderer

    public any getThemeRenderer()

    deprecated: use getContentRenderer()

    globalConfig

    public any globalConfig([any property], [any propertyValue])

    Parameters:
    property
    propertyValue

    hasParent

    public any hasParent()

    isHandledEvent

    public any isHandledEvent([any eventName])

    Parameters:
    eventName

    OnMissingMethod

    public any OnMissingMethod(string MissingMethodName, struct MissingMethodArguments)

    Handles missing method exceptions.

    Parameters:
    MissingMethodName - The name of the missing method.
    MissingMethodArguments

    rbKey

    public any rbKey([any key], [string locale=''])

    Parameters:
    key
    locale

    removeAdminAlert

    public any removeAdminAlert([any key], [any text])

    Parameters:
    key
    text

    renderCSRFTokens

    public any renderCSRFTokens()

    renderEvent

    public any renderEvent([any eventName], [any index='0'])

    Parameters:
    eventName
    index

    setAdminAlert

    public any setAdminAlert([any key], [any text], [any type=''])

    Parameters:
    key
    text
    type

    setContentBean

    public any setContentBean([any contentBean])

    Parameters:
    contentBean

    setCustomMuraScopeKey

    public any setCustomMuraScopeKey([any name], [any value])

    Parameters:
    name
    value

    setEvent

    public any setEvent([any event])

    Parameters:
    event

    siteConfig

    public any siteConfig([any property], [any propertyValue])

    Parameters:
    property
    propertyValue

    static

    public any static([any staticDirectory=''], [any staticUrl=''], [any outputDirectory='compiled'], [any minifyMode='package'], [any checkForUpdates='true'], [any addCacheBusters='true'], [any forceCompilation='false'], [any javaLoaderScope='[runtime expression]'])

    Parameters:
    staticDirectory
    staticUrl
    outputDirectory
    minifyMode
    checkForUpdates
    addCacheBusters
    forceCompilation
    javaLoaderScope

    validateCSRFTokens

    public any validateCSRFTokens()