CacheAdapter.php
120 lines
| 1 | <?php |
| 2 | /** |
| 3 | * CacheAdapter.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 | * This class is responsible for holding duplicate logic |
| 19 | * in the cache class. |
| 20 | */ |
| 21 | abstract class CacheAdapter |
| 22 | { |
| 23 | /** |
| 24 | * Obtains multiple cache items by their unique keys. |
| 25 | * |
| 26 | * @param iterable $keys A list of keys that can obtained in a single operation. |
| 27 | * @param mixed $default Default value to return for keys that do not exist. |
| 28 | * |
| 29 | * @return iterable A list of key => value pairs. |
| 30 | * |
| 31 | * @throws InvalidArgumentException |
| 32 | */ |
| 33 | public function getMultiple($keys, $default = null) |
| 34 | { |
| 35 | $return = []; |
| 36 | foreach ($keys as $k) { |
| 37 | $return[$k] = $this->get($k, $default); |
| 38 | } |
| 39 | |
| 40 | return $return; |
| 41 | } |
| 42 | |
| 43 | /** |
| 44 | * Persists a set of key => value pairs in the cache, with an optional TTL. |
| 45 | * |
| 46 | * @param iterable $values A list of key => value pairs for a multiple-set operation. |
| 47 | * @param null|int|\DateInterval $ttl Optional. The TTL value of this item |
| 48 | * @return bool |
| 49 | * |
| 50 | * @throws InvalidArgumentException |
| 51 | */ |
| 52 | public function setMultiple($values, $ttl = null) |
| 53 | { |
| 54 | foreach ($values as $k => $v) { |
| 55 | $this->set($k, $v, $ttl); |
| 56 | } |
| 57 | |
| 58 | return true; |
| 59 | } |
| 60 | |
| 61 | /** |
| 62 | * Deletes multiple cache items in a single operation. |
| 63 | * |
| 64 | * @param iterable $keys A list of string-based keys to be deleted. |
| 65 | * @return bool |
| 66 | * |
| 67 | * @throws InvalidArgumentException |
| 68 | */ |
| 69 | public function deleteMultiple($keys) |
| 70 | { |
| 71 | foreach ($keys as $k) { |
| 72 | $this->delete($k); |
| 73 | } |
| 74 | |
| 75 | return true; |
| 76 | } |
| 77 | |
| 78 | /** |
| 79 | * Fetches a value from the cache. |
| 80 | * |
| 81 | * @param string $key The unique key of this item in the cache. |
| 82 | * @param mixed $default Default value to return if the key does not exist. |
| 83 | * @return mixed The value of the item from the cache, or $default in case of cache miss. |
| 84 | * |
| 85 | * @throws InvalidArgumentException |
| 86 | */ |
| 87 | public function get($key, $default = null) |
| 88 | { |
| 89 | return true; |
| 90 | } |
| 91 | |
| 92 | /** |
| 93 | * Set data in cache. |
| 94 | * |
| 95 | * @param string $key The key of the item to store. |
| 96 | * @param mixed $value The value of the item to store. Must be serializable. |
| 97 | * @param null|int|\DateInterval $ttl Optional. The TTL value of this item. If no value is sent and |
| 98 | * @return bool |
| 99 | * |
| 100 | * @throws InvalidArgumentException |
| 101 | */ |
| 102 | public function set($key, $value, $ttl = null) |
| 103 | { |
| 104 | return true; |
| 105 | } |
| 106 | |
| 107 | /** |
| 108 | * Delete an item from the cache by its unique key. |
| 109 | * |
| 110 | * @param string $key The unique cache key of the item to delete. |
| 111 | * @return bool |
| 112 | * |
| 113 | * @throws InvalidArgumentException |
| 114 | */ |
| 115 | public function delete($key) |
| 116 | { |
| 117 | return true; |
| 118 | } |
| 119 | } |
| 120 |