TYPO3\CMS\Core\Cache\Backend\BackendInterface Interface Reference

Inheritance diagram for TYPO3\CMS\Core\Cache\Backend\BackendInterface:

Public Member Functions
	setCache (FrontendInterface $cache)
	set ($entryIdentifier, $data, array $tags=[], $lifetime=null)
mixed	get ($entryIdentifier)
bool	has ($entryIdentifier)
bool	remove ($entryIdentifier)
	flush ()
	collectGarbage ()

Detailed Description

A contract for a Cache Backend

Definition at line 24 of file BackendInterface.php.

Member Function Documentation

collectGarbage()

TYPO3\CMS\Core\Cache\Backend\BackendInterface::collectGarbage

(

)

Does garbage collection

Implemented in TYPO3\CMS\Core\Cache\Backend\RedisBackend, TYPO3\CMS\Core\Cache\Backend\MemcachedBackend, TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend, TYPO3\CMS\Core\Cache\Backend\SimpleFileBackend, TYPO3\CMS\Core\Cache\Backend\FileBackend, TYPO3\CMS\Core\Cache\Backend\ApcuBackend, TYPO3\CMS\Core\Cache\Backend\TransientMemoryBackend, TYPO3\CMS\Core\Cache\Backend\NullBackend, TYPO3\CMS\Core\Tests\Unit\Cache\Backend\Fixtures\ConcreteBackendFixture, and TYPO3\CMS\Core\Tests\Unit\Cache\Fixtures\BackendFixture.

flush()

TYPO3\CMS\Core\Cache\Backend\BackendInterface::flush

(

)

Removes all cache entries of this cache.

Implemented in TYPO3\CMS\Core\Cache\Backend\RedisBackend, TYPO3\CMS\Core\Cache\Backend\MemcachedBackend, TYPO3\CMS\Core\Cache\Backend\SimpleFileBackend, TYPO3\CMS\Core\Cache\Backend\FileBackend, TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend, TYPO3\CMS\Core\Cache\Backend\ApcuBackend, TYPO3\CMS\Core\Cache\Backend\TransientMemoryBackend, TYPO3\CMS\Core\Cache\Backend\NullBackend, TYPO3\CMS\Core\Tests\Unit\Cache\Fixtures\BackendFixture, TYPO3\CMS\Core\Tests\Unit\Cache\Backend\Fixtures\ConcreteBackendFixture, and TYPO3\CMS\Core\DependencyInjection\Cache\ContainerBackend.

get()

mixed TYPO3\CMS\Core\Cache\Backend\BackendInterface::get

(

$entryIdentifier

)

Loads data from the cache.

Parameters

string

$entryIdentifier

‪An identifier which describes the cache entry to load

Returns

‪mixed The cache entry's content as a string or FALSE if the cache entry could not be loaded

Implemented in TYPO3\CMS\Core\Cache\Backend\RedisBackend, TYPO3\CMS\Core\Cache\Backend\MemcachedBackend, TYPO3\CMS\Core\Cache\Backend\SimpleFileBackend, TYPO3\CMS\Core\Cache\Backend\FileBackend, TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend, TYPO3\CMS\Core\Cache\Backend\ApcuBackend, TYPO3\CMS\Core\Cache\Backend\TransientMemoryBackend, TYPO3\CMS\Core\Cache\Backend\NullBackend, TYPO3\CMS\Core\Tests\Unit\Cache\Fixtures\BackendFixture, and TYPO3\CMS\Core\Tests\Unit\Cache\Backend\Fixtures\ConcreteBackendFixture.

has()

bool TYPO3\CMS\Core\Cache\Backend\BackendInterface::has

(

$entryIdentifier

)

Checks if a cache entry with the specified identifier exists.

Parameters

string

$entryIdentifier

‪An identifier specifying the cache entry

Returns

‪bool TRUE if such an entry exists, FALSE if not

