\Doctrine\Common\CacheCache

Interface for cache drivers.

Summary

Methods

Constants

fetch()
contains()
save()
delete()
getStats()

STATS_HITS
STATS_MISSES
STATS_UPTIME
STATS_MEMORY_USAGE
STATS_MEMORY_AVAILABLE
STATS_MEMORY_AVAILIABLE

No protected methods found

N/A

No private methods found

N/A

File: vendor/doctrine/cache/lib/Doctrine/Common/Cache/Cache.php
Package: \Default
See also: www.doctrine-project.org

Constants

STATS_HITS

STATS_HITS = 'hits'

STATS_MISSES

STATS_MISSES = 'misses'

STATS_UPTIME

STATS_UPTIME = 'uptime'

STATS_MEMORY_USAGE

STATS_MEMORY_USAGE = 'memory_usage'

STATS_MEMORY_AVAILABLE

STATS_MEMORY_AVAILABLE = 'memory_available'

STATS_MEMORY_AVAILIABLE

STATS_MEMORY_AVAILIABLE = 'memory_available'

Only for backward compatibility (may be removed in next major release)

Methods

fetch()

fetch(string  $id) : mixed

Fetches an entry from the cache.

Parameters

string

$id

The id of the cache entry to fetch.

Returns

mixed —

The cached data or FALSE, if no cache entry exists for the given id.

contains()

contains(string  $id) : boolean

Tests if an entry exists in the cache.

Parameters

string

$id

The cache id of the entry to check for.

Returns

boolean —

TRUE if a cache entry exists for the given cache id, FALSE otherwise.

save()

save(string  $id, mixed  $data, integer  $lifeTime) : boolean

Puts data into the cache.

If a cache entry with the given id already exists, its data will be replaced.

Parameters

string	$id	The cache id.
mixed	$data	The cache entry/data.
integer	$lifeTime	The lifetime in number of seconds for this cache entry. If zero (the default), the entry never expires (although it may be deleted from the cache to make place for other entries).

Returns

boolean —

TRUE if the entry was successfully stored in the cache, FALSE otherwise.

delete()

delete(string  $id) : boolean

Deletes a cache entry.

Parameters

string

$id

The cache id.

Returns

boolean —

TRUE if the cache entry was successfully deleted, FALSE otherwise. Deleting a non-existing entry is considered successful.

getStats()

getStats() : array|null

Retrieves cached information from the data store.

The server's statistics array has the following values:

hits Number of keys that have been requested and found present.
misses Number of items that have been requested and not found.
uptime Time that the server is running.
memory_usage Memory used by this server to store items.
memory_available Memory allowed to use for storage.

Returns

array|null —

An associative array with server's statistics if available, NULL otherwise.

Inherited from: \Doctrine\Common\Cache\Cache