ILockManager
extends
ILockProvider
in
Manage app integrations with files_lock with collaborative editors
The OCP parts are mainly for exposing the ability to lock/unlock for apps and to give the files_lock app a way to register and then be triggered by the apps while the actual locking implementation is kept in the LockProvider and DAV plugin from files_lock app.
Tags
Table of Contents
Methods
- getLockInScope() : LockContext|null
- getLocks() : array<string|int, mixed>
- isLockProviderAvailable() : bool
- lock() : ILock
- registerLockProvider() : void
- runInScope() : void
- Run within the scope of a given lock condition
- unlock() : void
Methods
getLockInScope()
public
getLockInScope() : LockContext|null
Tags
Return values
LockContext|nullgetLocks()
public
getLocks(int $fileId) : array<string|int, mixed>
Parameters
- $fileId : int
Tags
Return values
array<string|int, mixed>isLockProviderAvailable()
public
isLockProviderAvailable() : bool
Tags
Return values
boollock()
public
lock(LockContext $lockInfo) : ILock
Parameters
- $lockInfo : LockContext
Tags
Return values
ILockregisterLockProvider()
public
registerLockProvider(ILockProvider $lockProvider) : void
Parameters
- $lockProvider : ILockProvider
Tags
runInScope()
Run within the scope of a given lock condition
public
runInScope(LockContext $lock, callable $callback) : void
The callback will also be executed if no lock provider is present
Parameters
- $lock : LockContext
- $callback : callable
Tags
unlock()
public
unlock(LockContext $lockInfo) : void
Parameters
- $lockInfo : LockContext