t3lib_cache_frontend_Frontend Interface Reference

Inheritance diagram for t3lib_cache_frontend_Frontend:

[legend]List of all members.

Public Member Functions
	getIdentifier ()
	getBackend ()
	set ($entryIdentifier, $data, $tags=array(), $lifetime=NULL)
	get ($entryIdentifier)
	getByTag ($tag)
	has ($entryIdentifier)
	remove ($entryIdentifier)
	flush ()
	flushByTag ($tag)
	flushByTags (array $tags)
	collectGarbage ()
	isValidEntryIdentifier ($identifier)
	isValidTag ($tag)
Public Attributes
const	TAG_CLASS = '%CLASS%'
const	PATTERN_ENTRYIDENTIFIER = '/^[a-zA-Z0-9_%\-&]{1,250}$/'
const	PATTERN_TAG = '/^[a-zA-Z0-9_%\-&]{1,250}$/'

---

Detailed Description

Definition at line 37 of file interface.t3lib_cache_frontend_frontend.php.

---

Member Function Documentation

t3lib_cache_frontend_Frontend::collectGarbage

(

)

Does garbage collection

Returns:

void

Implemented in t3lib_cache_frontend_AbstractFrontend.

t3lib_cache_frontend_Frontend::flush

(

)

Removes all cache entries of this cache.

Returns:

void

Implemented in t3lib_cache_frontend_AbstractFrontend.

t3lib_cache_frontend_Frontend::flushByTag

(

$

tag

)

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

Parameters:

string

The tag the entries must have

Returns:

void

Implemented in t3lib_cache_frontend_AbstractFrontend.

t3lib_cache_frontend_Frontend::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>

Implemented in t3lib_cache_frontend_AbstractFrontend.

t3lib_cache_frontend_Frontend::get

(

$

entryIdentifier

)

Finds and returns data from the cache.

Parameters:

string

Something which identifies the cache entry - depends on concrete cache

Returns:

mixed

Implemented in t3lib_cache_frontend_StringFrontend, and t3lib_cache_frontend_VariableFrontend.

t3lib_cache_frontend_Frontend::getBackend

(

)

Returns the backend used by this cache

Returns:

t3lib_cache_backend_Backend The backend used by this cache

Implemented in t3lib_cache_frontend_AbstractFrontend.

t3lib_cache_frontend_Frontend::getByTag

(

$

tag

)

Finds and returns all cache entries which are tagged by the specified tag.

Parameters:

string

The tag to search for

Returns:

array An array with the content of all matching entries. An empty array if no entries matched

Implemented in t3lib_cache_frontend_StringFrontend, and t3lib_cache_frontend_VariableFrontend.

t3lib_cache_frontend_Frontend::getIdentifier

(

)

Returns this cache's identifier

Returns:

string The identifier for this cache

Implemented in t3lib_cache_frontend_AbstractFrontend.

Referenced by t3lib_cache_Manager::registerCache().

t3lib_cache_frontend_Frontend::has

(

$

entryIdentifier

)

Checks if a cache entry with the specified identifier exists.

Parameters:

string

An identifier specifying the cache entry

Returns:

boolean TRUE if such an entry exists, FALSE if not

Implemented in t3lib_cache_frontend_AbstractFrontend.

t3lib_cache_frontend_Frontend::isValidEntryIdentifier

(

$

identifier

)

Checks the validity of an entry identifier. Returns true if it's valid.

Parameters:

string

$identifier An identifier to be checked for validity

Returns:

boolean

Implemented in t3lib_cache_frontend_AbstractFrontend.

t3lib_cache_frontend_Frontend::isValidTag

(

$

tag

)

Checks the validity of a tag. Returns true if it's valid.

Parameters:

string

$tag A tag to be checked for validity

Returns:

boolean

Implemented in t3lib_cache_frontend_AbstractFrontend.

t3lib_cache_frontend_Frontend::remove

(

$

entryIdentifier

)

Removes the given cache entry from the cache.

Parameters:

string

An identifier specifying the cache entry

Returns:

boolean TRUE if such an entry exists, FALSE if not

Implemented in t3lib_cache_frontend_AbstractFrontend.

t3lib_cache_frontend_Frontend::set	(	$	entryIdentifier,
		$	data,
		$	tags = array(),
		$	lifetime = NULL
	)

Saves data in the cache.

Parameters:

	string	Something which identifies the data - depends on concrete cache
	mixed	The data to cache - also depends on the concrete cache implementation
	array	Tags to associate with this cache entry
	integer	Lifetime of this cache entry in seconds. If NULL is specified, the default lifetime is used. "0" means unlimited liftime.

Returns:

void

Implemented in t3lib_cache_frontend_PhpFrontend, t3lib_cache_frontend_StringFrontend, and t3lib_cache_frontend_VariableFrontend.

---

Member Data Documentation

const t3lib_cache_frontend_Frontend::PATTERN_ENTRYIDENTIFIER = '/^[a-zA-Z0-9_%\-&]{1,250}$/'

Pattern an entry identifer must match.

Definition at line 47 of file interface.t3lib_cache_frontend_frontend.php.

const t3lib_cache_frontend_Frontend::PATTERN_TAG = '/^[a-zA-Z0-9_%\-&]{1,250}$/'

Pattern a tag must match.

Definition at line 52 of file interface.t3lib_cache_frontend_frontend.php.

const t3lib_cache_frontend_Frontend::TAG_CLASS = '%CLASS%'

"Magic" tag for class-related entries

Definition at line 42 of file interface.t3lib_cache_frontend_frontend.php.

---

The documentation for this interface was generated from the following file:

• t3lib/cache/frontend/interfaces/interface.t3lib_cache_frontend_frontend.php

---