TYPO3 CMS  TYPO3_7-6
Public Member Functions | List of all members
TYPO3\CMS\Core\Cache\Backend\BackendInterface Interface Reference
Inheritance diagram for TYPO3\CMS\Core\Cache\Backend\BackendInterface:
TYPO3\CMS\Core\Cache\Backend\AbstractBackend TYPO3\CMS\Core\Cache\Backend\FreezableBackendInterface TYPO3\CMS\Core\Cache\Backend\PhpCapableBackendInterface TYPO3\CMS\Core\Cache\Backend\TaggableBackendInterface TYPO3\CMS\Core\Cache\Backend\TransientBackendInterface TYPO3\CMS\Core\Cache\Backend\ApcBackend TYPO3\CMS\Core\Cache\Backend\ApcuBackend TYPO3\CMS\Core\Cache\Backend\MemcachedBackend TYPO3\CMS\Core\Cache\Backend\NullBackend TYPO3\CMS\Core\Cache\Backend\PdoBackend TYPO3\CMS\Core\Cache\Backend\RedisBackend TYPO3\CMS\Core\Cache\Backend\SimpleFileBackend TYPO3\CMS\Core\Cache\Backend\TransientMemoryBackend TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend TYPO3\CMS\Core\Cache\Backend\WincacheBackend TYPO3\CMS\Core\Cache\Backend\XcacheBackend TYPO3\CMS\Core\Tests\Unit\Cache\Backend\Fixtures\ConcreteBackendFixture TYPO3\CMS\Core\Cache\Backend\FileBackend TYPO3\CMS\Core\Cache\Backend\FileBackend TYPO3\CMS\Core\Cache\Backend\NullBackend TYPO3\CMS\Core\Cache\Backend\SimpleFileBackend TYPO3\CMS\Core\Cache\Backend\ApcBackend TYPO3\CMS\Core\Cache\Backend\ApcuBackend TYPO3\CMS\Core\Cache\Backend\FileBackend TYPO3\CMS\Core\Cache\Backend\MemcachedBackend TYPO3\CMS\Core\Cache\Backend\NullBackend TYPO3\CMS\Core\Cache\Backend\PdoBackend TYPO3\CMS\Core\Cache\Backend\RedisBackend TYPO3\CMS\Core\Cache\Backend\TransientMemoryBackend TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend TYPO3\CMS\Core\Cache\Backend\WincacheBackend TYPO3\CMS\Core\Cache\Backend\XcacheBackend TYPO3\CMS\Core\Cache\Backend\TransientMemoryBackend

Public Member Functions

 setCache (\TYPO3\CMS\Core\Cache\Frontend\FrontendInterface $cache)
 
 set ($entryIdentifier, $data, array $tags=[], $lifetime=null)
 
 get ($entryIdentifier)
 
 has ($entryIdentifier)
 
 remove ($entryIdentifier)
 
 flush ()
 
 collectGarbage ()
 

Detailed Description

A contract for a Cache Backend

Definition at line 21 of file BackendInterface.php.

Member Function Documentation

◆ collectGarbage()

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

Does garbage collection

Returns
void

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\ApcBackend, TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend, TYPO3\CMS\Core\Cache\Backend\XcacheBackend, TYPO3\CMS\Core\Cache\Backend\WincacheBackend, TYPO3\CMS\Core\Cache\Backend\PdoBackend, TYPO3\CMS\Core\Cache\Backend\TransientMemoryBackend, TYPO3\CMS\Core\Cache\Backend\NullBackend, and TYPO3\CMS\Core\Tests\Unit\Cache\Backend\Fixtures\ConcreteBackendFixture.

◆ flush()

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

Removes all cache entries of this cache.

Returns
void

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\ApcBackend, TYPO3\CMS\Core\Cache\Backend\XcacheBackend, TYPO3\CMS\Core\Cache\Backend\PdoBackend, TYPO3\CMS\Core\Cache\Backend\WincacheBackend, TYPO3\CMS\Core\Cache\Backend\TransientMemoryBackend, TYPO3\CMS\Core\Cache\Backend\NullBackend, and TYPO3\CMS\Core\Tests\Unit\Cache\Backend\Fixtures\ConcreteBackendFixture.

◆ get()

TYPO3\CMS\Core\Cache\Backend\BackendInterface::get (   $entryIdentifier)

Loads data from the cache.

Parameters
string$entryIdentifierAn 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\ApcBackend, TYPO3\CMS\Core\Cache\Backend\PdoBackend, TYPO3\CMS\Core\Cache\Backend\XcacheBackend, TYPO3\CMS\Core\Cache\Backend\WincacheBackend, TYPO3\CMS\Core\Cache\Backend\TransientMemoryBackend, TYPO3\CMS\Core\Cache\Backend\NullBackend, and TYPO3\CMS\Core\Tests\Unit\Cache\Backend\Fixtures\ConcreteBackendFixture.

◆ has()

TYPO3\CMS\Core\Cache\Backend\BackendInterface::has (   $entryIdentifier)

Checks if a cache entry with the specified identifier exists.

Parameters
string$entryIdentifierAn 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\ApcBackend, TYPO3\CMS\Core\Cache\Backend\PdoBackend, TYPO3\CMS\Core\Cache\Backend\XcacheBackend, TYPO3\CMS\Core\Cache\Backend\WincacheBackend, TYPO3\CMS\Core\Cache\Backend\TransientMemoryBackend, TYPO3\CMS\Core\Cache\Backend\NullBackend, and TYPO3\CMS\Core\Tests\Unit\Cache\Backend\Fixtures\ConcreteBackendFixture.

◆ remove()

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$entryIdentifierSpecifies 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\ApcBackend, TYPO3\CMS\Core\Cache\Backend\PdoBackend, TYPO3\CMS\Core\Cache\Backend\XcacheBackend, TYPO3\CMS\Core\Cache\Backend\WincacheBackend, TYPO3\CMS\Core\Cache\Backend\TransientMemoryBackend, TYPO3\CMS\Core\Cache\Backend\NullBackend, 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$entryIdentifierAn identifier for this specific cache entry
string$dataThe data to be stored
array$tagsTags to associate with this cache entry. If the backend does not support tags, this option can be ignored.
int$lifetimeLifetime of this cache entry in seconds. If NULL is specified, the default lifetime is used. "0" means unlimited lifetime.
Returns
void
Exceptions

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

◆ setCache()

TYPO3\CMS\Core\Cache\Backend\BackendInterface::setCache ( \TYPO3\CMS\Core\Cache\Frontend\FrontendInterface  $cache)

Sets a reference to the cache frontend which uses this backend

Parameters
\TYPO3\CMS\Core\Cache\Frontend\FrontendInterface$cacheThe frontend for this backend
Returns
void

Implemented in TYPO3\CMS\Core\Cache\Backend\FileBackend, TYPO3\CMS\Core\Cache\Backend\SimpleFileBackend, TYPO3\CMS\Core\Cache\Backend\ApcuBackend, TYPO3\CMS\Core\Cache\Backend\ApcBackend, and TYPO3\CMS\Core\Cache\Backend\AbstractBackend.