CacheHelper Class

Provides helper methods for caching.

Inheritance Hierarchy

System.Object
  CMS.Base.CoreMethods
    CMS.Base.AbstractHelper
      CMS.Base.AbstractHelper<CacheHelper>
        CMS.Helpers.CacheHelper

Namespace: CMS.Helpers
Assembly: CMS.Helpers (in CMS.Helpers.dll) Version: 13.0.131

Syntax

public class CacheHelper : AbstractHelper<CacheHelper>

The CacheHelper type exposes the following members.

Constructors

	Name	Description
Public method	CacheHelper

Fields

	Name	Description
Public field Static member	API_CACHE_MINUTES	Cache minutes for caching the system data in API. 1 hour by default
Public field Static member	CSS_KEY	CSS caching key.
Public field Static member	DEFAULT_CACHE_DEPENDENCIES	Default cache dependencies constant.
Public field Static member	DefaultCacheItemPriority	Cache item priority.
Public field Static member	DUMMY_KEY	Dummy item.
Public field Static member	FILENODE_KEY	File node caching key.
Public field Static member	FULLPAGE_KEY	Obsolete. Full page caching key.
Public field Static member	MACRO_KEY	Macro cache key.
Public field Static member	NO_CACHE_DEPENDENCIES	No cache dependencies constant.
Public field Static member	SEPARATOR	Cache item separator.

Properties

	Name	Description
Public property Static member	AllowCacheByCulture	If true, the cache allows separate keys by culture.
Public property Static member	AllowCacheByUserName	If true, the cache allows separate keys by user name.
Public property Static member	AlwaysCacheFiles	Gets if files are always cached on client, even outside the live site.
Public property Static member	AlwaysCacheResources	Gets if resources are always cached on client, even outside the live site.
Public property Static member	BaseCacheKey	Returns the base cache key (created with all parameters considered to be valid for proper caching).
Public property Static member	ClientCacheRequested	Gets if the client specified cache settings in request.
Public property Static member	CurrentCachePrefix	Current context name
Public property Static member	DependencyChanged	DependencyChanged items count (removed by the dependency).
Public property Static member	Expired	Expired items count (removed by the system for expiration reasons).
Public property Static member	MultiplePrefixesUsed	If true, multiple cache prefixes were used
Public property Static member	PhysicalFilesCacheMinutes	Gets the expiration time in minutes that should be set for the physical files in the client cache.
Public property Static member	ProgressiveCaching	If true, progressive caching is enabled, meaning that two threads accessing the same code share the result of an internal operation. True by default.
Public property Static member	Removed	Removed items count (removed correctly by the system).
Public property Static member	Underused	Underused items count (removed sooner for memory reasons).

Methods

	Name	Description
