blob: f7a1b26a936b0372f8d37eb43a18bb575dbde9ce (
plain)
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
|
<?php
declare(strict_types=1);
namespace Doctrine\ORM\Cache;
use Doctrine\ORM\Cache\Exception\CacheException;
/**
* Defines a contract for accessing a particular named region.
*/
interface Region
{
/**
* Retrieve the name of this region.
*/
public function getName(): string;
/**
* Determine whether this region contains data for the given key.
*
* @param CacheKey $key The cache key
*/
public function contains(CacheKey $key): bool;
/**
* Get an item from the cache.
*
* @param CacheKey $key The key of the item to be retrieved.
*
* @return CacheEntry|null The cached entry or NULL
*
* @throws CacheException Indicates a problem accessing the item or region.
*/
public function get(CacheKey $key): CacheEntry|null;
/**
* Get all items from the cache identified by $keys.
* It returns NULL if some elements can not be found.
*
* @param CollectionCacheEntry $collection The collection of the items to be retrieved.
*
* @return CacheEntry[]|null The cached entries or NULL if one or more entries can not be found
*/
public function getMultiple(CollectionCacheEntry $collection): array|null;
/**
* Put an item into the cache.
*
* @param CacheKey $key The key under which to cache the item.
* @param CacheEntry $entry The entry to cache.
* @param Lock|null $lock The lock previously obtained.
*
* @throws CacheException Indicates a problem accessing the region.
*/
public function put(CacheKey $key, CacheEntry $entry, Lock|null $lock = null): bool;
/**
* Remove an item from the cache.
*
* @param CacheKey $key The key under which to cache the item.
*
* @throws CacheException Indicates a problem accessing the region.
*/
public function evict(CacheKey $key): bool;
/**
* Remove all contents of this particular cache region.
*
* @throws CacheException Indicates problem accessing the region.
*/
public function evictAll(): bool;
}
|
