lucee.Component coldbox.system.FrameworkSupertype coldbox.system.web.Renderer
Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com --- The system web renderer
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
any
|
appMapping
|
true
|
false
|
|
any
|
event
|
true
|
false
|
|
any
|
explicitView
|
true
|
false
|
|
any
|
html
HTML Helper.
|
true
|
false
|
|
any
|
isDiscoveryCaching
|
true
|
false
|
|
boolean
|
isViewsHelperIncluded
|
false
|
true
|
false
|
any
|
layoutsConvention
PROPERTIES ********************************************.
|
true
|
false
|
|
any
|
LayoutsExternalLocation
|
true
|
false
|
|
any
|
lockName
|
true
|
false
|
|
struct
|
moduleConfig
|
true
|
false
|
|
any
|
prc
|
true
|
false
|
|
any
|
rc
|
true
|
false
|
|
struct
|
renderedHelpers
|
true
|
false
|
|
any
|
templateCache
Template cache provider.
|
true
|
false
|
|
any
|
viewsConvention
|
true
|
false
|
|
any
|
ViewsExternalLocation
|
true
|
false
|
|
any
|
viewsHelper
|
true
|
false
|
Constructor Summary | |
---|---|
init(any controller)
Constructor. |
Method Summary | |
---|---|
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'], [any name])
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 lucee.Component |
---|
None |
Constructor Detail |
---|
Constructor
controller
- The ColdBox main controllerProperty Detail |
---|
access
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyserializable
- trueHTML Helper
access
- publicrequired
- falsereturntype
- anyinject
- HTMLHelper@coldboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyserializable
- truePROPERTIES ********************************************
access
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyserializable
- trueTemplate cache provider
access
- publicrequired
- falsereturntype
- anyinject
- cachebox:templateserializable
- trueaccess
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyserializable
- trueMethod Detail |
---|
Discover view+helper path locations
view
- The view to discovermodule
- The module addressexplicitModule
- Is the module explicit or discoverable.Checks if implicit views are turned on and if so, calculate view according to event.
Locate a layout in the conventions system
layout
- The layout nameLocate a layout in the conventions system
layout
- The layout namemodule
- The name of the module we are searching forexplicitModule
- Are we locating explicitly or implicitly for a module layoutLocate a view in the conventions system
view
- The view namemodule
- The name of the module we are searching forexplicitModule
- Are we locating explicitly or implicitly for a module layoutLocate a view in the conventions or external paths
view
- The view to locateRenders an external view anywhere that cfinclude works.
renderExternalView
in class
FrameworkSupertype
view
- The the view to renderargs
- 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 falsecacheTimeout
- The time in minutes to cache the viewcacheLastAccessTimeout
- The time in minutes the view will be removed from cache if idle or requestedcacheSuffix
- The suffix to add into the cache entry for this view renderingcacheProvider
- The provider to cache this view in, defaults to 'template'Render a layout or a layout + view combo
renderLayout
in class
FrameworkSupertype
layout
- The layout to render outmodule
- The module to explicitly render this layout fromview
- The view to render within this layoutargs
- An optional set of arguments that will be available to this layouts/view rendering ONLYviewModule
- The module to explicitly render the view fromprePostExempt
- If true, pre/post layout interceptors will not be fired. By default they do fireRender out a view
renderView
in class
FrameworkSupertype
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 explicitlycache
- Cached the view output or not, defaults to falsecacheTimeout
- The time in minutes to cache the viewcacheLastAccessTimeout
- The time in minutes the view will be removed from cache if idle or requestedcacheSuffix
- The suffix to add into the cache entry for this view renderingcacheProvider
- 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 conventioncollectionStartRow
- The start row to limit the collection rendering withcollectionMaxRows
- The max rows to iterate over the collection rendering withcollectionDelim
- A string to delimit the collection renderings byprePostExempt
- If true, pre/post view interceptors will not be fired. By default they do firename
- The name of the rendering region to render out, Usually all arguments are coming from the stored region but you override them using this function's arguments.Render a view composed of collections, mostly used internally, use at your own risk.
view
viewPath
viewHelperPath
args
collection
collectionAs
collectionStartRow
collectionMaxRows
collectionDelim
Render a view alongside its helpers, used mostly internally, use at your own risk.
view
viewPath
viewHelperPath
args
appMapping
event
set the explicit view bit, used mostly internally
view
- The name of the view to renderhtml
isDiscoveryCaching
isViewsHelperIncluded
layoutsConvention
LayoutsExternalLocation
lockName
moduleConfig
prc
rc
renderedHelpers
templateCache
viewsConvention
ViewsExternalLocation
viewsHelper