lucee.Componentcoldbox.system.cache.AbstractCacheBoxProvider
coldbox.system.cache.providers.CFProvider
coldbox.system.cache.providers.CFColdBoxProvider
Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com --- This CacheBox provider communicates with the built in caches in the Adobe Engine for ColdBox Apps
Constructor Summary | |
---|---|
init()
Constructor. |
Method Summary | |
---|---|
any
|
clearAllEvents([boolean async='false'])
Clears all events from the cache. |
any
|
clearAllViews([boolean async='false'])
Clears all views from the cache. |
any
|
clearEvent(any eventSnippet, [any queryString=''])
Clears all the event permutations from the cache according to snippet and querystring. |
any
|
clearEventMulti(any eventsnippets, [any queryString=''])
Clears all the event permutations from the cache according to the list of snippets and querystrings. |
any
|
clearView(any viewSnippet)
Clears all view name permutations from the cache according to the view name. |
any
|
clearViewMulti(any viewSnippets)
Clears all view name permutations from the cache according to the view name. |
any
|
getColdbox()
Get the coldbox application reference as coldbox. |
any
|
getEventCacheKeyPrefix()
Get the event cache key prefix which is necessary for event caching. |
any
|
getEventURLFacade()
Get the event caching URL facade utility that determines event caching. |
any
|
getViewCacheKeyPrefix()
Get the cached view key prefix which is necessary for view caching. |
any
|
setColdBox(any<Controller> coldbox)
Set the ColdBox linkage into the provider. |
Methods inherited from class lucee.Component |
---|
None |
Constructor Detail |
---|
Constructor
Method Detail |
---|
Clears all events from the cache.
clearAllEvents
in interface
IColdBoxProvider
async
- If implemented, determines async or sync clearing.Clears all views from the cache.
clearAllViews
in interface
IColdBoxProvider
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
clearEvent
in interface
IColdBoxProvider
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
clearEventMulti
in interface
IColdBoxProvider
eventsnippets
queryString
- 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 inClears all view name permutations from the cache according to the view name
clearView
in interface
IColdBoxProvider
viewSnippet
- The view name snippet to purge from the cacheClears all view name permutations from the cache according to the view name.
clearViewMulti
in interface
IColdBoxProvider
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
getColdbox
in interface
IColdBoxProvider
Get the event cache key prefix which is necessary for event caching
getEventCacheKeyPrefix
in interface
IColdBoxProvider
Get the event caching URL facade utility that determines event caching
getEventURLFacade
in interface
IColdBoxProvider
Get the cached view key prefix which is necessary for view caching
getViewCacheKeyPrefix
in interface
IColdBoxProvider
Set the ColdBox linkage into the provider
setColdBox
in interface
IColdBoxProvider
coldbox
- The ColdBox controller