coldbox.system.cache.report

Class ReportHandler

lucee.Component
    extended by coldbox.system.cache.report.ReportHandler

Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com --- The ColdBox CacheBox Report Handler

Class Attributes:
  • synchronized : false
    •  
  • accessors : true
    •  
  • persistent : false
    •  
  • serializable : false
    •  
  • author : Luis Majano
    •  
    Constructor Summary
    init(CacheFactory cacheBox, any baseUrl, any skin, struct attributes, any caller)
          Constructor.
    Method Summary
    private any getUtil()
         Get utility object.
    boolean processCommands([any command=''], [any cacheName='default'], [any cacheEntry=''])
         Process CacheBox Commands.
    any renderCacheContentReport([any cacheName='default'])
         Render a cache's content report.
    any renderCacheDumper([any cacheName='default'], any 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 lucee.Component
    None
    Constructor Detail

    init

    public init(CacheFactory cacheBox, any baseUrl, any 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 any getUtil()

    Get utility object

    processCommands

    public boolean processCommands([any command=''], [any cacheName='default'], [any cacheEntry=''])

    Process CacheBox Commands

    Parameters:
    command - The command to process
    cacheName - The cache name, defaults to `default`
    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'], any 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