Each skin template can execute action commands. We have several already constructed into the tag that can execute if it detects an incoming URL variable called URL.cbox_command. So if your report exists in a page called monitor.cfm then just call that same page (via AJAX preferably) with some URL variables attached (See default skin example). Now, below are the ones we implement, but you can build as many as you like and place them in the page where you use the monitor tag or in the skin templates themselves; wherever they make sense to you.
The following are the commands built in to the reporting tag and the incoming URL variables it expects. Please note that the command is taken from the URL.cbox_command variable:
Info : If the tag detects an incoming command, it will execute it, reset the content and output a true to the response buffer.
Sample Calls
Command
URL Variables
Description
expireCache
url.cbox_cacheName
Executes a expireAll() in the cache provider specified by the incoming cache name.
reapCache
url.cbox_cacheName
Executes a reap() in the cache provider specified in the incoming cache name
delCacheEntry
url.cbox_cacheName
url.cbox_cacheEntry
Deletes the passed in cache entry from the named provider
clearAllEvents
url.cbox_cacheName
Executes a clearAllEvents() in the cache provider specified in the incoming cache name(Must be a ColdBox enabled cache)
clearAllViews
url.cbox_cacheName
Executes a clearAllViews() in the cache provider specified in the incoming cache name(Must be a ColdBox enabled cache)
cacheBoxReapAll
none
Executes a reapAll() via the CacheBox Cache Factory
cacheBoxExpireAll
none
Executes a expireAll() via the CacheBox Cache Factory
gc
none
Executes a suggestion to the JVM to produce a garbage collection
This object is in charge of rendering skin templates and also executing processing commands. The custom tag creates this object and prepares it for usage, so do not worry about it, just know how to use it. The following are the variable compositions this object has and therefore you can use them in your skin templates:
This tag also has the following methods that you might be interested in:
For example, here is a snippet of the CachePanel.cfm template to designate where the cache report for a specific cache provider will be rendered by default:
Since no cacheName argument is provided, it will use the default value of default. Here is a snippet of the cache report template of where it designates the content report to be rendered. It also verifies that the cache provider has reporting enabled and uses a custom attribute called contentReport.
Variable
Type
Description
cacheBox
cachebox.system.cache.CacheFactory
A reference to the running CacheBox cache factory
baseURL
string
The baseURL attribute passed via the tag configuration
sking
string
The skin attribute passed via the tag configuration
skinPath
string
The non-expanded path to the skin in use. e.g. /cachebox/system/cache/report/skin/MyCoolSkin
attributes
struct
A reference to the attributes structure passed via the tag
caller
template
A reference to the caller page of the custom tag.
Return Type
Method
void
processCommands(*[command=],[cacheName=default],[cacheEntry=])
Execute and process a cacheBox command
any
renderCachePanel()
Render the CachePanel.cfm template
any
renderCacheReport(cacheName)
Render the CacheReport.cfm template which renders typically the report information about a specific cache provider
any
renderCacheContentReport(cacheName)
Render the CacheContentReport.cfm template which typically renders the report of the content of the cache provider
any
renderCacheDumper(cacheName,cacheEntry)
Tries to retrieve the cacheEntry from the cacheName provider and dumps it