interface Cache (View source)

Interface for cache drivers.

Constants

STATS_HITS

STATS_MISSES

STATS_UPTIME

STATS_MEMORY_USAGE

STATS_MEMORY_AVAILABLE

STATS_MEMORY_AVAILIABLE

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

Methods

mixed
fetch(string $id)

Fetches an entry from the cache.

bool
contains(string $id)

Tests if an entry exists in the cache.

bool
save(string $id, mixed $data, int $lifeTime = 0)

Puts data into the cache.

bool
delete(string $id)

Deletes a cache entry.

array|null
getStats()

Retrieves cached information from the data store.

Details

mixed fetch(string $id)

Fetches an entry from the cache.

Parameters

string $id The id of the cache entry to fetch.

Return Value

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

bool contains(string $id)

Tests if an entry exists in the cache.

Parameters

string $id The cache id of the entry to check for.

Return Value

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

bool save(string $id, mixed $data, int $lifeTime = 0)

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.
int $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).

Return Value

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

bool delete(string $id)

Deletes a cache entry.

Parameters

string $id The cache id.

Return Value

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

array|null getStats()

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.

Return Value

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