t3lib_cache_frontend_VariableFrontend Class Reference

Inheritance diagram for t3lib_cache_frontend_VariableFrontend:

Collaboration diagram for t3lib_cache_frontend_VariableFrontend:

List of all members.

Public Member Functions
	__construct ($identifier, t3lib_cache_backend_Backend $backend)
	set ($entryIdentifier, $variable, $tags=array(), $lifetime=NULL)
	get ($entryIdentifier)
	getByTag ($tag)
Protected Member Functions
	initializeObject ()
Protected Attributes
	$useIgBinary = FALSE

---

Detailed Description

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

---

Constructor & Destructor Documentation

t3lib_cache_frontend_VariableFrontend::__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 from t3lib_cache_frontend_AbstractFrontend.

Definition at line 54 of file class.t3lib_cache_frontend_variablefrontend.php.

References t3lib_cache_frontend_AbstractFrontend\$identifier, and initializeObject().

---

Member Function Documentation

t3lib_cache_frontend_VariableFrontend::get

(

$

entryIdentifier

)

Loads a variable value from the cache.

Parameters:

string

Identifier of the cache entry to fetch

Returns:

mixed The value

Author:

Robert Lemke <robert@typo3.org>

Exceptions:

t3lib_cache_exception_ClassAlreadyLoaded

if the class already exists

Implements t3lib_cache_frontend_Frontend.

Definition at line 113 of file class.t3lib_cache_frontend_variablefrontend.php.

References t3lib_cache_frontend_AbstractFrontend\isValidEntryIdentifier().

t3lib_cache_frontend_VariableFrontend::getByTag

(

$

tag

)

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

Parameters:

string

$tag

The tag to search for

Returns:

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

Author:

Karsten Dambekalns <karsten@typo3.org>

Implements t3lib_cache_frontend_Frontend.

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

References t3lib_cache_frontend_AbstractFrontend\$identifier, and t3lib_cache_frontend_AbstractFrontend\isValidTag().

t3lib_cache_frontend_VariableFrontend::initializeObject

(

)

[protected]

Initializes this cache frontend

Returns:

void

Author:

Robert Lemke <robert@typo3.org>

Definition at line 65 of file class.t3lib_cache_frontend_variablefrontend.php.

Referenced by __construct().

t3lib_cache_frontend_VariableFrontend::set	(	$	entryIdentifier,
		$	variable,
		$	tags = array(),
		$	lifetime = NULL
	)

Saves the value of a PHP variable in the cache. Note that the variable will be serialized if necessary.

Parameters:

string	$entryIdentifier	An identifier used for this cache entry
mixed	$variable	The variable to cache
array	$tags	Tags to associate with this cache entry
integer	$lifetime	Lifetime of this cache entry in seconds. If NULL is specified, the default lifetime is used. "0" means unlimited liftime.

Returns:

void

Author:

Robert Lemke <robert@typo3.org>

Karsten Dambekalns <karsten@typo3.org>

Implements t3lib_cache_frontend_Frontend.

Definition at line 81 of file class.t3lib_cache_frontend_variablefrontend.php.

References t3lib_cache_frontend_AbstractFrontend\isValidEntryIdentifier(), and t3lib_cache_frontend_AbstractFrontend\isValidTag().

---

Member Data Documentation

t3lib_cache_frontend_VariableFrontend::$useIgBinary = FALSE [protected]

Definition at line 43 of file class.t3lib_cache_frontend_variablefrontend.php.

---

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

• t3lib/cache/frontend/class.t3lib_cache_frontend_variablefrontend.php