TransientMemoryBackend
class TransientMemoryBackend extends AbstractBackend implements TaggableBackendInterface (View source)
A caching backend which stores cache entries during one script run.
Constants
| DATETIME_EXPIRYTIME_UNLIMITED |
|
| UNLIMITED_LIFETIME |
|
Properties
| protected FrontendInterface | $cache | Reference to the cache frontend which uses this backend |
from AbstractBackend |
| protected string | $cacheIdentifier | from AbstractBackend | |
| protected string | $identifierPrefix | A prefix to seperate stored by appliaction context and cache |
from AbstractBackend |
| protected int | $defaultLifetime | Default lifetime of a cache entry in seconds |
from AbstractBackend |
| protected EnvironmentConfiguration | $environmentConfiguration | from AbstractBackend | |
| protected array | $entries | ||
| protected array | $tagsAndEntries |
Methods
Constructs this backend
No description
Sets the default lifetime for this cache backend
Calculates the expiry time by the given lifetime. If no lifetime is specified, the default lifetime is used.
Returns the internally used, prefixed entry identifier for the given public entry identifier.
Saves data in the cache.
Loads data from the cache.
Checks if a cache entry with the specified identifier exists.
Removes all cache entries matching the specified identifier.
Finds and returns all cache entry identifiers which are tagged by the specified tag.
Removes all cache entries of this cache.
Removes all cache entries of this cache which are tagged by the specified tag.
Does nothing
Details
__construct(EnvironmentConfiguration $environmentConfiguration = null, array $options = [])
Constructs this backend
protected void
setProperties(array $properties, bool $throwExceptionIfPropertyNotSettable = true)
No description
protected bool
setProperty(string $propertyName, mixed $propertyValue)
No description
void
setCache(FrontendInterface $cache)
Sets a reference to the cache frontend which uses this backend
void
setDefaultLifetime(int|string $defaultLifetime)
Sets the default lifetime for this cache backend
protected DateTime
calculateExpiryTime(int $lifetime = null)
Calculates the expiry time by the given lifetime. If no lifetime is specified, the default lifetime is used.
string
getPrefixedIdentifier(string $entryIdentifier)
Returns the internally used, prefixed entry identifier for the given public entry identifier.
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.
Note that, in case of the AbstractBackend, this method is returns just the given entry identifier.
void
set(string $entryIdentifier, string $data, array $tags = [], int $lifetime = null)
Saves data in the cache.
mixed
get(string $entryIdentifier)
Loads data from the cache.
bool
has(string $entryIdentifier)
Checks if a cache entry with the specified identifier exists.
bool
remove(string $entryIdentifier)
Removes all cache entries matching the specified identifier.
array
findIdentifiersByTag(string $tag)
Finds and returns all cache entry identifiers which are tagged by the specified tag.
void
flush()
Removes all cache entries of this cache.
int
flushByTag(string $tag)
Removes all cache entries of this cache which are tagged by the specified tag.
void
collectGarbage()
Does nothing