diff options
Diffstat (limited to 'lib/public/Lock/ILockingProvider.php')
| -rw-r--r-- | lib/public/Lock/ILockingProvider.php | 61 |
1 files changed, 20 insertions, 41 deletions
diff --git a/lib/public/Lock/ILockingProvider.php b/lib/public/Lock/ILockingProvider.php index 3dc7c73b6eb..c92883a1377 100644 --- a/lib/public/Lock/ILockingProvider.php +++ b/lib/public/Lock/ILockingProvider.php @@ -1,34 +1,18 @@ <?php declare(strict_types=1); - /** - * @copyright Copyright (c) 2016, ownCloud, Inc. - * - * @author Christoph Wurst <christoph@winzerhof-wurst.at> - * @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 */ namespace OCP\Lock; /** - * Interface ILockingProvider + * This interface allows locking and unlocking filesystem paths + * + * This interface should be used directly and not implemented by an application. + * The implementation is provided by the server. * * @since 8.1.0 */ @@ -43,42 +27,37 @@ interface ILockingProvider { public const LOCK_EXCLUSIVE = 2; /** - * @param string $path - * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE - * @return bool + * @psalm-param self::LOCK_SHARED|self::LOCK_EXCLUSIVE $type * @since 8.1.0 */ public function isLocked(string $path, int $type): bool; /** - * @param string $path - * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE - * @param string $readablePath human readable path to use in error messages, since 20.0.0 - * @throws \OCP\Lock\LockedException + * @psalm-param self::LOCK_SHARED|self::LOCK_EXCLUSIVE $type + * @param ?string $readablePath A human-readable path to use in error messages, since 20.0.0 + * @throws LockedException * @since 8.1.0 */ - public function acquireLock(string $path, int $type, string $readablePath = null); + public function acquireLock(string $path, int $type, ?string $readablePath = null): void; /** - * @param string $path - * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE + * @psalm-param self::LOCK_SHARED|self::LOCK_EXCLUSIVE $type * @since 8.1.0 */ - public function releaseLock(string $path, int $type); + public function releaseLock(string $path, int $type): void; /** - * Change the type of an existing lock + * Change the target type of an existing lock * - * @param string $path - * @param int $targetType self::LOCK_SHARED or self::LOCK_EXCLUSIVE - * @throws \OCP\Lock\LockedException + * @psalm-param self::LOCK_SHARED|self::LOCK_EXCLUSIVE $targetType + * @throws LockedException * @since 8.1.0 */ - public function changeLock(string $path, int $targetType); + public function changeLock(string $path, int $targetType): void; /** - * release all lock acquired by this instance + * Release all lock acquired by this instance * @since 8.1.0 */ - public function releaseAll(); + public function releaseAll(): void; } |