ColdBox Platform Version 3.7.0

coldbox.system.cache.report
Class ReportHandler

WEB-INF.cftags.component
        extended by coldbox.system.cache.report.ReportHandler

public class ReportHandler
extends WEB-INF.cftags.component

The ColdBox CacheBox Report Handler


Constructor Summary
init(CacheFactory cacheBox, string baseURL, string skin, struct attributes, any caller)
          Constructor
 
Method Summary
private Util getUtil()
          Create and return a util object
 boolean processCommands([string command=''], [string cacheName='default'], [string cacheEntry=''])
          Process CacheBox Commands
 any renderCacheContentReport(any cacheName='default')
          Render a cache's content report
 Any renderCacheDumper(any cacheName='default', string cacheEntry)
          Renders the caching key value dumper
 any renderCachePanel()
          Renders the caching panel
 any renderCacheReport(any cacheName='default')
          Render a cache report for a specific cache
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init(CacheFactory cacheBox, string baseURL, string skin, struct attributes, any caller)
Constructor

Parameters:
cacheBox - The cache factory binded to
baseURL - The baseURL used for reporting
skin - The skin to use for reporting
attributes - The incoming attributes
caller - Access to the caller tag
Method Detail

getUtil

private Util getUtil()
Create and return a util object


processCommands

public boolean processCommands([string command=''], [string cacheName='default'], [string cacheEntry=''])
Process CacheBox Commands

Parameters:
command - The command to process
cacheName - The cache name
cacheEntry - The cache entry to act upon

renderCacheContentReport

public any renderCacheContentReport(any cacheName='default')
Render a cache's content report

Parameters:
cacheName - The cache name

renderCacheDumper

public Any renderCacheDumper(any cacheName='default', string cacheEntry)
Renders the caching key value dumper.

Parameters:
cacheName - The cache name
cacheEntry - The cache entry to dump

renderCachePanel

public any renderCachePanel()
Renders the caching panel.


renderCacheReport

public any renderCacheReport(any cacheName='default')
Render a cache report for a specific cache

Parameters:
cacheName - The cache name

ColdBox Platform Version 3.7.0