Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
0f03f337 | 6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
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 | |
0f03f337 | 31 | * @copyright CiviCRM LLC (c) 2004-2017 |
7b5937fe TO |
32 | * |
33 | * CRM_Utils_Cache_Interface | |
34 | * | |
35 | * PHP-FIG has been developing a draft standard for caching, | |
36 | * PSR-6. The standard has not been ratified yet. When | |
37 | * making changes to this interface, please take care to | |
38 | * avoid *conflicst* with PSR-6's CacheItemPoolInterface. At | |
39 | * time of writing, they do not conflict. Avoiding conflicts | |
40 | * will enable more transition paths where Civi | |
41 | * simultaneously supports both interfaces in the same | |
42 | * implementation. | |
43 | * | |
44 | * For example, the current interface defines: | |
45 | * | |
46 | * function get($key) => mixed $value | |
47 | * | |
48 | * and PSR-6 defines: | |
49 | * | |
50 | * function getItem($key) => ItemInterface $item | |
51 | * | |
52 | * These are different styles (e.g. "weak item" vs "strong item"), | |
53 | * but the two methods do not *conflict*. They can coexist, | |
54 | * and you can trivially write adapters between the two. | |
55 | * | |
56 | * @see https://github.com/php-fig/fig-standards/blob/master/proposed/cache.md | |
6a488035 TO |
57 | */ |
58 | interface CRM_Utils_Cache_Interface { | |
59 | ||
60 | /** | |
fe482240 | 61 | * Set the value in the cache. |
6a488035 TO |
62 | * |
63 | * @param string $key | |
64 | * @param mixed $value | |
6a488035 | 65 | */ |
00be9182 | 66 | public function set($key, &$value); |
6a488035 TO |
67 | |
68 | /** | |
fe482240 | 69 | * Get a value from the cache. |
6a488035 TO |
70 | * |
71 | * @param string $key | |
72b3a70c CW |
72 | * @return mixed |
73 | * NULL if $key has not been previously set | |
6a488035 | 74 | */ |
00be9182 | 75 | public function get($key); |
6a488035 TO |
76 | |
77 | /** | |
fe482240 | 78 | * Delete a value from the cache. |
6a488035 TO |
79 | * |
80 | * @param string $key | |
6a488035 | 81 | */ |
00be9182 | 82 | public function delete($key); |
6a488035 TO |
83 | |
84 | /** | |
fe482240 | 85 | * Delete all values from the cache. |
6a488035 | 86 | */ |
00be9182 | 87 | public function flush(); |
96025800 | 88 | |
6a488035 | 89 | } |