aboutsummaryrefslogtreecommitdiffstats
path: root/lib/private/Cache/CappedMemoryCache.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/private/Cache/CappedMemoryCache.php')
-rw-r--r--lib/private/Cache/CappedMemoryCache.php64
1 files changed, 39 insertions, 25 deletions
diff --git a/lib/private/Cache/CappedMemoryCache.php b/lib/private/Cache/CappedMemoryCache.php
index 28e08759304..999ed8a7a74 100644
--- a/lib/private/Cache/CappedMemoryCache.php
+++ b/lib/private/Cache/CappedMemoryCache.php
@@ -1,25 +1,10 @@
<?php
+
/**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Robin Appelman <robin@icewind.nl>
- *
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License, version 3,
- * as published by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License, version 3,
- * along with this program. If not, see <http://www.gnu.org/licenses/>
- *
+ * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
*/
-
namespace OC\Cache;
use OCP\ICache;
@@ -28,30 +13,43 @@ use OCP\ICache;
* In-memory cache with a capacity limit to keep memory usage in check
*
* Uses a simple FIFO expiry mechanism
+ * @template T
+ * @deprecated 25.0.0 use OCP\Cache\CappedMemoryCache instead
*/
class CappedMemoryCache implements ICache, \ArrayAccess {
private $capacity;
+ /** @var T[] */
private $cache = [];
public function __construct($capacity = 512) {
$this->capacity = $capacity;
}
- public function hasKey($key) {
+ public function hasKey($key): bool {
return isset($this->cache[$key]);
}
+ /**
+ * @return ?T
+ */
public function get($key) {
- return isset($this->cache[$key]) ? $this->cache[$key] : null;
+ return $this->cache[$key] ?? null;
}
- public function set($key, $value, $ttl = 0) {
+ /**
+ * @param string $key
+ * @param T $value
+ * @param int $ttl
+ * @return bool
+ */
+ public function set($key, $value, $ttl = 0): bool {
if (is_null($key)) {
$this->cache[] = $value;
} else {
$this->cache[$key] = $value;
}
$this->garbageCollect();
+ return true;
}
public function remove($key) {
@@ -64,22 +62,34 @@ class CappedMemoryCache implements ICache, \ArrayAccess {
return true;
}
- public function offsetExists($offset) {
+ public function offsetExists($offset): bool {
return $this->hasKey($offset);
}
+ /**
+ * @return T
+ */
+ #[\ReturnTypeWillChange]
public function &offsetGet($offset) {
return $this->cache[$offset];
}
- public function offsetSet($offset, $value) {
+ /**
+ * @param string $offset
+ * @param T $value
+ * @return void
+ */
+ public function offsetSet($offset, $value): void {
$this->set($offset, $value);
}
- public function offsetUnset($offset) {
+ public function offsetUnset($offset): void {
$this->remove($offset);
}
+ /**
+ * @return T[]
+ */
public function getData() {
return $this->cache;
}
@@ -92,4 +102,8 @@ class CappedMemoryCache implements ICache, \ArrayAccess {
$this->remove($key);
}
}
+
+ public static function isAvailable(): bool {
+ return true;
+ }
}