ValueStore.php
| 1 | <?php |
| 2 | namespace Dropbox; |
| 3 | |
| 4 | /** |
| 5 | * A contract for a class which provides simple get/set/clear access to a single string |
| 6 | * value. {@link ArrayEntryStore} provides an implementation of this for storing a value |
| 7 | * in a single array element. |
| 8 | * |
| 9 | * Example implementation for a Memcache-based backing store: |
| 10 | * |
| 11 | * <code> |
| 12 | * class MemcacheValueStore implements ValueStore |
| 13 | * { |
| 14 | * private $key; |
| 15 | * private $memcache; |
| 16 | * |
| 17 | * function __construct($memcache, $key) |
| 18 | * { |
| 19 | * $this->memcache = $memcache; |
| 20 | * $this->key = $key; |
| 21 | * } |
| 22 | * |
| 23 | * function get() |
| 24 | * { |
| 25 | * $value = $this->memcache->get($this->getKey()); |
| 26 | * return $value === false ? null : base64_decode($value); |
| 27 | * } |
| 28 | * |
| 29 | * function set($value) |
| 30 | * { |
| 31 | * $this->memcache->set($this->key, base64_encode($value)); |
| 32 | * } |
| 33 | * |
| 34 | * function clear() |
| 35 | * { |
| 36 | * $this->memcache->delete($this->key); |
| 37 | * } |
| 38 | * } |
| 39 | * </code> |
| 40 | */ |
| 41 | interface ValueStore |
| 42 | { |
| 43 | /** |
| 44 | * Returns the entry's current value or <code>null</code> if nothing is set. |
| 45 | * |
| 46 | * @return string |
| 47 | */ |
| 48 | function get(); |
| 49 | |
| 50 | /** |
| 51 | * Set the entry to the given value. |
| 52 | * |
| 53 | * @param string $value |
| 54 | */ |
| 55 | function set($value); |
| 56 | |
| 57 | /** |
| 58 | * Remove the value. |
| 59 | */ |
| 60 | function clear(); |
| 61 | } |
| 62 |