PHP Class Neos\Cache\Backend\MemcachedBackend

This backend uses the following types of cache keys: - tag_xxx xxx is tag name, value is array of associated identifiers identifier. This is "forward" tag index. It is mainly used for obtaining content by tag (get identifier by tag -> get content by identifier) - ident_xxx xxx is identifier, value is array of associated tags. This is "reverse" tag index. It provides quick access for all tags associated with this identifier and used when removing the identifier - tagIndex Value is a List of all tags (array) 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: - "Flow" - MD5 of script path and filename and SAPI name This prefix makes sure that keys from the different installations do not conflict. Note: When using the Memcache backend to store values of more than ~1 MB, the data will be split into chunks to make them fit into the caches limits.
Inheritance: extends AbstractBackend, implements Neos\Cache\Backend\TaggableBackendInterface, implements Neos\Cache\Backend\PhpCapableBackendInterface, use trait RequireOnceFromValueTrait
Datei anzeigen Open project: neos/flow-development-collection Class Usage Examples

Protected Properties

Property Type Description
$flags integer Indicates whether the memcache uses compression or not (requires zlib), either 0 or MEMCACHE_COMPRESSED
$identifierPrefix string A prefix to separate stored data from other data possible stored in the memcache
$memcache Memcache | Memcached Instance of the PHP Memcache/Memcached class
$servers array Array of Memcache server configurations

Public Methods

Method Description
__construct ( EnvironmentConfiguration $environmentConfiguration, array $options = [] )
collectGarbage ( ) : void Does nothing, as memcache/memcached does GC itself
findIdentifiersByTag ( string $tag ) : array Finds and returns all cache entry identifiers which are tagged by the specified tag.
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 Loads data from the cache.
getPrefixedIdentifier ( string $entryIdentifier ) : string Returns the internally used, prefixed entry identifier for the given public entry identifier.
has ( string $entryIdentifier ) : boolean Checks if a cache entry with the specified identifier exists.
remove ( string $entryIdentifier ) : boolean Removes all cache entries matching the specified identifier.
set ( string $entryIdentifier, string $data, array $tags = [], integer $lifetime = null ) : void Saves data in the cache.
setCache ( Neos\Cache\Frontend\FrontendInterface $cache ) : void Initializes the identifier prefix when setting the cache.

Protected Methods

Method Description
addIdentifierToTags ( string $entryIdentifier, array $tags ) : void Associates the identifier with the given tags
findTagsByIdentifier ( string $identifier ) : array Finds all tags for the given identifier. This function uses reverse tag index to search for tags.
removeIdentifierFromAllTags ( string $entryIdentifier ) : void Removes association of the identifier with the given tags
setCompression ( boolean $useCompression ) : void Setter for compression flags bit
setItem ( string $key, string $value, integer $expiration ) : boolean Stores an item on the server
setServers ( array $servers ) : void Setter for servers to be used. Expects an array, the values are expected to be formatted like "[:]" or "unix://"

Method Details

__construct() public method

public __construct ( EnvironmentConfiguration $environmentConfiguration, array $options = [] )
$environmentConfiguration Neos\Cache\EnvironmentConfiguration
$options array

addIdentifierToTags() protected method

Associates the identifier with the given tags
protected addIdentifierToTags ( string $entryIdentifier, array $tags ) : void
$entryIdentifier string
$tags array
return void

collectGarbage() public method

Does nothing, as memcache/memcached does GC itself
public collectGarbage ( ) : void
return void

findIdentifiersByTag() public method

Finds and returns all cache entry identifiers which are tagged by the specified tag.
public findIdentifiersByTag ( string $tag ) : array
$tag string The tag to search for
return array An array with identifiers of all matching entries. An empty array if no entries matched

findTagsByIdentifier() protected method

Finds all tags for the given identifier. This function uses reverse tag index to search for tags.
protected findTagsByIdentifier ( string $identifier ) : array
$identifier string Identifier to find tags by
return array Array with tags

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

get() public method

Loads data from the cache.
public get ( string $entryIdentifier ) : mixed
$entryIdentifier string An identifier which describes the cache entry to load
return mixed The cache entry's content as a string or FALSE if the cache entry could not be loaded

getPrefixedIdentifier() public method

While Flow applications will mostly refer to the simple entry identifier, it may be necessary to know the actual identifier used by the cache backend in order to share cache entries with other applications. This method allows for retrieving it.
public getPrefixedIdentifier ( string $entryIdentifier ) : string
$entryIdentifier string The short entry identifier, for example "NumberOfPostedArticles"
return string The prefixed identifier, for example "Flow694a5c7a43a4_NumberOfPostedArticles"

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

remove() public method

Usually this only affects one entry but if - for what reason ever - old entries for the identifier still exist, they are removed as well.
public remove ( string $entryIdentifier ) : boolean
$entryIdentifier string Specifies the cache entry to remove
return boolean TRUE if (at least) an entry could be removed or FALSE if no entry was found

removeIdentifierFromAllTags() protected method

Removes association of the identifier with the given tags
protected removeIdentifierFromAllTags ( string $entryIdentifier ) : void
$entryIdentifier string
return void

set() public method

Saves data in the cache.
public set ( string $entryIdentifier, string $data, array $tags = [], integer $lifetime = null ) : void
$entryIdentifier string An identifier for this specific cache entry
$data string The data to be stored
$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

setCache() public method

Initializes the identifier prefix when setting the cache.
public setCache ( Neos\Cache\Frontend\FrontendInterface $cache ) : void
$cache Neos\Cache\Frontend\FrontendInterface
return void

setCompression() protected method

Setter for compression flags bit
protected setCompression ( boolean $useCompression ) : void
$useCompression boolean
return void

setItem() protected method

Stores an item on the server
protected setItem ( string $key, string $value, integer $expiration ) : boolean
$key string
$value string
$expiration integer
return boolean

setServers() protected method

Setter for servers to be used. Expects an array, the values are expected to be formatted like "[:]" or "unix://"
protected setServers ( array $servers ) : void
$servers array An array of servers to add.
return void

Property Details

$flags protected_oe property

Indicates whether the memcache uses compression or not (requires zlib), either 0 or MEMCACHE_COMPRESSED
protected int $flags
return integer

$identifierPrefix protected_oe property

A prefix to separate stored data from other data possible stored in the memcache
protected string $identifierPrefix
return string

$memcache protected_oe property

Instance of the PHP Memcache/Memcached class
protected Memcache|Memcached $memcache
return Memcache | Memcached

$servers protected_oe property

Array of Memcache server configurations
protected array $servers
return array