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
|
<?php
/**
* SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
* SPDX-License-Identifier: AGPL-3.0-only
*/
// use OCP namespace for all classes that are considered public.
// This means that they should be used by apps instead of the internal Nextcloud classes
namespace OCP;
/**
* This interface defines method for accessing the file based user cache.
*
* @since 8.1.0
*/
interface IMemcache extends ICache {
/**
* Set a value in the cache if it's not already stored
*
* @param string $key
* @param mixed $value
* @param int $ttl Time To Live in seconds. Defaults to 60*60*24
* @return bool
* @since 8.1.0
*/
public function add($key, $value, $ttl = 0);
/**
* Increase a stored number
*
* If no value is stored with the key, it will behave as if a 0 was stored.
* If a non-numeric value is stored, the operation will fail and `false` is returned.
*
* @param string $key
* @param int $step
* @return int | bool
* @since 8.1.0
*/
public function inc($key, $step = 1);
/**
* Decrease a stored number
*
* If no value is stored with the key, the operation will fail and `false` is returned.
* If a non-numeric value is stored, the operation will fail and `false` is returned.
*
* @param string $key
* @param int $step
* @return int | bool
* @since 8.1.0
*/
public function dec($key, $step = 1);
/**
* Compare and set
*
* Set $key to $new only if it's current value is $new
*
* @param string $key
* @param mixed $old
* @param mixed $new
* @return bool true if the value was successfully set or false if $key wasn't set to $old
* @since 8.1.0
*/
public function cas($key, $old, $new);
/**
* Compare and delete
*
* Delete $key if the stored value is equal to $old
*
* @param string $key
* @param mixed $old
* @return bool true if the value was successfully deleted or false if $key wasn't set to $old
* @since 8.1.0
*/
public function cad($key, $old);
/**
* Negative compare and delete
*
* Delete $key if the stored value is not equal to $old
*
* @param string $key
* @param mixed $old
* @return bool true if the value was successfully deleted or false if $key was set to $old or is not set
* @since 30.0.0
*/
public function ncad(string $key, mixed $old): bool;
}
|
