Nextcloud PHP API (master)

ILockManager extends ILockProvider

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
since
24.0.0

Table of Contents

Methods

getLockInScope()  : LockContext|null
getLocks()  : array<string|int, mixed>
isLockProviderAvailable()  : bool
lock()  : ILock
registerLazyLockProvider()  : void
registerLockProvider()  : void
runInScope()  : void
Run within the scope of a given lock condition
unlock()  : void

Methods

isLockProviderAvailable()

public isLockProviderAvailable() : bool
Tags
since
24.0.0
Return values
bool

registerLazyLockProvider()

public registerLazyLockProvider(string $lockProviderClass) : void
Parameters
$lockProviderClass : string
Tags
since
30.0.0

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
since
24.0.0

        
On this page

Search results