simple-cache/src/CacheInterface.php at master · php-fig/simple-cache · GitHub

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
107
108
109
110
111
112
113
114
<?php

namespacePsr\SimpleCache;

interface CacheInterface
{
/**
 * Fetches a value from the cache.
 *
 * @param string $key The unique key of this item in the cache.
 * @param mixed $default Default value to return if the key does not exist.
 *
 * @return mixed The value of the item from the cache, or $default in case of cache miss.
 *
 * @throws \Psr\SimpleCache\InvalidArgumentException
 * MUST be thrown if the $key string is not a legal value.
 */
publicfunctionget(string$key, mixed$default = null): mixed;

/**
 * Persists data in the cache, uniquely referenced by a key with an optional expiration TTL time.
 *
 * @param string $key The key of the item to store.
 * @param mixed $value The value of the item to store, must be serializable.
 * @param null|int|\DateInterval $ttl Optional. The TTL value of this item. If no value is sent and
 * the driver supports TTL then the library may set a default value
 * for it or let the driver take care of that.
 *
 * @return bool True on success and false on failure.
 *
 * @throws \Psr\SimpleCache\InvalidArgumentException
 * MUST be thrown if the $key string is not a legal value.
 */
publicfunctionset(string$key, mixed$value, null|int|\DateInterval$ttl = null): bool;

/**
 * Delete an item from the cache by its unique key.
 *
 * @param string $key The unique cache key of the item to delete.
 *
 * @return bool True if the item was successfully removed. False if there was an error.
 *
 * @throws \Psr\SimpleCache\InvalidArgumentException
 * MUST be thrown if the $key string is not a legal value.
 */
publicfunctiondelete(string$key): bool;

/**
 * Wipes clean the entire cache's keys.
 *
 * @return bool True on success and false on failure.
 */
publicfunctionclear(): bool;

/**
 * Obtains multiple cache items by their unique keys.
 *
 * @param iterable<string> $keys A list of keys that can be obtained in a single operation.
 * @param mixed $default Default value to return for keys that do not exist.
 *
 * @return iterable<string, mixed> A list of key => value pairs. Cache keys that do not exist or are stale will have $default as value.
 *
 * @throws \Psr\SimpleCache\InvalidArgumentException
 * MUST be thrown if $keys is neither an array nor a Traversable,
 * or if any of the $keys are not a legal value.
 */
publicfunctiongetMultiple(iterable$keys, mixed$default = null): iterable;

/**
 * Persists a set of key => value pairs in the cache, with an optional TTL.
 *
 * @param iterable $values A list of key => value pairs for a multiple-set operation.
 * @param null|int|\DateInterval $ttl Optional. The TTL value of this item. If no value is sent and
 * the driver supports TTL then the library may set a default value
 * for it or let the driver take care of that.
 *
 * @return bool True on success and false on failure.
 *
 * @throws \Psr\SimpleCache\InvalidArgumentException
 * MUST be thrown if $values is neither an array nor a Traversable,
 * or if any of the $values are not a legal value.
 */
publicfunctionsetMultiple(iterable$values, null|int|\DateInterval$ttl = null): bool;

/**
 * Deletes multiple cache items in a single operation.
 *
 * @param iterable<string> $keys A list of string-based keys to be deleted.
 *
 * @return bool True if the items were successfully removed. False if there was an error.
 *
 * @throws \Psr\SimpleCache\InvalidArgumentException
 * MUST be thrown if $keys is neither an array nor a Traversable,
 * or if any of the $keys are not a legal value.
 */
publicfunctiondeleteMultiple(iterable$keys): bool;

/**
 * Determines whether an item is present in the cache.
 *
 * NOTE: It is recommended that has() is only to be used for cache warming type purposes
 * and not to be used within your live applications operations for get/set, as this method
 * is subject to a race condition where your has() will return true and immediately after,
 * another script can remove it making the state of your app out of date.
 *
 * @param string $key The cache item key.
 *
 * @return bool
 *
 * @throws \Psr\SimpleCache\InvalidArgumentException
 * MUST be thrown if the $key string is not a legal value.
 */
publicfunctionhas(string$key): bool;
}