Implemented in TYPO3\CMS\Core\Cache\Backend\RedisBackend, TYPO3\CMS\Core\Cache\Backend\MemcachedBackend, TYPO3\CMS\Core\Cache\Backend\SimpleFileBackend, TYPO3\CMS\Core\Cache\Backend\FileBackend, TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend, TYPO3\CMS\Core\Cache\Backend\ApcuBackend, TYPO3\CMS\Core\Cache\Backend\TransientMemoryBackend, TYPO3\CMS\Core\Cache\Backend\NullBackend, TYPO3\CMS\Core\Tests\Unit\Cache\Fixtures\BackendFixture, and TYPO3\CMS\Core\Tests\Unit\Cache\Backend\Fixtures\ConcreteBackendFixture.

remove()

bool TYPO3\CMS\Core\Cache\Backend\BackendInterface::remove

(

$entryIdentifier

)

Removes all cache entries matching the specified identifier. Usually this only affects one entry but if - for what reason ever - old entries for the identifier still exist, they are removed as well.

Parameters

string

$entryIdentifier

‪Specifies the cache entry to remove

Returns

‪bool TRUE if (at least) an entry could be removed or FALSE if no entry was found

Implemented in TYPO3\CMS\Core\Cache\Backend\RedisBackend, TYPO3\CMS\Core\Cache\Backend\MemcachedBackend, TYPO3\CMS\Core\Cache\Backend\SimpleFileBackend, TYPO3\CMS\Core\Cache\Backend\FileBackend, TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend, TYPO3\CMS\Core\Cache\Backend\ApcuBackend, TYPO3\CMS\Core\Cache\Backend\TransientMemoryBackend, TYPO3\CMS\Core\Cache\Backend\NullBackend, TYPO3\CMS\Core\Tests\Unit\Cache\Fixtures\BackendFixture, and TYPO3\CMS\Core\Tests\Unit\Cache\Backend\Fixtures\ConcreteBackendFixture.

set()

TYPO3\CMS\Core\Cache\Backend\BackendInterface::set	(		$entryIdentifier,
			$data,
		array	$tags = [],
			$lifetime = null
	)

Saves data in the cache.

Parameters

string	$entryIdentifier	‪An identifier for this specific cache entry
string	$data	‪The data to be stored
array	$tags	‪Tags to associate with this cache entry. If the backend does not support tags, this option can be ignored.
int	$lifetime	‪Lifetime of this cache entry in seconds. If NULL is specified, the default lifetime is used. "0" means unlimited lifetime.

Exceptions

Implemented in TYPO3\CMS\Core\Cache\Backend\RedisBackend, TYPO3\CMS\Core\Cache\Backend\MemcachedBackend, TYPO3\CMS\Core\Cache\Backend\SimpleFileBackend, TYPO3\CMS\Core\Cache\Backend\FileBackend, TYPO3\CMS\Core\Cache\Backend\ApcuBackend, TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend, TYPO3\CMS\Core\Cache\Backend\TransientMemoryBackend, TYPO3\CMS\Core\DependencyInjection\Cache\ContainerBackend, TYPO3\CMS\Core\Cache\Backend\NullBackend, TYPO3\CMS\Core\Tests\Unit\Cache\Fixtures\BackendFixture, and TYPO3\CMS\Core\Tests\Unit\Cache\Backend\Fixtures\ConcreteBackendFixture.

setCache()

TYPO3\CMS\Core\Cache\Backend\BackendInterface::setCache

(

FrontendInterface

$cache

)

Sets a reference to the cache frontend which uses this backend

Parameters

Cache\Frontend\FrontendInterface

$cache

‪The frontend for this backend

Implemented in TYPO3\CMS\Core\Cache\Backend\MemcachedBackend, TYPO3\CMS\Core\Cache\Backend\FileBackend, TYPO3\CMS\Core\Cache\Backend\AbstractBackend, TYPO3\CMS\Core\Cache\Backend\SimpleFileBackend, TYPO3\CMS\Core\Cache\Backend\ApcuBackend, TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend, and TYPO3\CMS\Core\Tests\Unit\Cache\Fixtures\BackendFixture.

Referenced by TYPO3\CMS\Core\Cache\Frontend\AbstractFrontend\__construct().