TYPO3\CMS\Core\Cache\Frontend\VariableFrontend Class Reference

Inheritance diagram for TYPO3\CMS\Core\Cache\Frontend\VariableFrontend:

Public Member Functions
	initializeObject ()
	set ($entryIdentifier, $variable, array $tags=array(), $lifetime=NULL)
	get ($entryIdentifier)
	getByTag ($tag)
Public Member Functions inherited from TYPO3\CMS\Core\Cache\Frontend\AbstractFrontend
	__construct ($identifier, \TYPO3\CMS\Core\Cache\Backend\BackendInterface $backend)
	getIdentifier ()
	getBackend ()
	has ($entryIdentifier)
	remove ($entryIdentifier)
	flush ()
	flushByTag ($tag)
	collectGarbage ()
	isValidEntryIdentifier ($identifier)
	isValidTag ($tag)

Protected Attributes
	$useIgBinary = FALSE
Protected Attributes inherited from TYPO3\CMS\Core\Cache\Frontend\AbstractFrontend
	$identifier
	$backend

Additional Inherited Members
Public Attributes inherited from TYPO3\CMS\Core\Cache\Frontend\FrontendInterface
const	TAG_CLASS = '%CLASS%'
const	TAG_PACKAGE = '%PACKAGE%'
const	PATTERN_ENTRYIDENTIFIER = '/^[a-zA-Z0-9_%\\-&]{1,250}$/'
const	PATTERN_TAG = '/^[a-zA-Z0-9_%\\-&]{1,250}$/'

Detailed Description

This file is part of the TYPO3 CMS project.

It is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, either version 2 of the License, or any later version.

For the full copyright and license information, please read the LICENSE.txt file that was distributed with this source code.

The TYPO3 project - inspiring people to share! A cache frontend for any kinds of PHP variables

This file is a backport from FLOW3

Author

Robert Lemke rober.nosp@m.t@ty.nosp@m.po3.o.nosp@m.rg

Karsten Dambekalns karst.nosp@m.en@t.nosp@m.ypo3..nosp@m.org

Definition at line 25 of file VariableFrontend.php.

Member Function Documentation

get()

TYPO3\CMS\Core\Cache\Frontend\VariableFrontend::get

(

$entryIdentifier

)

Finds and returns a variable value from the cache.

Parameters

string

$entryIdentifier

Identifier of the cache entry to fetch

Returns

mixed The value

Exceptions

Implements TYPO3\CMS\Core\Cache\Frontend\FrontendInterface.

Definition at line 91 of file VariableFrontend.php.

References TYPO3\CMS\Core\Cache\Frontend\AbstractFrontend\isValidEntryIdentifier().

getByTag()

TYPO3\CMS\Core\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

Exceptions

Implements TYPO3\CMS\Core\Cache\Frontend\FrontendInterface.

Definition at line 111 of file VariableFrontend.php.

References TYPO3\CMS\Core\Cache\Frontend\AbstractFrontend\$identifier, and TYPO3\CMS\Core\Cache\Frontend\AbstractFrontend\isValidTag().

initializeObject()

TYPO3\CMS\Core\Cache\Frontend\VariableFrontend::initializeObject

(

)

Initializes this cache frontend

Returns

void

Definition at line 40 of file VariableFrontend.php.

set()

TYPO3\CMS\Core\Cache\Frontend\VariableFrontend::set	(		$entryIdentifier,
			$variable,
		array	$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

Exceptions

Implements TYPO3\CMS\Core\Cache\Frontend\FrontendInterface.

Definition at line 56 of file VariableFrontend.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\callUserFunction(), TYPO3\CMS\Core\Cache\Frontend\AbstractFrontend\isValidEntryIdentifier(), and TYPO3\CMS\Core\Cache\Frontend\AbstractFrontend\isValidTag().

Member Data Documentation

$useIgBinary

TYPO3\CMS\Core\Cache\Frontend\VariableFrontend::$useIgBinary = FALSE

protected

Definition at line 33 of file VariableFrontend.php.