CacheException.php
2 years ago
CacheInterface.php
2 years ago
InvalidArgumentException.php
2 years ago
CacheInterface.php
109 lines
| 1 | <?php |
| 2 | |
| 3 | namespace IAWP_SCOPED\Psr\SimpleCache; |
| 4 | |
| 5 | /** @internal */ |
| 6 | interface CacheInterface |
| 7 | { |
| 8 | /** |
| 9 | * Fetches a value from the cache. |
| 10 | * |
| 11 | * @param string $key The unique key of this item in the cache. |
| 12 | * @param mixed $default Default value to return if the key does not exist. |
| 13 | * |
| 14 | * @return mixed The value of the item from the cache, or $default in case of cache miss. |
| 15 | * |
| 16 | * @throws \Psr\SimpleCache\InvalidArgumentException |
| 17 | * MUST be thrown if the $key string is not a legal value. |
| 18 | */ |
| 19 | public function get($key, $default = null); |
| 20 | /** |
| 21 | * Persists data in the cache, uniquely referenced by a key with an optional expiration TTL time. |
| 22 | * |
| 23 | * @param string $key The key of the item to store. |
| 24 | * @param mixed $value The value of the item to store, must be serializable. |
| 25 | * @param null|int|\DateInterval $ttl Optional. The TTL value of this item. If no value is sent and |
| 26 | * the driver supports TTL then the library may set a default value |
| 27 | * for it or let the driver take care of that. |
| 28 | * |
| 29 | * @return bool True on success and false on failure. |
| 30 | * |
| 31 | * @throws \Psr\SimpleCache\InvalidArgumentException |
| 32 | * MUST be thrown if the $key string is not a legal value. |
| 33 | */ |
| 34 | public function set($key, $value, $ttl = null); |
| 35 | /** |
| 36 | * Delete an item from the cache by its unique key. |
| 37 | * |
| 38 | * @param string $key The unique cache key of the item to delete. |
| 39 | * |
| 40 | * @return bool True if the item was successfully removed. False if there was an error. |
| 41 | * |
| 42 | * @throws \Psr\SimpleCache\InvalidArgumentException |
| 43 | * MUST be thrown if the $key string is not a legal value. |
| 44 | */ |
| 45 | public function delete($key); |
| 46 | /** |
| 47 | * Wipes clean the entire cache's keys. |
| 48 | * |
| 49 | * @return bool True on success and false on failure. |
| 50 | */ |
| 51 | public function clear(); |
| 52 | /** |
| 53 | * Obtains multiple cache items by their unique keys. |
| 54 | * |
| 55 | * @param iterable $keys A list of keys that can obtained in a single operation. |
| 56 | * @param mixed $default Default value to return for keys that do not exist. |
| 57 | * |
| 58 | * @return iterable A list of key => value pairs. Cache keys that do not exist or are stale will have $default as value. |
| 59 | * |
| 60 | * @throws \Psr\SimpleCache\InvalidArgumentException |
| 61 | * MUST be thrown if $keys is neither an array nor a Traversable, |
| 62 | * or if any of the $keys are not a legal value. |
| 63 | */ |
| 64 | public function getMultiple($keys, $default = null); |
| 65 | /** |
| 66 | * Persists a set of key => value pairs in the cache, with an optional TTL. |
| 67 | * |
| 68 | * @param iterable $values A list of key => value pairs for a multiple-set operation. |
| 69 | * @param null|int|\DateInterval $ttl Optional. The TTL value of this item. If no value is sent and |
| 70 | * the driver supports TTL then the library may set a default value |
| 71 | * for it or let the driver take care of that. |
| 72 | * |
| 73 | * @return bool True on success and false on failure. |
| 74 | * |
| 75 | * @throws \Psr\SimpleCache\InvalidArgumentException |
| 76 | * MUST be thrown if $values is neither an array nor a Traversable, |
| 77 | * or if any of the $values are not a legal value. |
| 78 | */ |
| 79 | public function setMultiple($values, $ttl = null); |
| 80 | /** |
| 81 | * Deletes multiple cache items in a single operation. |
| 82 | * |
| 83 | * @param iterable $keys A list of string-based keys to be deleted. |
| 84 | * |
| 85 | * @return bool True if the items were successfully removed. False if there was an error. |
| 86 | * |
| 87 | * @throws \Psr\SimpleCache\InvalidArgumentException |
| 88 | * MUST be thrown if $keys is neither an array nor a Traversable, |
| 89 | * or if any of the $keys are not a legal value. |
| 90 | */ |
| 91 | public function deleteMultiple($keys); |
| 92 | /** |
| 93 | * Determines whether an item is present in the cache. |
| 94 | * |
| 95 | * NOTE: It is recommended that has() is only to be used for cache warming type purposes |
| 96 | * and not to be used within your live applications operations for get/set, as this method |
| 97 | * is subject to a race condition where your has() will return true and immediately after, |
| 98 | * another script can remove it making the state of your app out of date. |
| 99 | * |
| 100 | * @param string $key The cache item key. |
| 101 | * |
| 102 | * @return bool |
| 103 | * |
| 104 | * @throws \Psr\SimpleCache\InvalidArgumentException |
| 105 | * MUST be thrown if the $key string is not a legal value. |
| 106 | */ |
| 107 | public function has($key); |
| 108 | } |
| 109 |