diff options
Diffstat (limited to 'lib/public/IMemcache.php')
| -rw-r--r-- | lib/public/IMemcache.php | 52 |
1 files changed, 29 insertions, 23 deletions
diff --git a/lib/public/IMemcache.php b/lib/public/IMemcache.php index 9add524cb3e..991af1a8d4f 100644 --- a/lib/public/IMemcache.php +++ b/lib/public/IMemcache.php @@ -1,28 +1,12 @@ <?php + /** - * @copyright Copyright (c) 2016, ownCloud, Inc. - * - * @author Morris Jobke <hey@morrisjobke.de> - * @author Robin Appelman <robin@icewind.nl> - * @author Roeland Jago Douma <roeland@famdouma.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 */ // use OCP namespace for all classes that are considered public. -// This means that they should be used by apps instead of the internal ownCloud classes +// This means that they should be used by apps instead of the internal Nextcloud classes namespace OCP; @@ -46,6 +30,9 @@ interface IMemcache extends ICache { /** * 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 @@ -56,6 +43,9 @@ interface IMemcache extends ICache { /** * 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 @@ -66,10 +56,12 @@ interface IMemcache extends ICache { /** * 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 + * @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); @@ -77,10 +69,24 @@ interface IMemcache extends ICache { /** * Compare and delete * + * Delete $key if the stored value is equal to $old + * * @param string $key * @param mixed $old - * @return bool + * @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; } |