3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2019
33 * CRM_Utils_Cache_Interface is a long-standing interface used within CiviCRM
34 * for interacting with a cache service. In style and substance, it is extremely
35 * similar to PHP-FIG's SimpleCache interface (PSR-16). Consequently, beginning
36 * with CiviCRM v5.4, this extends \Psr\SimpleCache\CacheInterface.
38 * @see https://www.php-fig.org/psr/psr-16/
40 interface CRM_Utils_Cache_Interface
extends \Psr\SimpleCache\CacheInterface
{
43 * Set the value in the cache.
47 * @param null|int|\DateInterval $ttl
50 public function set($key, $value, $ttl = NULL);
53 * Get a value from the cache.
56 * @param mixed $default
58 * The previously set value value, or $default (NULL).
60 public function get($key, $default = NULL);
63 * Delete a value from the cache.
68 public function delete($key);
71 * Delete all values from the cache.
73 * NOTE: flush() and clear() should be aliases. flush() is specified by
74 * Civi's traditional interface, and clear() is specified by PSR-16.
80 public function flush();
83 * Delete all values from the cache.
85 * NOTE: flush() and clear() should be aliases. flush() is specified by
86 * Civi's traditional interface, and clear() is specified by PSR-16.
91 public function clear();
94 * Determines whether an item is present in the cache.
96 * NOTE: It is recommended that has() is only to be used for cache warming type purposes
97 * and not to be used within your live applications operations for get/set, as this method
98 * is subject to a race condition where your has() will return true and immediately after,
99 * another script can remove it making the state of your app out of date.
101 * @param string $key The cache item key.
105 public function has($key);