|
ColdBox Platform v3.8.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.FrameworkSupertype
coldbox.system.Plugin
coldbox.system.plugins.Renderer
public class Renderer
This service renders layouts, views, framework includes, etc.
Constructor Summary | |
---|---|
init(any controller)
Constructor |
Method Summary | |
---|---|
private any |
discoverViewPaths([any view], [any module], [any explicitModule])
Discover view paths and cache if necessary and return its locations |
private string |
getAppMapping()
Get appMapping |
private string |
getLayoutsConvention()
Get layoutsConvention |
private string |
getModulesConvention()
Get layoutsConvention |
private string |
getViewsConvention()
Get viewsConvention |
private any |
implicitViewChecks()
Does implicit view rendering checks |
any |
locateLayout(any layout)
Locate the layout to render |
any |
locateModuleLayout(any layout, [any module=''], [boolean explicitModule='false'])
Locate the view to render using module logic |
any |
locateModuleView(any view, [any module=''], [boolean explicitModule='false'])
Locate the view to render using module logic |
any |
locateView(any view)
Locate the view to render |
Any |
renderExternalView(any view, [boolean cache='false'], [any cacheTimeout=''], [any cacheLastAccessTimeout=''], [any cacheSuffix=''], [any cacheProvider='template'], [any args='[runtime expression]'])
Renders an external view |
any |
renderLayout([any layout], [any view=''], [any module=''], [any args='[runtime expression]'], [any viewModule=''], [any<boolean> prepostExempt='false'])
Renders the current layout + view Combinations if declared |
Any |
renderView([any view=''], [any cache='false'], [any cacheTimeout=''], [any cacheLastAccessTimeout=''], [any cacheSuffix=''], [any cacheProvider='template'], [any module=''], [any args='[runtime expression]'], [any<coldbox.system.plugins.collection> collection], [any collectionAs=''], [any<numeric> collectionStartRow='1'], [any<numeric> collectionMaxRows='0'], [any collectionDelim=''], [any<boolean> prepostExempt='false'])
Renders the current view |
any |
renderViewCollection([any view], [any viewpath], [any viewHelperPath], [any args], [any collection], [any collectionAs], [any collectionStartRow='1'], [any collectionMaxRows='0'], [any collectionDelim=''])
Render a view composed of collections |
any |
renderViewComposite([any view], [any viewpath], [any viewHelperPath], [any args])
Render a view composite |
any |
setExplicitView(any view)
Set the explicit view to render, usually called to create new rendering contexts |
Methods inherited from class WEB-INF.cftags.component |
---|
None
|
Constructor Detail |
---|
public init(any controller)
controller
Method Detail |
---|
private any discoverViewPaths([any view], [any module], [any explicitModule])
view
module
explicitModule
private string getAppMapping()
private string getLayoutsConvention()
private string getModulesConvention()
private string getViewsConvention()
private any implicitViewChecks()
public any locateLayout(any layout)
layout
- The layout namepublic any locateModuleLayout(any layout, [any module=''], [boolean explicitModule='false'])
layout
- The layout name to discovermodule
- The name of the module we are searching forexplicitModule
- Are we locating explicitly or implicitly for a module layoutpublic any locateModuleView(any view, [any module=''], [boolean explicitModule='false'])
view
- The view namemodule
- The name of the module to explicity look for a viewexplicitModule
- Are we locating explicitly or implicitly for a module layoutpublic any locateView(any view)
view
- The view namePublic Any renderExternalView(any view, [boolean cache='false'], [any cacheTimeout=''], [any cacheLastAccessTimeout=''], [any cacheSuffix=''], [any cacheProvider='template'], [any args='[runtime expression]'])
renderExternalView
in class
FrameworkSupertype
view
- The full path to the view. This can be an expanded path or relative. Include extension.cache
- True if you want to cache the view.cacheTimeout
- The cache timeoutcacheLastAccessTimeout
- The last access timeoutcacheSuffix
- Add a cache suffix to the view cache entry. Great for multi-domain caching or i18n caching.cacheProvider
- The cache provider you want to use for storing the rendered view. By default we use the 'template' cache providerargs
- An optional set of arguments that will be available to this layouts/view rendering ONLYPublic any renderLayout([any layout], [any view=''], [any module=''], [any args='[runtime expression]'], [any viewModule=''], [any<boolean> prepostExempt='false'])
renderLayout
in class
FrameworkSupertype
layout
- The explicit layout to use in renderingview
- The view to render within this layout explicitlymodule
- Explicitly render a layout from this module by passing its module nameargs
- An optional set of arguments that will be available to this layouts/view rendering ONLYviewModule
- Explicitly render a view from this moduleprepostExempt
- If true, pre/post layout interceptors will not be fired. By default they do firePublic Any renderView([any view=''], [any cache='false'], [any cacheTimeout=''], [any cacheLastAccessTimeout=''], [any cacheSuffix=''], [any cacheProvider='template'], [any module=''], [any args='[runtime expression]'], [any<coldbox.system.plugins.collection> collection], [any collectionAs=''], [any<numeric> collectionStartRow='1'], [any<numeric> collectionMaxRows='0'], [any collectionDelim=''], [any<boolean> prepostExempt='false'])
renderView
in class
FrameworkSupertype
view
- If not passed in, the value in the currentView in the current RequestContext will be usedcache
- Cache the rendered view or notcacheTimeout
- The cache timeout for the rendered viewcacheLastAccessTimeout
- The last access timeout for the rendered viewcacheSuffix
- Add a cache suffix to the view cache entry. Great for multi-domain caching or i18n caching.cacheProvider
- The cache provider you want to use for storing the rendered view. By default we use the 'template' cache providermodule
- Explicitly render a view from this module by passing the module nameargs
- An optional set of arguments that will be available to this layouts/view rendering ONLYcollection
- 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 firepublic any renderViewCollection([any view], [any viewpath], [any viewHelperPath], [any args], [any collection], [any collectionAs], [any collectionStartRow='1'], [any collectionMaxRows='0'], [any collectionDelim=''])
view
viewpath
viewHelperPath
args
collection
collectionAs
collectionStartRow
collectionMaxRows
collectionDelim
public any renderViewComposite([any view], [any viewpath], [any viewHelperPath], [any args])
view
viewpath
viewHelperPath
args
public any setExplicitView(any view)
view
- The view to explicitly set
|
ColdBox Platform v3.8.0 | ||||
FRAMES |