CacheInterface.php
106 lines
| 1 | <?php |
| 2 | /** |
| 3 | * CacheInterface.php |
| 4 | * |
| 5 | * @package Embera |
| 6 | * @author Michael Pratt <yo@michael-pratt.com> |
| 7 | * @link http://www.michael-pratt.com/ |
| 8 | * |
| 9 | * For the full copyright and license information, please view the LICENSE |
| 10 | * file that was distributed with this source code. |
| 11 | */ |
| 12 | |
| 13 | namespace Embera\Cache; |
| 14 | |
| 15 | use InvalidArgumentException; |
| 16 | |
| 17 | /** |
| 18 | * The Cache Interface. It is based on PSR-16 |
| 19 | * @link https://www.php-fig.org/psr/psr-16/ |
| 20 | */ |
| 21 | interface CacheInterface |
| 22 | { |
| 23 | /** |
| 24 | * Fetches a value from the cache. |
| 25 | * |
| 26 | * @param string $key The unique key of this item in the cache. |
| 27 | * @param mixed $default Default value to return if the key does not exist. |
| 28 | * @return mixed The value of the item from the cache, or $default in case of cache miss. |
| 29 | * |
| 30 | * @throws InvalidArgumentException |
| 31 | */ |
| 32 | public function get($key, $default = null); |
| 33 | |
| 34 | /** |
| 35 | * Set data in cache. |
| 36 | * |
| 37 | * @param string $key The key of the item to store. |
| 38 | * @param mixed $value The value of the item to store. Must be serializable. |
| 39 | * @param null|int|\DateInterval $ttl Optional. The TTL value of this item. If no value is sent and |
| 40 | * @return bool |
| 41 | * |
| 42 | * @throws InvalidArgumentException |
| 43 | */ |
| 44 | public function set($key, $value, $ttl = null); |
| 45 | |
| 46 | /** |
| 47 | * Delete an item from the cache by its unique key. |
| 48 | * |
| 49 | * @param string $key The unique cache key of the item to delete. |
| 50 | * @return bool |
| 51 | * |
| 52 | * @throws InvalidArgumentException |
| 53 | */ |
| 54 | public function delete($key); |
| 55 | |
| 56 | /** |
| 57 | * Wipes clean the entire cache's keys. |
| 58 | * |
| 59 | * @return bool |
| 60 | */ |
| 61 | public function clear(); |
| 62 | |
| 63 | /** |
| 64 | * Obtains multiple cache items by their unique keys. |
| 65 | * |
| 66 | * @param iterable $keys A list of keys that can obtained in a single operation. |
| 67 | * @param mixed $default Default value to return for keys that do not exist. |
| 68 | * |
| 69 | * @return iterable A list of key => value pairs. |
| 70 | * |
| 71 | * @throws InvalidArgumentException |
| 72 | */ |
| 73 | public function getMultiple($keys, $default = null); |
| 74 | |
| 75 | /** |
| 76 | * Persists a set of key => value pairs in the cache, with an optional TTL. |
| 77 | * |
| 78 | * @param iterable $values A list of key => value pairs for a multiple-set operation. |
| 79 | * @param null|int|\DateInterval $ttl Optional. The TTL value of this item |
| 80 | * @return bool |
| 81 | * |
| 82 | * @throws InvalidArgumentException |
| 83 | */ |
| 84 | public function setMultiple($values, $ttl = null); |
| 85 | |
| 86 | /** |
| 87 | * Deletes multiple cache items in a single operation. |
| 88 | * |
| 89 | * @param iterable $keys A list of string-based keys to be deleted. |
| 90 | * @return bool |
| 91 | * |
| 92 | * @throws InvalidArgumentException |
| 93 | */ |
| 94 | public function deleteMultiple($keys); |
| 95 | |
| 96 | /** |
| 97 | * Determines whether an item is present in the cache. |
| 98 | * |
| 99 | * @param string $key The cache item key. |
| 100 | * @return bool |
| 101 | * |
| 102 | * @throws InvalidArgumentException |
| 103 | */ |
| 104 | public function has($key); |
| 105 | } |
| 106 |