TYPO3  7.6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ApcBackend Class Reference
Inheritance diagram for ApcBackend:
AbstractBackend TaggableBackendInterface BackendInterface BackendInterface

Public Member Functions

 __construct ($context, array $options=array())
 
 setCache (\TYPO3\CMS\Core\Cache\Frontend\FrontendInterface $cache)
 
 set ($entryIdentifier, $data, array $tags=array(), $lifetime=null)
 
 get ($entryIdentifier)
 
 has ($entryIdentifier)
 
 remove ($entryIdentifier)
 
 findIdentifiersByTag ($tag)
 
 flush ()
 
 flushByTag ($tag)
 
 collectGarbage ()
 
- Public Member Functions inherited from AbstractBackend
 __construct ($context, array $options=array())
 
 setCache (\TYPO3\CMS\Core\Cache\Frontend\FrontendInterface $cache)
 
 setDefaultLifetime ($defaultLifetime)
 

Protected Member Functions

 setIdentifierPrefix ($identifierPrefix)
 
 getIdentifierPrefix ()
 
 getCurrentUserData ()
 
 getPathSite ()
 
 findTagsByIdentifier ($identifier)
 
 addIdentifierToTags ($entryIdentifier, array $tags)
 
 removeIdentifierFromAllTags ($entryIdentifier)
 
- Protected Member Functions inherited from AbstractBackend
 calculateExpiryTime ($lifetime=null)
 

Protected Attributes

 $identifierPrefix
 
- Protected Attributes inherited from AbstractBackend
 $cache
 
 $cacheIdentifier
 
 $context
 
 $defaultLifetime = 3600
 

Additional Inherited Members

- Public Attributes inherited from AbstractBackend
const DATETIME_EXPIRYTIME_UNLIMITED = '9999-12-31T23:59:59+0000'
 
const UNLIMITED_LIFETIME = 0
 

Detailed Description

A caching backend which stores cache entries by using APC.

This backend uses the following types of keys:

Each key is prepended with a prefix. By default prefix consists from two parts separated by underscore character and ends in yet another underscore character:

This file is a backport from FLOW3

Definition at line 40 of file ApcBackend.php.

Constructor & Destructor Documentation

__construct (   $context,
array  $options = array() 
)

Constructs this backend

Parameters
string$contextFLOW3's application context
array$optionsConfiguration options - unused here
Exceptions
\TYPO3\CMS\Core\Cache\Exception

Definition at line 76 of file ApcBackend.php.

References AbstractBackend\$context.

Member Function Documentation

addIdentifierToTags (   $entryIdentifier,
array  $tags 
)
protected

Associates the identifier with the given tags

Parameters
string$entryIdentifier
array$tags
Returns
void

Definition at line 266 of file ApcBackend.php.

References ApcBackend\findIdentifiersByTag(), ApcBackend\findTagsByIdentifier(), and ApcBackend\getIdentifierPrefix().

Referenced by ApcBackend\set().

collectGarbage ( )

Does nothing, as APC does GC itself

Returns
void

Implements BackendInterface.

Definition at line 328 of file ApcBackend.php.

findIdentifiersByTag (   $tag)

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

Parameters
string$tagThe tag to search for
Returns
array An array with identifiers of all matching entries. An empty array if no entries matched

Implements TaggableBackendInterface.

Definition at line 204 of file ApcBackend.php.

References ApcBackend\getIdentifierPrefix().

Referenced by ApcBackend\addIdentifierToTags(), ApcBackend\flushByTag(), and ApcBackend\removeIdentifierFromAllTags().

findTagsByIdentifier (   $identifier)
protected

Finds all tags for the given identifier. This function uses reverse tag index to search for tags.

Parameters
string$identifierIdentifier to find tags by
Returns
array Array with tags

Definition at line 222 of file ApcBackend.php.

References ApcBackend\getIdentifierPrefix().

Referenced by ApcBackend\addIdentifierToTags(), and ApcBackend\removeIdentifierFromAllTags().

flush ( )

Removes all cache entries of this cache.

Returns
void
Exceptions
\TYPO3\CMS\Core\Cache\Exception

Implements BackendInterface.

Definition at line 236 of file ApcBackend.php.

References ApcBackend\flushByTag().

flushByTag (   $tag)

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

Parameters
string$tagThe tag the entries must have
Returns
void

Implements TaggableBackendInterface.

Definition at line 251 of file ApcBackend.php.

References ApcBackend\findIdentifiersByTag().

Referenced by ApcBackend\flush().

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

Implements BackendInterface.

Definition at line 160 of file ApcBackend.php.

References ApcBackend\getIdentifierPrefix().

getCurrentUserData ( )
protected

Returns the current user data with posix_getpwuid or a default structure when posix_getpwuid is not available.

Returns
array

Definition at line 107 of file ApcBackend.php.

Referenced by ApcBackend\setCache().

getIdentifierPrefix ( )
protected
getPathSite ( )
protected

Returns the PATH_site constant.

Returns
string

Definition at line 117 of file ApcBackend.php.

Referenced by ApcBackend\setCache().

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

Implements BackendInterface.

Definition at line 174 of file ApcBackend.php.

References ApcBackend\getIdentifierPrefix().

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

Implements BackendInterface.

Definition at line 190 of file ApcBackend.php.

References ApcBackend\getIdentifierPrefix(), and ApcBackend\removeIdentifierFromAllTags().

removeIdentifierFromAllTags (   $entryIdentifier)
protected

Removes association of the identifier with the given tags

Parameters
string$entryIdentifier
Returns
void

Definition at line 298 of file ApcBackend.php.

References ApcBackend\findIdentifiersByTag(), ApcBackend\findTagsByIdentifier(), and ApcBackend\getIdentifierPrefix().

Referenced by ApcBackend\remove(), and ApcBackend\set().

set (   $entryIdentifier,
  $data,
array  $tags = array(),
  $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
int$lifetimeLifetime of this cache entry in seconds. If NULL is specified, the default lifetime is used. "0" means unlimited liftime.
Returns
void
Exceptions
\TYPO3\CMS\Core\Cache\Exceptionif no cache frontend has been set.
\TYPO3\CMS\Core\Cache\Exception\InvalidDataExceptionif $data is not a string

Implements BackendInterface.

Definition at line 134 of file ApcBackend.php.

References AbstractBackend\$cacheIdentifier, AbstractBackend\$defaultLifetime, ApcBackend\addIdentifierToTags(), ApcBackend\getIdentifierPrefix(), and ApcBackend\removeIdentifierFromAllTags().

Initializes the identifier prefix when setting the cache.

Parameters
\TYPO3\CMS\Core\Cache\Frontend\FrontendInterface$cache
Returns
void

Implements BackendInterface.

Definition at line 93 of file ApcBackend.php.

References ApcBackend\getCurrentUserData(), ApcBackend\getPathSite(), and ApcBackend\setIdentifierPrefix().

setIdentifierPrefix (   $identifierPrefix)
protected

Set the cache identifier prefix.

Parameters
string$identifierPrefix

Definition at line 54 of file ApcBackend.php.

References ApcBackend\$identifierPrefix.

Referenced by ApcBackend\setCache().

Member Data Documentation

$identifierPrefix
protected