Public Member Functions

__construct (array $config)

Construct a new instance from configuration.

lockByType (array $pathsByType, $timeout=0)

Lock the resources at the given abstract paths.

Parameters

array	$pathsByType	Map of LockManager::LOCK_* constants to lists of paths
int	$timeout	Timeout in seconds (0 means non-blocking) (since 1.21)

Public Member Functions inherited from Wikimedia\LockManager\LockManager

lock (array $paths, $type=self::LOCK_EX, $timeout=0)

Lock the resources at the given abstract paths.

lockKey (string $key, int $timeout=0)

Provide a mutex of the key.

Parameters

string	$key	Key to lock (relative to a domain, usually represented by the wiki ID, which callers don't need to specify)
int	$timeout	Time to wait in seconds

scopedLock (string $key, int $timeout=0)

Lock a key and unlock it automatically when the object is destructed.

Parameters

string	$key
int	$timeout

Returns: ScopedCallback|null returns null when we failed to acquire the lock

unlock (array $paths, $type=self::LOCK_EX)

Unlock the resources at the given abstract paths.

unlockByType (array $pathsByType)

Unlock the resources at the given abstract paths.

unlockKey (string $key)

Parameters

string $key Key to unlock (relative to a domain, usually represented by the wiki ID, which callers don't need to specify)

Protected Member Functions

doLockByType (array $pathsByType)

Since we are overriding ::lockByType, this should never be reached.

doUnlockByType (array $pathsByType)

Release a set of locks.

Parameters

array $pathsByType Map of LockManager::LOCK_* constants to lists of paths

Protected Member Functions inherited from Wikimedia\LockManager\LockManager

normalizePathsByType (array $pathsByType)

Normalize the $paths array by converting LOCK_UW locks into the appropriate type and removing any duplicated paths for each lock type.

sha1Base36Absolute ( $path)

Get the base 36 SHA-1 of a string, padded to 31 digits.

Additional Inherited Members
Public Attributes inherited from Wikimedia\LockManager\LockManager
const	LOCK_EX = 3

const	LOCK_SH = 1
	Lock types; stronger locks have higher values.

const	LOCK_UW = 2

Protected Attributes inherited from Wikimedia\LockManager\LockManager
string	$domain
	domain (usually wiki ID)

array	$locksHeld = []
	Map of (resource path => lock type => count)

int	$lockTTL
	maximum time locks can be held

array	$lockTypeMap
	Mapping of lock types to the type actually used.

LoggerInterface	$logger

string	$session
	Random 32-char hex number.

const	MAX_LOCK_TTL = 2 * 3600
	Max expected lock expiry in any context.

const	MIN_LOCK_TTL = 5
	Minimum lock TTL.