|
ColdBox Platform v3.8.0 | ||||
FRAMES |
WEB-INF.cftags.interfacecoldbox.system.cache.ICacheProvider
coldbox.system.cache.IColdboxApplicationCache
public interface IColdboxApplicationCache
The main interface to produce a ColdBox Application cache
Method Summary | |
---|---|
void |
clearAllEvents([any<boolean> async])
Clears all events from the cache |
void |
clearAllViews([any<Boolean> async])
Clears all views from the cache |
void |
clearEvent(any eventsnippet, [any queryString=''])
Clears all the event permutations from the cache according to snippet and querystring |
void |
clearEventMulti(any eventsnippets, [any queryString=''])
Clears all the event permutations from the cache according to the list of snippets and querystrings |
void |
clearView(any viewSnippet)
Clears all view name permutations from the cache according to the view name |
void |
clearViewMulti(any viewSnippets)
Clears all view name permutations from the cache according to the view name |
any<Controller> |
getColdbox()
Get the coldbox application reference as coldbox |
any |
getEventCacheKeyPrefix()
Get the event cache key prefix |
any<EventURLFacade> |
getEventURLFacade()
Get the event caching URL facade utility |
any |
getViewCacheKeyPrefix()
Get the cached view key prefix |
void |
setColdbox(any<Controller> coldbox)
Set the coldbox application reference |
Methods inherited from class WEB-INF.cftags.interface |
---|
None
|
Method Detail |
---|
public void clearAllEvents([any<boolean> async])
async
- Run command asynchronously or notpublic void clearAllViews([any<Boolean> async])
async
- Run command asynchronously or notpublic void clearEvent(any eventsnippet, [any queryString=''])
eventsnippet
- The event snippet to clear on. Can be partial or fullqueryString
- If passed in, it will create a unique hash out of it. For purging purposespublic void clearEventMulti(any eventsnippets, [any queryString=''])
eventsnippets
- The comma-delimmitted list event snippet to clear on. Can be partial or fullqueryString
- The comma-delimmitted list of queryStrings passed in. If passed in, it will create a unique hash out of it. For purging purposes. If passed in the list length must be equal to the list length of the event snippets passed in.public void clearView(any viewSnippet)
viewSnippet
- The view name snippet to purge from the cachepublic void clearViewMulti(any viewSnippets)
viewSnippets
- The comma-delimmitted list or array of view snippet to clear on. Can be partial or fullpublic any<Controller> getColdbox()
public any getEventCacheKeyPrefix()
public any<EventURLFacade> getEventURLFacade()
public any getViewCacheKeyPrefix()
public void setColdbox(any<Controller> coldbox)
coldbox
- The coldbox application reference as type: coldbox.system.web.Controller
|
ColdBox Platform v3.8.0 | ||||
FRAMES |