coldbox.system.web

Class Renderer

lucee.Component
    extended by coldbox.system.FrameworkSupertype
      extended by coldbox.system.web.Renderer

Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com --- The system web renderer

Class Attributes:
  • synchronized : false
    •  
  • accessors : true
    •  
  • persistent : false
    •  
  • serializable : false
    •  
  • author : Luis Majano
    •  
    Property Summary
    type property default serializable required
    any appMapping


    • access = public
    • returntype = any
    		 true false
    any event


    • access = public
    • returntype = any
    		 true false
    any explicitView


    • access = public
    • returntype = any
    		 true false
    any html
          HTML Helper.

    • access = public
    • returntype = any
    • inject = HTMLHelper@coldbox
    		 true false
    any isDiscoveryCaching


    • access = public
    • returntype = any
    		 true false
    boolean isViewsHelperIncluded


    • access = public
    • returntype = any
    		 false true false
    any layoutsConvention
          PROPERTIES ********************************************.

    • access = public
    • returntype = any
    		 true false
    any LayoutsExternalLocation


    • access = public
    • returntype = any
    		 true false
    any lockName


    • access = public
    • returntype = any
    		 true false
    struct moduleConfig


    • access = public
    • returntype = any
    		 true false
    any prc


    • access = public
    • returntype = any
    		 true false
    any rc


    • access = public
    • returntype = any
    		 true false
    struct renderedHelpers


    • access = public
    • returntype = any
    		 true false
    any templateCache
          Template cache provider.

    • access = public
    • returntype = any
    • inject = cachebox:template
    		 true false
    any viewsConvention


    • access = public
    • returntype = any
    		 true false
    any ViewsExternalLocation


    • access = public
    • returntype = any
    		 true false
    any viewsHelper


    • access = public
    • returntype = any
    		 true false
    Constructor Summary
    init(any controller)
          Constructor.
    Method Summary
    private any discoverViewPaths(any view, [any module], [boolean explicitModule='false'])
         Discover view+helper path locations.
    string getAppMapping()
    string getEvent()
    string getExplicitView()
    string getHtml()
    string getIsDiscoveryCaching()
    string getIsViewsHelperIncluded()
    string getLayoutsConvention()
    string getLayoutsExternalLocation()
    string getLockName()
    string getPrc()
    string getRc()
    string getRenderedHelpers()
    string getTemplateCache()
    string getViewsConvention()
    string getViewsExternalLocation()
    string getViewsHelper()
    private any implicitViewChecks()
         Checks if implicit views are turned on and if so, calculate view according to event.
    any locateLayout(any layout)
         Locate a layout in the conventions system.
    any locateModuleLayout(any layout, [any module=''], [boolean explicitModule='false'])
         Locate a layout in the conventions system.
    any locateModuleView(any view, [any module=''], [boolean explicitModule='false'])
         Locate a view in the conventions system.
    any locateView(any view)
         Locate a view in the conventions or external paths.
    any renderExternalView(any view, [struct args='[runtime expression]'], [boolean cache='false'], [any cacheTimeout=''], [any cacheLastAccessTimeout=''], [any cacheSuffix=''], [any cacheProvider='template'])
         Renders an external view anywhere that cfinclude works.
    any renderLayout([any layout], [any module=''], [any view=''], [struct args='[runtime expression]'], [any viewModule=''], [boolean prePostExempt='false'])
         Render a layout or a layout + view combo.
    any renderView([any view=''], [struct args='[runtime expression]'], [any module=''], [boolean cache='false'], [any cacheTimeout=''], [any cacheLastAccessTimeout=''], [any cacheSuffix=''], [any cacheProvider='template'], [any collection], [any collectionAs=''], [numeric collectionStartRow='1'], [numeric collectionMaxRows='0'], [any collectionDelim=''], [boolean prePostExempt='false'])
         Render out a view.
    any renderViewCollection([any view], [any viewPath], [any viewHelperPath], [any args], [any collection], [any collectionAs], [numeric collectionStartRow='1'], [numeric collectionMaxRows='0'], [any collectionDelim=''])
         Render a view composed of collections, mostly used internally, use at your own risk.
    private any renderViewComposite([any view], [any viewPath], [any viewHelperPath], [any args])
         Render a view alongside its helpers, used mostly internally, use at your own risk.
    any setAppMapping(any appMapping)
    any setEvent(any event)
    any setExplicitView(any view)
         set the explicit view bit, used mostly internally.
    any setHtml(any html)
    any setIsDiscoveryCaching(any isDiscoveryCaching)
    any setIsViewsHelperIncluded(boolean isViewsHelperIncluded)
    any setLayoutsConvention(any layoutsConvention)
    any setLayoutsExternalLocation(any LayoutsExternalLocation)
    any setLockName(any lockName)
    any setModuleConfig(struct moduleConfig)
    any setPrc(any prc)
    any setRc(any rc)
    any setRenderedHelpers(struct renderedHelpers)
    any setTemplateCache(any templateCache)
    any setViewsConvention(any viewsConvention)
    any setViewsExternalLocation(any ViewsExternalLocation)
    any setViewsHelper(any viewsHelper)
     
    Methods inherited from class coldbox.system.FrameworkSupertype
    addAsset, announceInterception, getCache, getController, getDatasource, getInstance, getInterceptor, getModel, getModuleConfig, getModuleSettings, getMyPlugin, getPlugin, getRenderer, getRequestCollection, getRequestContext, getSetting, getSettingStructure, includeUDF, loadApplicationHelpers, locateDirectoryPath, locateFilePath, persistVariables, populateModel, runEvent, setController, setNextEvent, setSetting, settingExists
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

    public init(any controller)

    Constructor

    Parameters:
    controller - The ColdBox main controller
    Property Detail

    appMapping

    property any appMapping

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    event

    property any event

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    explicitView

    property any explicitView

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    html

    property any html

    HTML Helper

    Attributes:
    access - public
    required - false
    returntype - any
    inject - HTMLHelper@coldbox
    serializable - true

    isDiscoveryCaching

    property any isDiscoveryCaching

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    isViewsHelperIncluded

    property boolean isViewsHelperIncluded = [false]

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    layoutsConvention

    property any layoutsConvention

    PROPERTIES ********************************************

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    LayoutsExternalLocation

    property any LayoutsExternalLocation

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    lockName

    property any lockName

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    moduleConfig

    property struct moduleConfig

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    prc

    property any prc

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    rc

    property any rc

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    renderedHelpers

    property struct renderedHelpers

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    templateCache

    property any templateCache

    Template cache provider

    Attributes:
    access - public
    required - false
    returntype - any
    inject - cachebox:template
    serializable - true

    viewsConvention

    property any viewsConvention

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    ViewsExternalLocation

    property any ViewsExternalLocation

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    viewsHelper

    property any viewsHelper

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true
    Method Detail

    discoverViewPaths

    private any discoverViewPaths(any view, [any module], [boolean explicitModule='false'])

    Discover view+helper path locations

    Parameters:
    view - The view to discover
    module - The module address
    explicitModule - Is the module explicit or discoverable.

    getAppMapping

    public string getAppMapping()

    getEvent

    public string getEvent()

    getExplicitView

    public string getExplicitView()

    getHtml

    public string getHtml()

    getIsDiscoveryCaching

    public string getIsDiscoveryCaching()

    getIsViewsHelperIncluded

    public string getIsViewsHelperIncluded()

    getLayoutsConvention

    public string getLayoutsConvention()

    getLayoutsExternalLocation

    public string getLayoutsExternalLocation()

    getLockName

    public string getLockName()

    getPrc

    public string getPrc()

    getRc

    public string getRc()

    getRenderedHelpers

    public string getRenderedHelpers()

    getTemplateCache

    public string getTemplateCache()

    getViewsConvention

    public string getViewsConvention()

    getViewsExternalLocation

    public string getViewsExternalLocation()

    getViewsHelper

    public string getViewsHelper()

    implicitViewChecks

    private any implicitViewChecks()

    Checks if implicit views are turned on and if so, calculate view according to event.

    locateLayout

    public any locateLayout(any layout)

    Locate a layout in the conventions system

    Parameters:
    layout - The layout name

    locateModuleLayout

    public any locateModuleLayout(any layout, [any module=''], [boolean explicitModule='false'])

    Locate a layout in the conventions system

    Parameters:
    layout - The layout name
    module - The name of the module we are searching for
    explicitModule - Are we locating explicitly or implicitly for a module layout

    locateModuleView

    public any locateModuleView(any view, [any module=''], [boolean explicitModule='false'])

    Locate a view in the conventions system

    Parameters:
    view - The view name
    module - The name of the module we are searching for
    explicitModule - Are we locating explicitly or implicitly for a module layout

    locateView

    public any locateView(any view)

    Locate a view in the conventions or external paths

    Parameters:
    view - The view to locate

    renderExternalView

    public any renderExternalView(any view, [struct args='[runtime expression]'], [boolean cache='false'], [any cacheTimeout=''], [any cacheLastAccessTimeout=''], [any cacheSuffix=''], [any cacheProvider='template'])

    Renders an external view anywhere that cfinclude works.

    Overrides:
    renderExternalView in class FrameworkSupertype
    Parameters:
    view - The the view to render
    args - A struct of arguments to pass into the view for rendering, will be available as 'args' in the view.
    cache - Cached the view output or not, defaults to false
    cacheTimeout - The time in minutes to cache the view
    cacheLastAccessTimeout - The time in minutes the view will be removed from cache if idle or requested
    cacheSuffix - The suffix to add into the cache entry for this view rendering
    cacheProvider - The provider to cache this view in, defaults to 'template'

    renderLayout

    public any renderLayout([any layout], [any module=''], [any view=''], [struct args='[runtime expression]'], [any viewModule=''], [boolean prePostExempt='false'])

    Render a layout or a layout + view combo

    Overrides:
    renderLayout in class FrameworkSupertype
    Parameters:
    layout - The layout to render out
    module - The module to explicitly render this layout from
    view - The view to render within this layout
    args - An optional set of arguments that will be available to this layouts/view rendering ONLY
    viewModule - The module to explicitly render the view from
    prePostExempt - If true, pre/post layout interceptors will not be fired. By default they do fire

    renderView

    public any renderView([any view=''], [struct args='[runtime expression]'], [any module=''], [boolean cache='false'], [any cacheTimeout=''], [any cacheLastAccessTimeout=''], [any cacheSuffix=''], [any cacheProvider='template'], [any collection], [any collectionAs=''], [numeric collectionStartRow='1'], [numeric collectionMaxRows='0'], [any collectionDelim=''], [boolean prePostExempt='false'])

    Render out a view

    Overrides:
    renderView in class FrameworkSupertype
    Parameters:
    view - The the view to render, if not passed, then we look in the request context for the current set view.
    args - A struct of arguments to pass into the view for rendering, will be available as 'args' in the view.
    module - The module to render the view from explicitly
    cache - Cached the view output or not, defaults to false
    cacheTimeout - The time in minutes to cache the view
    cacheLastAccessTimeout - The time in minutes the view will be removed from cache if idle or requested
    cacheSuffix - The suffix to add into the cache entry for this view rendering
    cacheProvider - The provider to cache this view in, defaults to 'template'
    collection - A collection to use by this Renderer to render the view as many times as the items in the collection (Array or Query)
    collectionAs - The name of the collection variable in the partial rendering. If not passed, we will use the name of the view by convention
    collectionStartRow - The start row to limit the collection rendering with
    collectionMaxRows - The max rows to iterate over the collection rendering with
    collectionDelim - A string to delimit the collection renderings by
    prePostExempt - If true, pre/post view interceptors will not be fired. By default they do fire

    renderViewCollection

    public any renderViewCollection([any view], [any viewPath], [any viewHelperPath], [any args], [any collection], [any collectionAs], [numeric collectionStartRow='1'], [numeric collectionMaxRows='0'], [any collectionDelim=''])

    Render a view composed of collections, mostly used internally, use at your own risk.

    Parameters:
    view
    viewPath
    viewHelperPath
    args
    collection
    collectionAs
    collectionStartRow
    collectionMaxRows
    collectionDelim

    renderViewComposite

    private any renderViewComposite([any view], [any viewPath], [any viewHelperPath], [any args])

    Render a view alongside its helpers, used mostly internally, use at your own risk.

    Parameters:
    view
    viewPath
    viewHelperPath
    args

    setAppMapping

    public any setAppMapping(any appMapping)

    Parameters:
    appMapping

    setEvent

    public any setEvent(any event)

    Parameters:
    event

    setExplicitView

    public any setExplicitView(any view)

    set the explicit view bit, used mostly internally

    Parameters:
    view - The name of the view to render

    setHtml

    public any setHtml(any html)

    Parameters:
    html

    setIsDiscoveryCaching

    public any setIsDiscoveryCaching(any isDiscoveryCaching)

    Parameters:
    isDiscoveryCaching

    setIsViewsHelperIncluded

    public any setIsViewsHelperIncluded(boolean isViewsHelperIncluded)

    Parameters:
    isViewsHelperIncluded

    setLayoutsConvention

    public any setLayoutsConvention(any layoutsConvention)

    Parameters:
    layoutsConvention

    setLayoutsExternalLocation

    public any setLayoutsExternalLocation(any LayoutsExternalLocation)

    Parameters:
    LayoutsExternalLocation

    setLockName

    public any setLockName(any lockName)

    Parameters:
    lockName

    setModuleConfig

    public any setModuleConfig(struct moduleConfig)

    Parameters:
    moduleConfig

    setPrc

    public any setPrc(any prc)

    Parameters:
    prc

    setRc

    public any setRc(any rc)

    Parameters:
    rc

    setRenderedHelpers

    public any setRenderedHelpers(struct renderedHelpers)

    Parameters:
    renderedHelpers

    setTemplateCache

    public any setTemplateCache(any templateCache)

    Parameters:
    templateCache

    setViewsConvention

    public any setViewsConvention(any viewsConvention)

    Parameters:
    viewsConvention

    setViewsExternalLocation

    public any setViewsExternalLocation(any ViewsExternalLocation)

    Parameters:
    ViewsExternalLocation

    setViewsHelper

    public any setViewsHelper(any viewsHelper)

    Parameters:
    viewsHelper