ScopedLock Class Reference

Self-releasing locks. More...

Collaboration diagram for ScopedLock:

Public Member Functions
	__destruct ()
	Release the locks when this goes out of scope.

Static Public Member Functions
static	factory (LockManager $manager, array $paths, $type, StatusValue $status, $timeout=0)
	Get a ScopedLock object representing a lock on resource paths.
static	release (ScopedLock &$lock=null)
	Release a scoped lock and set any errors in the attached StatusValue object.

Protected Member Functions
	__construct (LockManager $manager, array $pathsByType, StatusValue $status)

Protected Attributes
LockManager	$manager
array	$pathsByType
	Map of lock types to resource paths.
StatusValue	$status

Detailed Description

Self-releasing locks.

Helper for consumers of LockManager, to create locks that automatically release when an object is destroyed or goes out of scope.

Since

1.19

Definition at line 30 of file ScopedLock.php.

Constructor & Destructor Documentation

__construct()

ScopedLock::__construct ( LockManager $manager, array $pathsByType, StatusValue $status )

protected

Parameters

LockManager	$manager
array	$pathsByType	Map of lock types to path lists
StatusValue	$status

Definition at line 43 of file ScopedLock.php.

References $manager, $pathsByType, and $status.

__destruct()

ScopedLock::__destruct

(

)

Release the locks when this goes out of scope.

Definition at line 93 of file ScopedLock.php.

Member Function Documentation

factory()

static ScopedLock::factory ( LockManager $manager, array $paths, $type, StatusValue $status, $timeout = 0 )

static

Get a ScopedLock object representing a lock on resource paths.

Any locks are released once this object goes out of scope. The StatusValue object is updated with any errors or warnings.

Parameters

LockManager	$manager
array	$paths	List of storage paths or map of lock types to path lists
int | string	$type	LockManager::LOCK_* constant or "mixed" and $paths can be a map of types to paths (since 1.22). Otherwise $type should be an integer and $paths should be a list of paths.
StatusValue	$status
int	$timeout	Timeout in seconds (0 means non-blocking) (since 1.22)

Returns

ScopedLock|null Returns null on failure

Definition at line 65 of file ScopedLock.php.

References $manager, $pathsByType, $status, LockManager\lockByType(), and StatusValue\merge().

Referenced by FileBackend\getScopedFileLocks().

release()

static ScopedLock::release ( ScopedLock & $lock = null )

static

Release a scoped lock and set any errors in the attached StatusValue object.

This is useful for early release of locks before function scope is destroyed. This is the same as setting the lock object to null.

Parameters

ScopedLock | null

&$lock

Since

1.21

Definition at line 86 of file ScopedLock.php.

Member Data Documentation

$manager

LockManager ScopedLock::$manager

protected

Definition at line 32 of file ScopedLock.php.

Referenced by __construct(), and factory().

$pathsByType

array ScopedLock::$pathsByType

protected

Map of lock types to resource paths.

Definition at line 36 of file ScopedLock.php.

Referenced by __construct(), and factory().

$status

StatusValue ScopedLock::$status

protected

Definition at line 34 of file ScopedLock.php.

Referenced by __construct(), and factory().

---

The documentation for this class was generated from the following file:

• includes/libs/lockmanager/ScopedLock.php