Inheritance diagram for t3lib_cache_frontend_AbstractFrontend:

Collaboration diagram for t3lib_cache_frontend_AbstractFrontend:

Public Member Functions
	__construct ($identifier, t3lib_cache_backend_Backend $backend)
	getIdentifier ()
	getBackend ()
	has ($entryIdentifier)
	remove ($entryIdentifier)
	flush ()
	flushByTag ($tag)
	flushByTags (array $tags)
	collectGarbage ()
	getClassTag ($className= '')
	isValidEntryIdentifier ($identifier)
	isValidTag ($tag)
Protected Attributes
	$identifier
	$backend

Detailed Description

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

Constructor & Destructor Documentation

t3lib_cache_frontend_AbstractFrontend::__construct	(	$	identifier,
		t3lib_cache_backend_Backend $	backend
	)

Constructs the cache

Parameters:

string	A identifier which describes this cache
t3lib_cache_backend_Backend	Backend to be used for this cache

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

Exceptions:

InvalidArgumentException if the identifier doesn't match PATTERN_ENTRYIDENTIFIER

Reimplemented in t3lib_cache_frontend_VariableFrontend.

Definition at line 57 of file class.t3lib_cache_frontend_abstractfrontend.php.

References $backend, and $identifier.

Member Function Documentation

t3lib_cache_frontend_AbstractFrontend::collectGarbage ( )

Does garbage collection

Returns:: void

Author:: Karsten Dambekalns <karsten@typo3.org>

Implements t3lib_cache_frontend_Frontend.

Definition at line 171 of file class.t3lib_cache_frontend_abstractfrontend.php.

t3lib_cache_frontend_AbstractFrontend::flush ( )

Removes all cache entries of this cache.

Returns:: void

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

Implements t3lib_cache_frontend_Frontend.

Definition at line 131 of file class.t3lib_cache_frontend_abstractfrontend.php.

t3lib_cache_frontend_AbstractFrontend::flushByTag ( $ tag )

Removes all cache entries of this cache which are tagged by the specified tag.

Parameters:

string $tag The tag the entries must have

Returns:: void

Author:: Robert Lemke <robert@typo3.org>; Karsten Dambekalns <karsten@typo3.org>

Implements t3lib_cache_frontend_Frontend.

Definition at line 143 of file class.t3lib_cache_frontend_abstractfrontend.php.

References isValidTag().

t3lib_cache_frontend_AbstractFrontend::flushByTags ( array $ tags )

Removes all cache entries of this cache which are tagged by the specified tag.

Parameters:

array Array of tags to search for and to remove the cache entries, the "*" wildcard is supported

Returns:: void

Author:: Ingo Renner <ingo@typo3.org>

Implements t3lib_cache_frontend_Frontend.

Definition at line 161 of file class.t3lib_cache_frontend_abstractfrontend.php.

t3lib_cache_frontend_AbstractFrontend::getBackend ( )

Returns the backend used by this cache

Returns:: t3lib_cache_backend_Backend The backend used by this cache

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

Implements t3lib_cache_frontend_Frontend.

Definition at line 83 of file class.t3lib_cache_frontend_abstractfrontend.php.

t3lib_cache_frontend_AbstractFrontend::getClassTag ( $ className = '' )

Renders a tag which can be used to mark a cache entry as "depends on this class". Whenever the specified class is modified, all cache entries tagged with the class are flushed.

If an empty string is specified as class name, the returned tag means "depends on any class".

Parameters:

string The class name