PHP Class Neos\Cache\Frontend\AbstractFrontend

Inheritance: implements Neos\Cache\Frontend\FrontendInterface
Show file Open project: neos/flow-development-collection

Protected Properties

Property Type Description
$backend Neos\Cache\Backend\AbstractBackend
$identifier string Identifies this cache

Public Methods

Method Description
__construct ( string $identifier, Neos\Cache\Backend\BackendInterface $backend ) Constructs the cache
collectGarbage ( ) : void Does garbage collection
flush ( ) : void Removes all cache entries of this cache.
flushByTag ( string $tag ) : integer Removes all cache entries of this cache which are tagged by the specified tag.
getBackend ( ) : Neos\Cache\Backend\BackendInterface Returns the backend used by this cache
getIdentifier ( ) : string Returns this cache's identifier
has ( string $entryIdentifier ) : boolean Checks if a cache entry with the specified identifier exists.
initializeObject ( ) : void Initializes this frontend
isValidEntryIdentifier ( string $identifier ) : boolean Checks the validity of an entry identifier. Returns true if it's valid.
isValidTag ( string $tag ) : boolean Checks the validity of a tag. Returns true if it's valid.
remove ( string $entryIdentifier ) : boolean Removes the given cache entry from the cache.

Method Details

__construct() public method

Constructs the cache
public __construct ( string $identifier, Neos\Cache\Backend\BackendInterface $backend )
$identifier string A identifier which describes this cache
$backend Neos\Cache\Backend\BackendInterface Backend to be used for this cache

collectGarbage() public method

Does garbage collection
public collectGarbage ( ) : void
return void

flush() public method

Removes all cache entries of this cache.
public flush ( ) : void
return void

flushByTag() public method

Removes all cache entries of this cache which are tagged by the specified tag.
public flushByTag ( string $tag ) : integer
$tag string The tag the entries must have
return integer The number of entries which have been affected by this flush or NULL if the number is unknown

getBackend() public method

Returns the backend used by this cache
public getBackend ( ) : Neos\Cache\Backend\BackendInterface
return Neos\Cache\Backend\BackendInterface The backend used by this cache

getIdentifier() public method

Returns this cache's identifier
public getIdentifier ( ) : string
return string The identifier for this cache

has() public method

Checks if a cache entry with the specified identifier exists.
public has ( string $entryIdentifier ) : boolean
$entryIdentifier string An identifier specifying the cache entry
return boolean TRUE if such an entry exists, FALSE if not

initializeObject() public method

The backend is connected with this frontend in initializeObject(), not in __construct(), because the Cache Factory needs an opportunity to register the cache before the backend's setCache() method is called. See CacheFactory::create() for details. A backend (for example the SimpleFileBackend) may rely on the cache already being registered at the CacheManager when its setCache() method is called.
public initializeObject ( ) : void
return void

isValidEntryIdentifier() public method

Checks the validity of an entry identifier. Returns true if it's valid.
public isValidEntryIdentifier ( string $identifier ) : boolean
$identifier string An identifier to be checked for validity
return boolean

isValidTag() public method

Checks the validity of a tag. Returns true if it's valid.
public isValidTag ( string $tag ) : boolean
$tag string An identifier to be checked for validity
return boolean

remove() public method

Removes the given cache entry from the cache.
public remove ( string $entryIdentifier ) : boolean
$entryIdentifier string An identifier specifying the cache entry
return boolean TRUE if such an entry exists, FALSE if not

Property Details

$backend protected property

protected AbstractBackend,Neos\Cache\Backend $backend
return Neos\Cache\Backend\AbstractBackend

$identifier protected property

Identifies this cache
protected string $identifier
return string