1
0

ILockManager.php 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2022 Julius Härtl <jus@bitgrid.net>
  5. *
  6. * @author Julius Härtl <jus@bitgrid.net>
  7. *
  8. * @license GNU AGPL version 3 or any later version
  9. *
  10. * This program is free software: you can redistribute it and/or modify
  11. * it under the terms of the GNU Affero General Public License as
  12. * published by the Free Software Foundation, either version 3 of the
  13. * License, or (at your option) any later version.
  14. *
  15. * This program is distributed in the hope that it will be useful,
  16. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18. * GNU Affero General Public License for more details.
  19. *
  20. * You should have received a copy of the GNU Affero General Public License
  21. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  22. *
  23. */
  24. namespace OCP\Files\Lock;
  25. use OCP\PreConditionNotMetException;
  26. /**
  27. * Manage app integrations with files_lock with collaborative editors
  28. *
  29. * The OCP parts are mainly for exposing the ability to lock/unlock for apps and
  30. * to give the files_lock app a way to register and then be triggered by the apps
  31. * while the actual locking implementation is kept in the LockProvider and DAV
  32. * plugin from files_lock app.
  33. *
  34. * @since 24.0.0
  35. */
  36. interface ILockManager extends ILockProvider {
  37. /**
  38. * @throws PreConditionNotMetException if there is already a lock provider registered
  39. * @since 24.0.0
  40. */
  41. public function registerLockProvider(ILockProvider $lockProvider): void;
  42. /**
  43. * @return bool
  44. * @since 24.0.0
  45. */
  46. public function isLockProviderAvailable(): bool;
  47. /**
  48. * Run within the scope of a given lock condition
  49. *
  50. * The callback will also be executed if no lock provider is present
  51. *
  52. * @since 24.0.0
  53. */
  54. public function runInScope(LockContext $lock, callable $callback): void;
  55. /**
  56. * @throws NoLockProviderException if there is no lock provider available
  57. * @since 24.0.0
  58. */
  59. public function getLockInScope(): ?LockContext;
  60. }