Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
6b83d5bd | 31 | * @copyright CiviCRM LLC (c) 2004-2019 |
7b5937fe | 32 | * |
ebf0eb53 TO |
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. | |
7b5937fe | 37 | * |
ebf0eb53 | 38 | * @see https://www.php-fig.org/psr/psr-16/ |
6a488035 | 39 | */ |
ebf0eb53 | 40 | interface CRM_Utils_Cache_Interface extends \Psr\SimpleCache\CacheInterface { |
6a488035 TO |
41 | |
42 | /** | |
fe482240 | 43 | * Set the value in the cache. |
6a488035 TO |
44 | * |
45 | * @param string $key | |
46 | * @param mixed $value | |
858451a9 TO |
47 | * @param null|int|\DateInterval $ttl |
48 | * @return bool | |
6a488035 | 49 | */ |
858451a9 | 50 | public function set($key, $value, $ttl = NULL); |
6a488035 TO |
51 | |
52 | /** | |
fe482240 | 53 | * Get a value from the cache. |
6a488035 TO |
54 | * |
55 | * @param string $key | |
2da67cc5 | 56 | * @param mixed $default |
72b3a70c | 57 | * @return mixed |
2da67cc5 | 58 | * The previously set value value, or $default (NULL). |
6a488035 | 59 | */ |
2da67cc5 | 60 | public function get($key, $default = NULL); |
6a488035 TO |
61 | |
62 | /** | |
fe482240 | 63 | * Delete a value from the cache. |
6a488035 TO |
64 | * |
65 | * @param string $key | |
eec321a4 | 66 | * @return bool |
6a488035 | 67 | */ |
00be9182 | 68 | public function delete($key); |
6a488035 TO |
69 | |
70 | /** | |
fe482240 | 71 | * Delete all values from the cache. |
124e5288 | 72 | * |
c31de879 TO |
73 | * NOTE: flush() and clear() should be aliases. flush() is specified by |
74 | * Civi's traditional interface, and clear() is specified by PSR-16. | |
75 | * | |
124e5288 | 76 | * @return bool |
c31de879 TO |
77 | * @see clear |
78 | * @deprecated | |
6a488035 | 79 | */ |
00be9182 | 80 | public function flush(); |
96025800 | 81 | |
c31de879 TO |
82 | /** |
83 | * Delete all values from the cache. | |
84 | * | |
85 | * NOTE: flush() and clear() should be aliases. flush() is specified by | |
86 | * Civi's traditional interface, and clear() is specified by PSR-16. | |
87 | * | |
88 | * @return bool | |
89 | * @see flush | |
90 | */ | |
91 | public function clear(); | |
92 | ||
9f70b0e4 TO |
93 | /** |
94 | * Determines whether an item is present in the cache. | |
95 | * | |
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. | |
100 | * | |
101 | * @param string $key The cache item key. | |
102 | * | |
103 | * @return bool | |
104 | */ | |
105 | public function has($key); | |
106 | ||
6a488035 | 107 | } |