Public method Static member	Add(String, Object, CMSCacheDependency, DateTime, TimeSpan)	Mirror to Cache.Add().
Public method Static member	Add(String, Object, CMSCacheDependency, DateTime, TimeSpan, CMSCacheItemPriority, CMSCacheItemRemovedCallback, Boolean)	Mirror to Cache.Add().
Protected method	AddInternal	Mirror to Cache.Add().
Public method Static member	BuildCacheItemName	Builds the cache item name from the given parts
Public method Static member	Cache<TData>(Func<TData>, CacheSettings)	Wraps the operation to a cached section. This method supports progressive caching and is able to distribute unhandled exceptions to other simultaneously running threads.
Public method Static member	Cache<TData>(Func<CacheSettings, TData>, CacheSettings)	Wraps the operation to a cached section. This method supports progressive caching and is able to distribute unhandled exceptions to other simultaneously running threads.
Public method Static member	CacheAsync<TData>(Func<Task<TData>>, CacheSettings)	Asynchronously loads data. If multiple threads are loading the same data, only one thread executes the load, stores the result into cache and the result is distributed to other waiting threads. If an exception is thrown during loadMethodAsync execution, the exception is distributed as well. No data are cached in such a case.
Public method Static member	CacheAsync<TData>(Func<CacheSettings, Task<TData>>, CacheSettings)	Asynchronously loads data. If multiple threads are loading the same data, only one thread executes the load, stores the result into cache and the result is distributed to other waiting threads. If an exception is thrown during loadMethodAsync execution, the exception is distributed as well. No data are cached in such a case.
Public method Static member	CacheAsync<TData>(Func<CancellationToken, Task<TData>>, CacheSettings, CancellationToken)	Asynchronously loads data. If multiple threads are loading the same data, only one thread executes the load, stores the result into cache and the result is distributed to other waiting threads. If an exception is thrown during loadMethodAsync execution, the exception is distributed as well. No data are cached in such a case.
Public method Static member	CacheAsync<TData>(Func<CacheSettings, CancellationToken, Task<TData>>, CacheSettings, CancellationToken)	Asynchronously loads data. If multiple threads are loading the same data, only one thread executes the load, stores the result into cache and the result is distributed to other waiting threads. If an exception is thrown during loadMethodAsync execution, the exception is distributed as well. No data are cached in such a case.
Public method Static member	CacheEnabled	Returns true if the content caching is enabled.
Public method Static member	CacheImageAllowed	Checks if the file attachment is below the maximum file size used for caching.
Public method Static member	CacheImageEnabled	Returns true if the image caching is enabled.
Public method Static member	CacheImageMinutes	Cache image minutes.
Public method Static member	CacheMinutes	Cache content minutes.
Public method Static member	ClearCache()	Clears the entire system cache.
Public method Static member	ClearCache(String, Boolean, Boolean)	Clears the cache content starting with given string. Clears also full page cache (including persistent) when called on website.
Public method Static member	ClearCSSCache	Clear the CSS cache
Public method Static member	ClearFileNodeCache	Clear the cache for the file document nodes.
Public method Static member	ClearFullPageCache	Obsolete. Clear the full page cache (output cache) of the pages.
Protected method	ClearFullPageCacheInternal	Obsolete. Clear the full page cache (output cache) of the pages.
Public method Static member	ClientCacheMinutes	Client cache minutes for the processed content (both files and pages).
Public method Static member	CompactCache	Tries to remove the specified percentage of items from the underlying cache. The return value indicates whether compacting was performed (i.e. whether the underlying cache supports compacting).
Protected method	CreateCacheDependencyInternal	Creates the cache dependency with specified parameters
Public method Static member	EnsureDummyKey	Ensures the dummy key with the given name
Public method Static member	EnsureKey	Ensures the specified cache key.
Public method Static member	GetBaseCacheKey	Returns the base cache key (created with all parameters considered to be valid for proper caching).
Public method Static member	GetCacheDependencies	Processes the dependencies string. Returns default dependencies if the source is null or empty. If source is NO_CACHE_DEPENDENCY constant, then method also returns this constant. When source is specified and contains DEFAULT_CACHE_DEPENDENCIES constant, then this constant indicates that default dependencies should be appended to the source. The DEFAULT_CACHE_DEPENDENCIES also remains in the string so other processes can insert their default dependencies.
Public method Static member	GetCacheDependency(ICollection<String>)	Creates the cache dependency from the given keys.
Public method Static member	GetCacheDependency(String)	Creates the cache dependency from the given keys.
Public method Static member	GetCacheDependency(String[])	Creates the cache dependency from the given keys.
Public method Static member	GetCacheDependency(List<String>, ICollection<String>)	Creates the cache dependency from the given keys.
Public method Static member	GetCacheDependency(String[], String[])	Creates the cache dependency from the given keys.
Public method Static member	GetCacheItemName(String, Object[])	Gets the cache item string.
Public method Static member	GetCacheItemName(Boolean, String, Object[])	Gets the cache item string.
Public method Static member	GetCacheItemRows	Creates a list of all cache items to display in the Debug application.
Public method Static member	GetCacheItemsString	Gets the cache items string (item names separated by semicolon)
Public method Static member	GetCombinedCacheItems	Gets combined cache items for setting and default items
Public method Static member	GetCultureCacheKey()	Gets the cache key for current culture
Public method Static member	GetCultureCacheKey(String)	Gets the cache key for the given culture
Public method Static member	GetDependencyCacheKeys	Parses the string and returns the array of the cache dependency keys.
Protected method	GetEnumeratorInternal	Gets the enumerator for the cache items.
Public method Static member	GetFileCacheDependency	Creates the cache dependency from the given file path.
Public method Static member	GetFullKey	Gets the full cache key with the prefix
Protected method	GetFullKeyInternal	Gets the full cache key with the prefix
Public method Static member	GetInnerValue	Gets the inner value for the cache item
Protected method	GetInternal	Gets the item from the cache.
Public method Static member	GetItem	Gets item from cache.
Public method Static member	GetUserCacheKey()	Gets the cache key for current user
Public method Static member	GetUserCacheKey(String)	Gets the cache key for current user the given user
Protected method	InsertInternal	Inserts the item into the cache.
Public method Static member	MaxCacheFileSize	Maximum size of the file that is allowed to be cached in kilobytes.
Public method Static member	RegisterAutomaticCallback	Obsolete. Registers the automatic callback that is executed at the specific time
Public method Static member	RegisterDependencyCallback<TTarget>	Registers a cache callback for given list of cache dependencies
Public method Static member	Remove	Removes object from cache.
Public method Static member	RemoveDependencyCallback	Registers a cache callback for given list of cache dependencies
Protected method	RemoveInternal	Removes the item from the cache.
Public method Static member	RevalidateClientCache	Returns whether the client cache should be revalidated by the call to the server.
Public method	SetAsDefaultHelper	Sets this object as the default helper (Inherited from AbstractHelper<HelperType>.)
Public method Static member	TouchKey(String)	Touches the cache key to drop the dependencies.
Public method Static member	TouchKey(String, Boolean, Boolean)	Touches the cache key to drop the dependencies.
Public method Static member	TouchKey(String, Boolean, Boolean, DateTime)	Touches the cache key to drop the dependencies.
Public method Static member	TouchKey(String, Boolean, Boolean, DateTime, Boolean)	Touches the cache key to drop the dependencies.
Protected method	TouchKeyInternal	Touches the cache key to drop the dependencies.
Public method Static member	TouchKeys(IEnumerable<String>)	Touches the cache key to drop the dependencies.
Public method Static member	TouchKeys(IEnumerable<String>, Boolean, Boolean)	Touches the cache key to drop the dependencies.
Public method Static member	TouchKeys(String, Boolean, Boolean)	Touches the cache keys separated by new line to drop the dependencies.
Protected method	TouchKeysInternal	Touches the cache key to drop the dependencies.
Public method Static member	TryGetItem(String, Object)	Returns true if the cache contains the item with specified key.
Public method Static member	TryGetItem(String, Boolean, Object)	Returns true if the cache contains the item with specified key.
Public method Static member	TryGetItem<OutputType>(String, OutputType)	Returns true if the cache contains the item with specified key.
Public method Static member	TryGetItem<OutputType>(String, Boolean, OutputType, Boolean)	Returns true if the cache contains the item with specified key.