coldbox.system.cache.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. |
Method Detail |
---|
Clears all events from the cache.
async
- Run command asynchronously or notClears all views from the cache.
async
- Run command asynchronously or notClears all the event permutations from the cache according to snippet and querystring. Be careful when using incomplete event name with query strings as partial event names are not guaranteed to match with query string permutations
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 purposesClears all the event permutations from the cache according to the list of snippets and querystrings. Be careful when using incomplete event name with query strings as partial event names are not guaranteed to match with query string permutations
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.Clears all view name permutations from the cache according to the view name.
viewSnippet
- The view name snippet to purge from the cacheClears all view name permutations from the cache according to the view name.
viewSnippets
- The comma-delimmitted list or array of view snippet to clear on. Can be partial or fullGet the coldbox application reference as coldbox.system.web.Controller
Get the event cache key prefix
Get the event caching URL facade utility
Get the cached view key prefix
Set the coldbox application reference
coldbox
- The coldbox application reference as type: coldbox.system.web.Controller