MediaWiki  REL1_20
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
ScopedLock Class Reference
Lock management

Self-releasing locks. More...

Collaboration diagram for ScopedLock:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 __destruct ()

Static Public Member Functions

static factory (LockManager $manager, array $paths, $type, Status $status)
 Get a ScopedLock object representing a lock on resource paths.

Protected Member Functions

 __construct (LockManager $manager, array $paths, $type, Status $status)

Protected Attributes

LockManager $manager
 *
Array $paths
 List of resource paths*.
Status $status
 *
 $type

Detailed Description

Self-releasing locks.

LockManager helper class to handle scoped locks, which release when an object is destroyed or goes out of scope.

Since:
1.19

Definition at line 132 of file LockManager.php.

Constructor & Destructor Documentation

ScopedLock::__construct ( LockManager $  manager,
array $  paths,
$  type,
Status $  status 
) [protected]
Parameters:
$managerLockManager
$pathsArray List of storage paths
$typeinteger LockManager::LOCK_* constant
$statusStatus

Definition at line 145 of file LockManager.php.

ScopedLock::__destruct ( )

Definition at line 176 of file LockManager.php.

Member Function Documentation

static ScopedLock::factory ( LockManager $  manager,
array $  paths,
$  type,
Status $  status 
) [static]

Get a ScopedLock object representing a lock on resource paths.

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

Parameters:
$managerLockManager
$pathsArray List of storage paths
$typeinteger LockManager::LOCK_* constant
$statusStatus
Returns:
ScopedLock|null Returns null on failure

Definition at line 165 of file LockManager.php.

Member Data Documentation

LockManager ScopedLock::$manager [protected]

*

Definition at line 133 of file LockManager.php.

Array ScopedLock::$paths [protected]

List of resource paths*.

Definition at line 135 of file LockManager.php.

Status ScopedLock::$status [protected]

*

Definition at line 134 of file LockManager.php.

ScopedLock::$type [protected]

Definition at line 137 of file LockManager.php.

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