t3lib_cache_Manager Class Reference

Inheritance diagram for t3lib_cache_Manager:

Inheritance graph
[legend]
Collaboration diagram for t3lib_cache_Manager:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 setCacheConfigurations (array $cacheConfigurations)
 setCacheFactory (t3lib_cache_Factory $cacheFactory)
 initialize ()
 registerCache (t3lib_cache_frontend_Frontend $cache)
 getCache ($identifier)
 hasCache ($identifier)
 flushCaches ()
 flushCachesByTag ($tag)

Protected Attributes

 $cacheFactory
 $caches = array()
 $cacheConfigurations = array()

Detailed Description

Definition at line 36 of file class.t3lib_cache_manager.php.


Member Function Documentation

t3lib_cache_Manager::flushCaches (  ) 

Flushes all registered caches

Returns:
void
Author:
Robert Lemke <robert@typo3.org>

Definition at line 167 of file class.t3lib_cache_manager.php.

t3lib_cache_Manager::flushCachesByTag ( tag  ) 

Flushes entries tagged by the specified tag of all registered caches.

Parameters:
string Tag to search for
Returns:
void
Author:
Robert Lemke <robert@typo3.org>

Definition at line 181 of file class.t3lib_cache_manager.php.

t3lib_cache_Manager::getCache ( identifier  ) 

Returns the cache specified by $identifier

Parameters:
string Identifies which cache to return
Returns:
t3lib_cache_frontend_Cache The specified cache frontend
Exceptions:
t3lib_cache_exception_NoSuchCache 
Author:
Robert Lemke <robert@typo3.org>

Definition at line 139 of file class.t3lib_cache_manager.php.

t3lib_cache_Manager::hasCache ( identifier  ) 

Checks if the specified cache has been registered.

Parameters:
string The identifier of the cache
Returns:
boolean TRUE if a cache with the given identifier exists, otherwise FALSE
Author:
Robert Lemke <robert@typo3.org>

Definition at line 157 of file class.t3lib_cache_manager.php.

t3lib_cache_Manager::initialize (  ) 

Initializes the cache manager

Returns:
void
Author:
Robert Lemke <robert@typo3.org>

Definition at line 99 of file class.t3lib_cache_manager.php.

t3lib_cache_Manager::registerCache ( t3lib_cache_frontend_Frontend cache  ) 

Registers a cache so it can be retrieved at a later point.

Parameters:
t3lib_cache_frontend_Frontend The cache frontend to be registered
Returns:
void
Exceptions:
t3lib_cache_exception_DuplicateIdentifier if a cache with the given identifier has already been registered.
Author:
Robert Lemke <robert@typo3.org>

Definition at line 118 of file class.t3lib_cache_manager.php.

References t3lib_cache_frontend_Frontend::getIdentifier().

t3lib_cache_Manager::setCacheConfigurations ( array $  cacheConfigurations  ) 

Sets configurations for caches. The key of each entry specifies the cache identifier and the value is an array of configuration options. Possible options are:

frontend backend backendOptions

If one of the options is not specified, the default value is assumed. Existing cache configurations are preserved.

Parameters:
array The cache configurations to set
Returns:
void
Author:
Robert Lemke <robert@typo3.org>

Definition at line 69 of file class.t3lib_cache_manager.php.

t3lib_cache_Manager::setCacheFactory ( t3lib_cache_Factory cacheFactory  ) 

Injects the cache factory

Parameters:
t3lib_cache_Factory The cache factory
Returns:
void
Author:
Robert Lemke <robert@typo3.org>

Ingo Renner <ingo@typo3.org>

Definition at line 87 of file class.t3lib_cache_manager.php.

References $cacheFactory.


Member Data Documentation

t3lib_cache_Manager::$cacheConfigurations = array() [protected]

Definition at line 50 of file class.t3lib_cache_manager.php.

t3lib_cache_Manager::$cacheFactory [protected]

Definition at line 40 of file class.t3lib_cache_manager.php.

Referenced by setCacheFactory().

t3lib_cache_Manager::$caches = array() [protected]

Definition at line 45 of file class.t3lib_cache_manager.php.


The documentation for this class was generated from the following file:
Generated on Sat Sep 4 04:18:18 2010 for TYPO3 API by  doxygen 1.4.7