3 * @copyright Copyright (C) 2010-2022, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Core\Cache\Capability;
24 use Friendica\Core\Cache\Enum\Duration;
25 use Friendica\Core\Cache\Exception\CachePersistenceException;
28 * This interface defines methods for Memory-Caches only
30 interface ICanCacheInMemory extends ICanCache
33 * Sets a value if it's not already stored
35 * @param string $key The cache key
36 * @param mixed $value The old value we know from the cache
37 * @param int $ttl The cache lifespan, must be one of the Cache constants
41 * @throws CachePersistenceException In case the underlying cache driver has errors during persistence
43 public function add(string $key, $value, int $ttl = Duration::FIVE_MINUTES): bool;
46 * Compares if the old value is set and sets the new value
48 * @param string $key The cache key
49 * @param mixed $oldValue The old value we know from the cache
50 * @param mixed $newValue The new value we want to set
51 * @param int $ttl The cache lifespan, must be one of the Cache constants
55 * @throws CachePersistenceException In case the underlying cache driver has errors during persistence
57 public function compareSet(string $key, $oldValue, $newValue, int $ttl = Duration::FIVE_MINUTES): bool;
60 * Compares if the old value is set and removes it
62 * @param string $key The cache key
63 * @param mixed $value The old value we know and want to delete
67 * @throws CachePersistenceException In case the underlying cache driver has errors during persistence
69 public function compareDelete(string $key, $value): bool;