| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | Copyright CiviCRM LLC. All rights reserved. | |
| 5 | | | |
| 6 | | This work is published under the GNU AGPLv3 license with some | |
| 7 | | permitted exceptions and without any warranty. For full license | |
| 8 | | and copyright information, see https://civicrm.org/licensing | |
| 9 | +--------------------------------------------------------------------+ |
| 10 | */ |
| 11 | |
| 12 | /** |
| 13 | * |
| 14 | * @package CRM |
| 15 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
| 16 | * |
| 17 | * CRM_Utils_Cache_Interface is a long-standing interface used within CiviCRM |
| 18 | * for interacting with a cache service. In style and substance, it is extremely |
| 19 | * similar to PHP-FIG's SimpleCache interface (PSR-16). Consequently, beginning |
| 20 | * with CiviCRM v5.4, this extends \Psr\SimpleCache\CacheInterface. |
| 21 | * |
| 22 | * @see https://www.php-fig.org/psr/psr-16/ |
| 23 | */ |
| 24 | interface CRM_Utils_Cache_Interface extends \Psr\SimpleCache\CacheInterface { |
| 25 | |
| 26 | /** |
| 27 | * Set the value in the cache. |
| 28 | * |
| 29 | * @param string $key |
| 30 | * @param mixed $value |
| 31 | * @param null|int|\DateInterval $ttl |
| 32 | * @return bool |
| 33 | */ |
| 34 | public function set($key, $value, $ttl = NULL); |
| 35 | |
| 36 | /** |
| 37 | * Get a value from the cache. |
| 38 | * |
| 39 | * @param string $key |
| 40 | * @param mixed $default |
| 41 | * @return mixed |
| 42 | * The previously set value value, or $default (NULL). |
| 43 | */ |
| 44 | public function get($key, $default = NULL); |
| 45 | |
| 46 | /** |
| 47 | * Delete a value from the cache. |
| 48 | * |
| 49 | * @param string $key |
| 50 | * @return bool |
| 51 | */ |
| 52 | public function delete($key); |
| 53 | |
| 54 | /** |
| 55 | * Delete all values from the cache. |
| 56 | * |
| 57 | * NOTE: flush() and clear() should be aliases. flush() is specified by |
| 58 | * Civi's traditional interface, and clear() is specified by PSR-16. |
| 59 | * |
| 60 | * @return bool |
| 61 | * @see clear |
| 62 | * @deprecated |
| 63 | */ |
| 64 | public function flush(); |
| 65 | |
| 66 | /** |
| 67 | * Delete all values from the cache. |
| 68 | * |
| 69 | * NOTE: flush() and clear() should be aliases. flush() is specified by |
| 70 | * Civi's traditional interface, and clear() is specified by PSR-16. |
| 71 | * |
| 72 | * @return bool |
| 73 | * @see flush |
| 74 | */ |
| 75 | public function clear(); |
| 76 | |
| 77 | /** |
| 78 | * Determines whether an item is present in the cache. |
| 79 | * |
| 80 | * NOTE: It is recommended that has() is only to be used for cache warming type purposes |
| 81 | * and not to be used within your live applications operations for get/set, as this method |
| 82 | * is subject to a race condition where your has() will return true and immediately after, |
| 83 | * another script can remove it making the state of your app out of date. |
| 84 | * |
| 85 | * @param string $key The cache item key. |
| 86 | * |
| 87 | * @return bool |
| 88 | */ |
| 89 | public function has($key); |
| 90 | |
| 91 | } |