1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
<?php
namespace Drupal\Core\Cache;
/**
* Defines an interface for variation cache implementations.
*
* A variation cache wraps any provided cache backend and adds support for cache
* contexts to it. The actual caching still happens in the original cache
* backend.
*
* @ingroup cache
*/
interface VariationCacheInterface {
/**
* Gets a cache entry based on cache keys.
*
* @param string[] $keys
* The cache keys to retrieve the cache entry for.
* @param \Drupal\Core\Cache\CacheableDependencyInterface $initial_cacheability
* The cache metadata of the data to store before other systems had a chance
* to adjust it. This is also commonly known as "pre-bubbling" cacheability.
*
* @return object|false
* The cache item or FALSE on failure.
*
* @see \Drupal\Core\Cache\CacheBackendInterface::get()
*/
public function get(array $keys, CacheableDependencyInterface $initial_cacheability);
/**
* Gets multiple cache entries based on a set of cache keys.
*
* @param array $items
* An associative array keyed by arbitrary identifiers. Each value is a set
* of arguments you would otherwise pass to ::get(). Example:
* @code
* $items = [
* 'item_a' => [['key1', 'key2'], $cacheability_a],
* 'item_b' => [['another_key'], $cacheability_b],
* ];
* @endcode
*
* @return array
* An associative array keyed by the same keys as $items, containing only
* the items found in the cache. Items that did not resolve are omitted.
*
* @see \Drupal\Core\Cache\VariationCacheInterface::get()
*/
public function getMultiple(array $items): array;
/**
* Stores data in the cache.
*
* @param string[] $keys
* The cache keys of the data to store.
* @param mixed $data
* The data to store in the cache.
* @param \Drupal\Core\Cache\CacheableDependencyInterface $cacheability
* The cache metadata of the data to store.
* @param \Drupal\Core\Cache\CacheableDependencyInterface $initial_cacheability
* The cache metadata of the data to store before other systems had a chance
* to adjust it. This is also commonly known as "pre-bubbling" cacheability.
*
* @see \Drupal\Core\Cache\CacheBackendInterface::set()
*
* @throws \LogicException
* Thrown when cacheability is provided that does not contain a cache
* context or does not completely contain the initial cacheability.
*/
public function set(array $keys, $data, CacheableDependencyInterface $cacheability, CacheableDependencyInterface $initial_cacheability): void;
/**
* Deletes an item from the cache.
*
* To stay consistent with ::get(), this only affects the active variation,
* not all possible variations for the associated cache contexts.
*
* @param string[] $keys
* The cache keys of the data to delete.
* @param \Drupal\Core\Cache\CacheableDependencyInterface $initial_cacheability
* The cache metadata of the data to store before other systems had a chance
* to adjust it. This is also commonly known as "pre-bubbling" cacheability.
*
* @see \Drupal\Core\Cache\CacheBackendInterface::delete()
*/
public function delete(array $keys, CacheableDependencyInterface $initial_cacheability): void;
/**
* Marks a cache item as invalid.
*
* To stay consistent with ::get(), this only affects the active variation,
* not all possible variations for the associated cache contexts.
*
* @param string[] $keys
* The cache keys of the data to invalidate.
* @param \Drupal\Core\Cache\CacheableDependencyInterface $initial_cacheability
* The cache metadata of the data to store before other systems had a chance
* to adjust it. This is also commonly known as "pre-bubbling" cacheability.
*
* @see \Drupal\Core\Cache\CacheBackendInterface::invalidate()
*/
public function invalidate(array $keys, CacheableDependencyInterface $initial_cacheability): void;
}
|
