Nextcloud PHP API (stable18)

ILockingProvider

Interface ILockingProvider

Tags
since
8.1.0

Table of Contents

LOCK_EXCLUSIVE  = 2
LOCK_SHARED  = 1
acquireLock()  : mixed
changeLock()  : mixed
Change the type of an existing lock
isLocked()  : bool
releaseAll()  : mixed
release all lock acquired by this instance
releaseLock()  : mixed

Constants

Methods

acquireLock()

public acquireLock(string $path, int $type) : mixed
Parameters
$path : string
$type : int

self::LOCK_SHARED or self::LOCK_EXCLUSIVE

Tags
throws
LockedException
since
8.1.0
Return values
mixed

changeLock()

Change the type of an existing lock

public changeLock(string $path, int $targetType) : mixed
Parameters
$path : string
$targetType : int

self::LOCK_SHARED or self::LOCK_EXCLUSIVE

Tags
throws
LockedException
since
8.1.0
Return values
mixed

isLocked()

public isLocked(string $path, int $type) : bool
Parameters
$path : string
$type : int

self::LOCK_SHARED or self::LOCK_EXCLUSIVE

Tags
since
8.1.0
Return values
bool

releaseAll()

release all lock acquired by this instance

public releaseAll() : mixed
Tags
since
8.1.0
Return values
mixed

releaseLock()

public releaseLock(string $path, int $type) : mixed
Parameters
$path : string
$type : int

self::LOCK_SHARED or self::LOCK_EXCLUSIVE

Tags
since
8.1.0
Return values
mixed

Search results