<?php namespace Doctrine\Common\Cache; /** * Interface for cache drivers. * * @link www.doctrine-project.org */ interface Cache { public const STATS_HITS = 'hits'; public const STATS_MISSES = 'misses'; public const STATS_UPTIME = 'uptime'; public const STATS_MEMORY_USAGE = 'memory_usage'; public const STATS_MEMORY_AVAILABLE = 'memory_available'; /** * Only for backward compatibility (may be removed in next major release) * * @deprecated */ public const STATS_MEMORY_AVAILIABLE = 'memory_available'; /** * Fetches an entry from the cache. * * @param string $id The id of the cache entry to fetch. * * @return mixed The cached data or FALSE, if no cache entry exists for the given id. */ public function fetch($id); /** * Tests if an entry exists in the cache. * * @param string $id The cache id of the entry to check for. * * @return bool TRUE if a cache entry exists for the given cache id, FALSE otherwise. */ public function contains($id); /** * Puts data into the cache. * * If a cache entry with the given id already exists, its data will be replaced. * * @param string $id The cache id. * @param mixed $data The cache entry/data. * @param 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 bool TRUE if the entry was successfully stored in the cache, FALSE otherwise. */ public function save($id, $data, $lifeTime = 0); /** * Deletes a cache entry. * * @param string $id The cache id. * * @return bool TRUE if the cache entry was successfully deleted, FALSE otherwise. * Deleting a non-existing entry is considered successful. */ public function delete($id); /** * Retrieves cached information from the data store. * * The server's statistics array has the following values: * * - <b>hits</b> * Number of keys that have been requested and found present. * * - <b>misses</b> * Number of items that have been requested and not found. * * - <b>uptime</b> * Time that the server is running. * * - <b>memory_usage</b> * Memory used by this server to store items. * * - <b>memory_available</b> * Memory allowed to use for storage. * * @return mixed[]|null An associative array with server's statistics if available, NULL otherwise. */ public function getStats(); }
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
Psr6 | Folder | 0755 |
|
|
ApcCache.php | File | 2.33 KB | 0644 |
|
ApcuCache.php | File | 2.22 KB | 0644 |
|
ArrayCache.php | File | 2.17 KB | 0644 |
|
Cache.php | File | 2.73 KB | 0644 |
|
CacheProvider.php | File | 8.28 KB | 0644 |
|
ChainCache.php | File | 4.84 KB | 0644 |
|
ClearableCache.php | File | 501 B | 0644 |
|
CouchbaseBucketCache.php | File | 4.67 KB | 0644 |
|
CouchbaseCache.php | File | 2.27 KB | 0644 |
|
ExtMongoDBCache.php | File | 5.22 KB | 0644 |
|
FileCache.php | File | 8 KB | 0644 |
|
FilesystemCache.php | File | 2.12 KB | 0644 |
|
FlushableCache.php | File | 350 B | 0644 |
|
InvalidCacheId.php | File | 970 B | 0644 |
|
LegacyMongoDBCache.php | File | 4.69 KB | 0644 |
|
MemcacheCache.php | File | 2.16 KB | 0644 |
|
MemcachedCache.php | File | 3.86 KB | 0644 |
|
MongoDBCache.php | File | 3.23 KB | 0644 |
|
MultiDeleteCache.php | File | 466 B | 0644 |
|
MultiGetCache.php | File | 593 B | 0644 |
|
MultiOperationCache.php | File | 251 B | 0644 |
|
MultiPutCache.php | File | 704 B | 0644 |
|
PhpFileCache.php | File | 2.72 KB | 0644 |
|
PredisCache.php | File | 3.35 KB | 0644 |
|
RedisCache.php | File | 4.36 KB | 0644 |
|
RiakCache.php | File | 6.65 KB | 0644 |
|
SQLite3Cache.php | File | 4.66 KB | 0644 |
|
Version.php | File | 211 B | 0644 |
|
VoidCache.php | File | 994 B | 0644 |
|
WinCacheCache.php | File | 2.34 KB | 0644 |
|
XcacheCache.php | File | 2.16 KB | 0644 |
|
ZendDataCache.php | File | 1.32 KB | 0644 |
|