SimpleStringCache.php
80 lines
| 1 | <?php |
| 2 | |
| 3 | declare (strict_types=1); |
| 4 | namespace ProfilePressVendor\Pelago\Emogrifier\Caching; |
| 5 | |
| 6 | /** |
| 7 | * This cache caches string values with string keys. It is not PSR-6-compliant. |
| 8 | * |
| 9 | * Usage: |
| 10 | * |
| 11 | * ```php |
| 12 | * $cache = new SimpleStringCache(); |
| 13 | * $cache->set($key, $value); |
| 14 | * … |
| 15 | * if ($cache->has($key) { |
| 16 | * $cachedValue = $cache->get($value); |
| 17 | * } |
| 18 | * ``` |
| 19 | * |
| 20 | * @internal |
| 21 | */ |
| 22 | class SimpleStringCache |
| 23 | { |
| 24 | /** |
| 25 | * @var array<string, string> |
| 26 | */ |
| 27 | private $values = []; |
| 28 | /** |
| 29 | * Checks whether there is an entry stored for the given key. |
| 30 | * |
| 31 | * @param string $key the key to check; must not be empty |
| 32 | * |
| 33 | * @throws \InvalidArgumentException |
| 34 | */ |
| 35 | public function has(string $key): bool |
| 36 | { |
| 37 | $this->assertNotEmptyKey($key); |
| 38 | return isset($this->values[$key]); |
| 39 | } |
| 40 | /** |
| 41 | * Returns the entry stored for the given key, and throws an exception if the value does not exist |
| 42 | * (which helps keep the return type simple). |
| 43 | * |
| 44 | * @param string $key the key to of the item to retrieve; must not be empty |
| 45 | * |
| 46 | * @return string the retrieved value; may be empty |
| 47 | * |
| 48 | * @throws \BadMethodCallException |
| 49 | */ |
| 50 | public function get(string $key): string |
| 51 | { |
| 52 | if (!$this->has($key)) { |
| 53 | throw new \BadMethodCallException('You can only call `get` with a key for an existing value.', 1625996246); |
| 54 | } |
| 55 | return $this->values[$key]; |
| 56 | } |
| 57 | /** |
| 58 | * Sets or overwrites an entry. |
| 59 | * |
| 60 | * @param string $key the key to of the item to set; must not be empty |
| 61 | * @param string $value the value to set; can be empty |
| 62 | * |
| 63 | * @throws \BadMethodCallException |
| 64 | */ |
| 65 | public function set(string $key, string $value): void |
| 66 | { |
| 67 | $this->assertNotEmptyKey($key); |
| 68 | $this->values[$key] = $value; |
| 69 | } |
| 70 | /** |
| 71 | * @throws \InvalidArgumentException |
| 72 | */ |
| 73 | private function assertNotEmptyKey(string $key): void |
| 74 | { |
| 75 | if ($key === '') { |
| 76 | throw new \InvalidArgumentException('Please provide a non-empty key.', 1625995840); |
| 77 | } |
| 78 | } |
| 79 | } |
| 80 |