PHP Interface Neos\Cache\Frontend\FrontendInterface

Public Methods

Method	Description
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.
get ( string $entryIdentifier ) : mixed	Finds and returns data from the cache.
getBackend ( ) : Neos\Cache\Backend\BackendInterface	Returns the backend used by this cache
getByTag ( string $tag ) : array	Finds and returns all cache entries which are tagged by the specified tag.
getIdentifier ( ) : string	Returns this cache's identifier
has ( string $entryIdentifier ) : boolean	Checks if a cache entry with the specified identifier exists.
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.
set ( string $entryIdentifier, mixed $data, array $tags = [], integer $lifetime = null ) : void	Saves data in the cache.

Does garbage collection

public collectGarbage ( ) : void
return	void

Removes all cache entries of this cache.

public flush ( ) : void
return	void

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

Finds and returns data from the cache.

public get ( string $entryIdentifier ) : mixed
$entryIdentifier	string	Something which identifies the cache entry - depends on concrete cache
return	mixed

Returns the backend used by this cache

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

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

public getByTag ( string $tag ) : array
$tag	string	The tag to search for
return	array	An array with the identifier (key) and content (value) of all matching entries. An empty array if no entries matched

Returns this cache's identifier

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

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

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

Checks the validity of a tag. Returns true if it's valid.

public isValidTag ( string $tag ) : boolean
$tag	string	A tag to be checked for validity
return	boolean

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

Saves data in the cache.

public set ( string $entryIdentifier, mixed $data, array $tags = [], integer $lifetime = null ) : void
$entryIdentifier	string	Something which identifies the data - depends on concrete cache
$data	mixed	The data to cache - also depends on the concrete cache implementation
$tags	array	Tags to associate with this cache entry
$lifetime	integer	Lifetime of this cache entry in seconds. If NULL is specified, the default lifetime is used. "0" means unlimited lifetime.
return	void